express-http-proxy、http-proxy、http-proxy-middleware は、Node.js アプリケーション内で HTTP リクエストを別のサーバーに転送(プロキシ)するためのライブラリです。これらは、開発サーバーでの API フォワーディング、マイクロサービス間の通信、またはレガシーシステムのラッピングなど、様々なアーキテクチャで不可欠な役割を果たします。http-proxy は低レベルなコアライブラリとしてスタンドアロンで動作し、http-proxy-middleware はこれを Express や Connect 向けにラップしたミドルウェアです。一方、express-http-proxy は Express 専用に設計された別のアプローチを提供しますが、メンテナンス状況に注意が必要です。
Node.js でバックエンドサービスへのリクエストを転送する際、http-proxy、http-proxy-middleware、express-http-proxy の 3 つが主要な選択肢となります。これらは似ていますが、アーキテクチャ、統合のしやすさ、そしてメンテナンス状況に明確な違いがあります。実務的な観点から、これらを深く比較します。
http-proxy は、これらの中で最も低レベルなコアライブラリです。
// http-proxy: スタンドアロンサーバー
const httpProxy = require('http-proxy');
const proxy = httpProxy.createProxyServer({});
const server = require('http').createServer((req, res) => {
proxy.web(req, res, { target: 'http://localhost:3000' });
});
server.listen(8080);
http-proxy-middleware は、http-proxy を Express 向けにラップしたものです。
app.use() でそのまま利用可能です。// http-proxy-middleware: Express ミドルウェア
const { createProxyMiddleware } = require('http-proxy-middleware');
app.use('/api', createProxyMiddleware({
target: 'http://localhost:3000',
changeOrigin: true
}));
express-http-proxy は、Express 専用に設計された別のミドルウェアです。
http-proxy ライブラリに依存せず、独自の実装を持っています。req オブジェクトを直接操作する設計になっています。// express-http-proxy: Express 専用ミドルウェア
const proxy = require('express-http-proxy');
app.use('/api', proxy('http://localhost:3000', {
preserveHostHdr: true
}));
プロキシ処理中にヘッダーやボディを改変する必要がある場合、各ライブラリでアプローチが異なります。
http-proxy では、イベントリスナーを使って低レベルで制御します。
proxyReq イベントを使ってヘッダーを追加できます。// http-proxy: イベントベースの操作
proxy.on('proxyReq', (proxyReq, req, res) => {
proxyReq.setHeader('X-Custom-Header', 'value');
});
http-proxy-middleware は、設定オプション内で関数を定義できます。
onProxyReq コールバックを使って、http-proxy のイベントを簡単に扱えます。// http-proxy-middleware: コールバック設定
createProxyMiddleware({
target: 'http://localhost:3000',
onProxyReq: (proxyReq, req, res) => {
proxyReq.setHeader('X-Custom-Header', 'value');
}
});
express-http-proxy は、Express のミドルウェアチェーンのように処理します。
proxyReqOptDecorator 関数でオプションを操作します。// express-http-proxy: デコレーター関数
proxy('http://localhost:3000', {
proxyReqOptDecorator: (proxyReqOpts, srcReq) => {
proxyReqOpts.headers['X-Custom-Header'] = 'value';
return proxyReqOpts;
}
});
リアルタイム通信が必要な場合、WebSocket のプロキシ対応が重要になります。
http-proxy は、WebSocket アップグレードをネイティブにサポートしています。
proxy.ws() メソッドで明示的に処理します。// http-proxy: WebSocket 処理
const wsServer = new WebSocket.Server({ server });
wsServer.on('connection', (ws) => {
proxy.ws(req, ws, { target: 'ws://localhost:3000' });
});
http-proxy-middleware は、WebSocket サポートをオプションで有効化できます。
ws: true を設定するだけで、自動で処理してくれます。// http-proxy-middleware: 設定で有効化
createProxyMiddleware({
target: 'http://localhost:3000',
ws: true // これだけで WebSocket プロキシ対応
});
express-http-proxy も WebSocket をサポートしていますが、設定が必要です。
http-proxy-middleware に比べると設定がやや複雑です。// express-http-proxy: WebSocket 設定
proxy('http://localhost:3000', {
// WebSocket 対応はバージョンや設定に依存する場合あり
// 基本的には HTTP プロキシとして動作し、アップグレードを透過します
});
ライブラリを選ぶ際、将来的なメンテナンス性は極めて重要です。
http-proxy は、長年維持されているコアライブラリです。
http-proxy-middleware は、現在最も活発にメンテナンスされています。
express-http-proxy は、メンテナンス頻度が低下している傾向にあります。
http-proxy-middleware への移行が推奨されるケースが多いです。| 特徴 | http-proxy | http-proxy-middleware | express-http-proxy |
|---|---|---|---|
| タイプ | コアライブラリ | ミドルウェア(ラッパー) | ミドルウェア(独自) |
| Express 統合 | 手動が必要 | 簡単(app.use) | 簡単(app.use) |
| WebSocket | 手動設定必要 | 設定で有効化(ws: true) | 対応(設定による) |
| メンテナンス | 安定(低頻度) | 活発 | 停滞気味 |
| 推奨用途 | 汎用サーバー構築 | Express アプリ標準 | レガシー維持 |
http-proxy-middleware を選ぶべきです。
Express アプリケーションを構築している限り、これが最も合理的な選択です。設定が簡単で、WebSocket 対応もスムーズであり、コミュニティのサポートも厚いからです。
http-proxy は、Express を使わない場合や、プロキシサーバーそのものを独立して構築したい場合に適しています。制御権を完全に握りたいエンジニアリングニーズに応えます。
express-http-proxy は、既存のプロジェクトで既に使われている場合を除き、新規採用は避けるべきです。メンテナンスのリスクを考慮すると、http-proxy-middleware へ移行するコストの方が長期的には安くなります。
最終的には、「Express なら http-proxy-middleware、それ以外なら http-proxy」 というルールで覚えておくと、技術的負債を避けられます。
スタンドアロンのプロキシサーバーを構築する場合や、Express 以外のフレームワークを使用している場合に選択します。最も低レベルな制御を提供しますが、ミドルウェアとして使うには追加のラッパー処理が必要です。
Express や Connect アプリケーションでプロキシ機能を実装する際の標準的な選択肢です。http-proxy の機能をミドルウェアとして手軽に利用でき、メンテナンスも活発です。
Express 専用のシンプルなプロキシが必要な場合に使われますが、メンテナンスが停滞している可能性があるため、新規プロジェクトでは http-proxy-middleware の使用を強く推奨します。
node-http-proxy is an HTTP programmable proxying library that supports
websockets. It is suitable for implementing components such as reverse
proxies and load balancers.
npm install http-proxy --save
Click here
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 methods:
req, res, [options] (used for proxying regular HTTP(S) requests)req, socket, head, [options] (used for proxying WS(S) requests)port (a function that wraps the object in a webserver, for your convenience)[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 (incoming) 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 shows 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:5050' });
});
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:5050'
});
});
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);
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.
//
// 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);
//
// 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);
//
// Create an HTTP proxy server with an HTTPS target
//
httpProxy.createProxyServer({
target: {
protocol: 'https:',
host: 'my-domain-name',
port: 443,
pfx: fs.readFileSync('path/to/certificate.p12'),
passphrase: 'password',
},
changeOrigin: true,
}).listen(8000);
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: true/false, 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
preserveHeaderKeyCase: true/false, Default: false - specify whether you want to keep letter case of response header key
auth: Basic authentication i.e. 'user:password' to compute an Authorization header.
hostRewrite: rewrites the location hostname on (201/301/302/307/308) redirects.
autoRewrite: rewrites the location host/port on (201/301/302/307/308) redirects based on requested host/port. Default: false.
protocolRewrite: rewrites the location protocol on (201/301/302/307/308) redirects to 'http' or 'https'. Default: null.
cookieDomainRewrite: rewrites domain of set-cookie headers. Possible values:
false (default): disable cookie rewritingcookieDomainRewrite: "new.domain". To remove the domain, use cookieDomainRewrite: ""."*" to match all domains.
For example keep one domain unchanged, rewrite one domain and remove other domains:
cookieDomainRewrite: {
"unchanged.domain": "unchanged.domain",
"old.domain": "new.domain",
"*": ""
}
cookiePathRewrite: rewrites path of set-cookie headers. Possible values:
false (default): disable cookie rewritingcookiePathRewrite: "/newPath/". To remove the path, use cookiePathRewrite: "". To set path to root use cookiePathRewrite: "/"."*" to match all paths.
For example, to keep one path unchanged, rewrite one path and remove other paths:
cookiePathRewrite: {
"/unchanged.path/": "/unchanged.path/",
"/old.path/": "/new.path/",
"*": ""
}
headers: object with extra headers to be added to target requests.
proxyTimeout: timeout (in millis) for outgoing proxy requests
timeout: timeout (in millis) for incoming requests
followRedirects: true/false, Default: false - specify whether you want to follow redirects
selfHandleResponse true/false, if set to true, none of the webOutgoing passes are called and it's your responsibility to appropriately return the response by listening and acting on the proxyRes event
buffer: stream of data to send as the request body. Maybe you have some middleware that consumes the request stream before proxying it on e.g. If you read the body of a request into a field called 'req.rawbody' you could restream this field in the buffer option:
'use strict';
const streamify = require('stream-array');
const HttpProxy = require('http-proxy');
const proxy = new HttpProxy();
module.exports = (req, res, next) => {
proxy.web(req, res, {
target: 'http://localhost:4003/',
buffer: streamify(req.rawBody)
}, next);
};
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:
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" connectionsproxyReqWs: This event is emitted before the data is sent. It gives you a chance to alter the proxyReq request object. Applies to "websocket" connectionsproxyRes: 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.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');
});
var proxy = new httpProxy.createProxyServer({
target: {
host: 'localhost',
port: 1337
}
});
proxy.close();
If you want to handle your own response after receiving the proxyRes, you can do
so with selfHandleResponse. As you can see below, if you use this option, you
are able to intercept and read the proxyRes but you must also make sure to
reply to the res itself otherwise the original client will never receive any
data.
var option = {
target: target,
selfHandleResponse : true
};
proxy.on('proxyRes', function (proxyRes, req, res) {
var body = [];
proxyRes.on('data', function (chunk) {
body.push(chunk);
});
proxyRes.on('end', function () {
body = Buffer.concat(body).toString();
console.log("res from proxied server:", body);
res.end("my response to cli");
});
});
proxy.web(req, res, option);
A proxy table API is available through this add-on module, which lets you define a set of rules to translate matching routes to target routes that the reverse proxy will talk to.
$ npm test
Logo created by Diego Pasquali
master)The MIT License (MIT)
Copyright (c) 2010 - 2016 Charlie Robbins, Jarrett Cruger & the Contributors.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.