手写可配置的express nodejs的代理

nodejs比较好的代理包有：node-http-proxy和http-proxy-middleware。这两个我都用过，它们的优点自不用说，只说说缺点：它们不能从配置文件里读取代理配置。每添加一个拦截路径都需要多加一个接口调用。

所以，我需要自己写一个http代理，要包含一下功能：

1. 从配置文件里读取代理配置
2. 可以路径重写

这样做的好处是：新增服务只需要在配置文件上加上该服务，无需修改业务逻辑

1 /config/default.js

1. module.exports = {
2. "ENV":"dev",
3. "PORT":"8088",
5. "maxAge": 10,
7. "proxy":{
8. "olap":{
9. "host":"172.16.200.225",
10. "port":"8092",
11. "form":"",
12. "to":""
13. },
14. "qc":{
15. "host":"192.168.40.231",
16. "port":"30088"
17. },
18. "api":{
19. "host":"192.168.40.231",
20. "port":"30412"
21. },
22. "ocm":{
23. "host": process.env.ocm_host || "192.168.40.119",
24. "port": process.env.ocm_port || "31003"
25. }
26. }
27. }

2 /app.js

将所有要走代理的路径前必需加上 /p, 这个是我的个人配置，当然也可以是其他的名字。

1. var express = require('express');
2. var compression = require('compression');
3. var path = require('path');
4. var config = require('config');
5. var log4js = require('log4js');
6. var wsProxyConfig = config.get('proxy');
8. var routes = require('./routes/index');
9. var views = require('./routes/views');
10. var proxy = require('./routes/proxy');
13. app.use('/p',proxy);

3 /routes/proxy.js

1. var express = require('express');
2. // config是一个第三方包，它的功能是
3. // 自动根据环境变量帮你读取config目录下
4. // 的配置文件，默认会读取default.json，
5. // config支持很多文件类型。
6. var config = require('config');
7. var request = require('request');
8. var log4js = require('log4js');
9. var path = require('path');
11. var router = express.Router();
12. // 此处就是获取配置文件的proxy项了
13. var proxyConfig = config.get('proxy');
15. // 这里记录代理的日志
16. log4js.configure({
17. appenders: [
18. {
19. type: 'file',
20. filename: './logs/all-proxy-logs.log',
21. maxLogSize: 10*1024*1024, //max 10mb
22. backups: 5,
23. compress: true
24. },
25. {
26. type: 'stdout'
27. }
28. ]
29. });
30. var logger = log4js.getLogger('proxy');
33. router.all('/:apiName/*', function(req, res, next) {
34. // apiName 必需要对应配置文件的proxy的属性名
35. var apiName = req.params.apiName;
37. if(!apiName){
38. res.status(404).end('api not found');
39. }
41. // 如果apiName不在配置文件里，则报500
42. else if(!proxyConfig[apiName]){
43. res.status(500).end('api has no config');
44. }
46. else{
47. // originUrl是原始的url
48. // 例如 /p/qc/calls
49. var originalUrl = req.originalUrl;
50. var api = proxyConfig[apiName];
51. var url = originalUrl.replace('/p','');
53. url = `http://${api.host}:${api.port}` + url;
55. // 某些需要路径重写的地方
56. if(api.form && api.to){
57. url = url.replace(api.form, api.to);
58. }
60. // 必须要删除这个host
61. // 因为本地测试时，这个host是localhost
62. // 这会导致服务端报错
63. delete req.headers.host;
65. // 修改好的请求头
66. var option = {
67. url: url,
68. headers: req.headers
69. };
71. // 使用request发起请求
72. var proxy = request(option);
73. // 此处是关键，将请求流写入代理，将代理的响应写入原始响应
74. req.pipe(proxy);
75. proxy.pipe(res);
77. // 代理结束响应时，原始请求结束，并输出日志
78. proxy.on('end', function(){
79. var log = `${req.method} ${res.statusCode} ${req.originalUrl} ---> ${option.url} ${req.headers.sessionid}`;
81. if(res.statusCode < 400){
82. logger.info(log);
83. }
84. else{
85. logger.error(log);
86. }
88. res.end();
89. });
90. }
92. });
94. module.exports = router;

4 相关第三方模块

• node-config
• request
• log4js-node

小手一抖，资料全有。长按二维码关注京程一灯，阅读更多技术文章和业界动态。