Node-http-proxy全功能的Node.js Http代理

问说网 · 发布于 2016-03-15 · 字数13949 · 浏览 3011 · 评论 0

Node-http-proxy是一个HTTP代理支持WebSocket编程库。它适用于执行元件如反向代理服务器和负载均衡,拥有普通代理的全部功能,专为Node.js设置制作。

e67

安装

npm install http-proxy --save

核心概念

A new proxy is created by calling createProxyServer and passing an options object as argument (valid properties are available here)

var httpProxy = require('http-proxy');
var proxy = httpProxy.createProxyServer(options); // See (†)

†Unless listen(..) is invoked on the object, this does not create a webserver. See below.

An object will be returned with four values:

  • web req, res, [options] (used for proxying regular HTTP(S) requests)
  • ws req, socket, head, [options] (used for proxying WS(S) requests)
  • listen port (a function that wraps the object in a webserver, for your convenience)
  • close [callback] (a function that closes the inner webserver and stops listening on given port)

It is then possible to proxy requests by calling these functions

http.createServer(function(req, res) {
  proxy.web(req, res, { target: 'http://mytarget.com:8080' });
});

Errors can be listened on either using the Event Emitter API

proxy.on('error', function(e) {
  ...
});

or using the callback API

proxy.web(req, res, { target: 'http://mytarget.com:8080' }, function(e) { ... });

When a request is proxied it follows two different pipelines (available here) which apply transformations to both the req and res object. The first pipeline (ingoing) is responsible for the creation and manipulation of the stream that connects your client to the target. The second pipeline (outgoing) is responsible for the creation and manipulation of the stream that, from your target, returns data to the client.

使用举例

设置基本的独立代理服务器

var http = require('http'),
    httpProxy = require('http-proxy');
//
// Create your proxy server and set the target in the options.
//
httpProxy.createProxyServer({target:'http://localhost:9000'}).listen(8000); // See (†)

//
// Create your target server
//
http.createServer(function (req, res) {
  res.writeHead(200, { 'Content-Type': 'text/plain' });
  res.write('request successfully proxied!' + '\n' + JSON.stringify(req.headers, true, 2));
  res.end();
}).listen(9000);

†Invoking listen(..) triggers the creation of a web server. Otherwise, just the proxy instance is created.

设置自定义的独立代理服务器

This example show how you can proxy a request using your own HTTP server and also you can put your own logic to handle the request.

var http = require('http'),
    httpProxy = require('http-proxy');

//
// Create a proxy server with custom application logic
//
var proxy = httpProxy.createProxyServer({});

//
// Create your custom server and just call `proxy.web()` to proxy
// a web request to the target passed in the options
// also you can use `proxy.ws()` to proxy a websockets request
//
var server = http.createServer(function(req, res) {
  // You can define here your custom logic to handle the request
  // and then proxy the request.
  proxy.web(req, res, { target: 'http://127.0.0.1:5060' });
});

console.log("listening on port 5050")
server.listen(5050);

设置代理请求标头重新编写独立的代理服务器

This example shows how you can proxy a request using your own HTTP server that modifies the outgoing proxy request by adding a special header.

var http = require('http'),
    httpProxy = require('http-proxy');

//
// Create a proxy server with custom application logic
//
var proxy = httpProxy.createProxyServer({});

// To modify the proxy connection before data is sent, you can listen
// for the 'proxyReq' event. When the event is fired, you will receive
// the following arguments:
// (http.ClientRequest proxyReq, http.IncomingMessage req,
//  http.ServerResponse res, Object options). This mechanism is useful when
// you need to modify the proxy request before the proxy connection
// is made to the target.
//
proxy.on('proxyReq', function(proxyReq, req, res, options) {
  proxyReq.setHeader('X-Special-Proxy-Header', 'foobar');
});

var server = http.createServer(function(req, res) {
  // You can define here your custom logic to handle the request
  // and then proxy the request.
  proxy.web(req, res, {
    target: 'http://127.0.0.1:5060'
  });
});

console.log("listening on port 5050")
server.listen(5050);

从代理服务器中修改响应内容

Sometimes when you have received a HTML/XML document from the server of origin you would like to modify it before forwarding it on.

Harmon allows you to do this in a streaming style so as to keep the pressure on the proxy to a minimum.

设置独立的代理服务器延迟

var http = require('http'),
    httpProxy = require('http-proxy');

//
// Create a proxy server with latency
//
var proxy = httpProxy.createProxyServer();

//
// Create your server that makes an operation that waits a while
// and then proxies the request
//
http.createServer(function (req, res) {
  // This simulates an operation that takes 500ms to execute
  setTimeout(function () {
    proxy.web(req, res, {
      target: 'http://localhost:9008'
    });
  }, 500);
}).listen(8008);

//
// Create your target server
//
http.createServer(function (req, res) {
  res.writeHead(200, { 'Content-Type': 'text/plain' });
  res.write('request successfully proxied to: ' + req.url + '\n' + JSON.stringify(req.headers, true, 2));
  res.end();
}).listen(9008);

使用 HTTPS

You can activate the validation of a secure SSL certificate to the target connection (avoid self signed certs), just set secure: true in the options.

HTTPS -> HTTP

//
// Create the HTTPS proxy server in front of a HTTP server
//
httpProxy.createServer({
  target: {
    host: 'localhost',
    port: 9009
  },
  ssl: {
    key: fs.readFileSync('valid-ssl-key.pem', 'utf8'),
    cert: fs.readFileSync('valid-ssl-cert.pem', 'utf8')
  }
}).listen(8009);

HTTPS -> HTTPS

//
// Create the proxy server listening on port 443
//
httpProxy.createServer({
  ssl: {
    key: fs.readFileSync('valid-ssl-key.pem', 'utf8'),
    cert: fs.readFileSync('valid-ssl-cert.pem', 'utf8')
  },
  target: 'https://localhost:9010',
  secure: true // Depends on your needs, could be false.
}).listen(443);

代理 WebSockets

You can activate the websocket support for the proxy using ws:true in the options.

//
// Create a proxy server for websockets
//
httpProxy.createServer({
  target: 'ws://localhost:9014',
  ws: true
}).listen(8014);

Also you can proxy the websocket requests just calling the ws(req, socket, head) method.

//
// Setup our server to proxy standard HTTP requests
//
var proxy = new httpProxy.createProxyServer({
  target: {
    host: 'localhost',
    port: 9015
  }
});
var proxyServer = http.createServer(function (req, res) {
  proxy.web(req, res);
});

//
// Listen to the `upgrade` event and proxy the
// WebSocket requests as well.
//
proxyServer.on('upgrade', function (req, socket, head) {
  proxy.ws(req, socket, head);
});

proxyServer.listen(8015);

可选参数

httpProxy.createProxyServer supports the following options:

  • target: url string to be parsed with the url module
  • forward: url string to be parsed with the url module
  • agent: object to be passed to http(s).request (see Node’s https agent and http agent objects)
  • ssl: object to be passed to https.createServer()
  • ws: true/false, if you want to proxy websockets
  • xfwd: true/false, adds x-forward headers
  • secure: true/false, if you want to verify the SSL Certs
  • toProxy: passes the absolute URL as the path (useful for proxying to proxies)
  • prependPath: true/false, Default: true – specify whether you want to prepend the target’s path to the proxy path
  • ignorePath: true/false, Default: false – specify whether you want to ignore the proxy path of the incoming request (note: you will have to append / manually if required).
  • localAddress: Local interface string to bind for outgoing connections
  • changeOrigin: true/false, Default: false – changes the origin of the host header to the target URL
  • auth: Basic authentication i.e. ‘user:password’ to compute an Authorization header.
  • hostRewrite: rewrites the location hostname on (301/302/307/308) redirects.
  • autoRewrite: rewrites the location host/port on (301/302/307/308) redirects based on requested host/port. Default: false.
  • protocolRewrite: rewrites the location protocol on (301/302/307/308) redirects to ‘http’ or ‘https’. Default: null.
  • headers: object with extra headers to be added to target requests.

NOTE: options.ws and options.ssl are optional. options.target and options.forward cannot both be missing

If you are using the proxyServer.listen method, the following options are also applicable:

  • ssl: object to be passed to https.createServer()
  • ws: true/false, if you want to proxy websockets

监听代理事件

  • error: The error event is emitted if the request to the target fail. We do not do any error handling of messages passed between client and proxy, and messages passed between proxy and target, so it is recommended that you listen on errors and handle them.
  • proxyReq: This event is emitted before the data is sent. It gives you a chance to alter the proxyReq request object. Applies to “web” connections
  • proxyReqWs: This event is emitted before the data is sent. It gives you a chance to alter the proxyReq request object. Applies to “websocket” connections
  • proxyRes: This event is emitted if the request to the target got a response.
  • open: This event is emitted once the proxy websocket was created and piped into the target websocket.
  • close: This event is emitted once the proxy websocket was closed.
  • (DEPRECATED) proxySocket: Deprecated in favor of open.
var httpProxy = require('http-proxy');
// Error example
//
// Http Proxy Server with bad target
//
var proxy = httpProxy.createServer({
  target:'http://localhost:9005'
});

proxy.listen(8005);

//
// Listen for the `error` event on `proxy`.
proxy.on('error', function (err, req, res) {
  res.writeHead(500, {
    'Content-Type': 'text/plain'
  });

  res.end('Something went wrong. And we are reporting a custom error message.');
});

//
// Listen for the `proxyRes` event on `proxy`.
//
proxy.on('proxyRes', function (proxyRes, req, res) {
  console.log('RAW Response from the target', JSON.stringify(proxyRes.headers, true, 2));
});

//
// Listen for the `open` event on `proxy`.
//
proxy.on('open', function (proxySocket) {
  // listen for messages coming FROM the target here
  proxySocket.on('data', hybiParseAndLogMessage);
});

//
// Listen for the `close` event on `proxy`.
//
proxy.on('close', function (res, socket, head) {
  // view disconnected websocket connections
  console.log('Client disconnected');
});

关闭代理

  • When testing or running server within another program it may be necessary to close the proxy.
  • This will stop the proxy from accepting new connections.
var proxy = new httpProxy.createProxyServer({
  target: {
    host: 'localhost',
    port: 1337
  }
});

proxy.close();

相关链接

本文系作者 问说网 授权问说网发表,并经问说网编辑,转载请注明出处和 本文链接

相关文章

  • 2015-08-14说说网页开发中使用的那些字体图标
  • 2016-03-17手机归属地查询大集合
  • 2016-05-09Screw轻量级的无限滚动jQuery插件
  • 2016-05-14实用不枯燥!4个方法帮你成为创意高产达人
  • 2016-05-16设计新技能!爱不释手的模糊背景设计
  • 2016-05-17哑铃的图标制作教程
  • 2016-06-06JavaScript中使用ID获取节点的思考
  • 2016-07-01ScrollPagination基于jQuery无限滚动加载插件
  • 发布评论

    为您推荐

    问说网 · 发布于 2014-10-23

    带点点文件夹的那些事儿

    刚使用电脑那会儿,由于不懂电脑知识,经常中毒,那时候杀毒软件还没有现在这么牛逼,一个病毒老是弄不干净,其中都有一个很明显的特征,就是磁盘里面多了很多隐藏的带点的…

    问说网 · 发布于 2016-02-01

    Pinyin.js将汉字转拼音JavaScript插件

    Pinyin.js是一个使用JavaScript将汉字转换为拼音的插件,为了方便前端的排序。并且支持多音字。同样也支持转为带声调的拼音。这个版本同时支持在 No…

    C语言的设计模式之依赖倒置
    问说网 · 发布于 2016-03-18

    C语言的设计模式之依赖倒置

    依赖倒置:就是要依赖于抽象,不要依赖于具体。简单的说就是要求对抽象进行编程,不要对实现进行编程,这样就降低了客户与实现模块间的耦合。

    问说网 · 发布于 2016-03-26

    MySQL按照汉字拼音首字母和英文首字母查询

    有时候我们需要严格的排序和检索数据,比如MySQL按照汉字拼音首字母和英文首字母查询,英文可以使用 like "A%" 模糊查询,而中文的汉语拼音就比较复杂一点…

    问说网 · 发布于 2016-04-21

    EJS嵌入式轻量级JavaScript模版引擎

    "E" 是 "effective" 的缩写,EJS是一个嵌入式轻量级JavaScript模版引擎,让您通过简单易懂的JavaScript代码生成HTML标签,没…

    CasperJS开源的导航脚本处理和测试工具
    问说网 · 发布于 2016-05-09

    CasperJS开源的导航脚本处理和测试工具

    CasperJS 是一个开源的导航脚本和测试工具,使用 JavaScript 基于 PhantomJS 编写,用于测试 Web 应用功能,Phantom JS是…

    你真的好色吗?揭秘设计背后的色彩与情绪

    我个人认为设计很多时候是基于设计师自己的情绪和感觉的。但是不管怎样,当你在设计中开始问自己“用户对这个项目会有怎样的看法,会是你想要的效果吗?”之类问题的时候,…

    • 你真的好色吗?揭秘设计背后的色彩与情绪
    • 你真的好色吗?揭秘设计背后的色彩与情绪
    • 你真的好色吗?揭秘设计背后的色彩与情绪
    • 你真的好色吗?揭秘设计背后的色彩与情绪
    GissingPolly · 发布于 2016-05-16 · 浏览 1301 · 评论 0
    通过HOOK自动设置WordPress文章特色图像
    问说网 · 发布于 2016-07-06

    通过HOOK自动设置WordPress文章特色图像

    你是否还在为WordPress设置特色图片而烦恼,特色图片也就是缩略图,文章的缩略图能够让我们的文章列表更加的优美,但是有时候我们可能就忘记了设置,不过我们可以…

    问说网手机版

    躺着 站着 跪着轻松访问

    更多详情 关于作者

    问说网

    问说网分享与设计有关的文章素材界面和作品,提供设计教程、素材分享、界面欣赏、编程设计、设计书籍、设计师导航等内容,你可以在这里阅读、学习、分享、交流。

    13177 文章
    495 评论
    2153 人气

    更多 热门话题

    APP界面

    关注 APP界面

    文章 41506 · 浏览 4345

    APP欣赏

    关注 APP欣赏

    文章 41427 · 浏览 4531

    APP手机界面

    关注 APP手机界面

    文章 41417 · 浏览 4491

    图片素材

    关注 图片素材

    文章 29463 · 浏览 3568

    高清图片

    关注 高清图片

    文章 26530 · 浏览 3816

    更多 推荐作者

    关注 秋天的孤寂

    文章 99 · 评论 0

    关注 惢碎葬爱

    文章 96 · 评论 0

    关注 倾听寂寞

    文章 83 · 评论 0

    关注 溫柔的溫柔

    文章 91 · 评论 0

    关注 走了留下什么

    文章 110 · 评论 0

    关注 莪很迷茫

    文章 97 · 评论 0

    
    顶部 反馈 评论 底部

    意见反馈

    感谢您对问说网的支持,提出您在使用过程中遇到的问题或宝贵建议,您的反馈对我们产品的完善有很大帮助。

    您的反馈我们已收到!

    感谢您提供的宝贵意见,我们会在1-2个工作日,通过您留下的联系方式将处理结果反馈给您!