代理

在前后端分离的今天，跨域也成了每个前端工程师都需要了解的基本知识，在各种面试题中的日经话题。这个文章就是想总结一下关于同源策略的前世今生，以及怎么解决它。

同源策略

在 MDN中我们可以看到关于同源策略是一个安全机制。详细的说明如下：

同源策略限制了从同一个源加载的文档或脚本如何与来自另一个源的资源进行交互。这是一个用于隔离潜在恶意文件的重要安全机制。

这个机制本身出发点是很好的，但是同源的限制非常严格，**url**，端口任一不同都会造成跨域错误。

而且在控制台中你不会发现任何问题。随着前后端分离越来越普遍，这件事就越来越常见。那么它应该如何解决呢?
后台界面代理设置 - 图1
同源策略全称叫《浏览器的同源策略》，它是浏览器内建的一种安全机制。那么我们不要使用浏览器请求就能完美解决问题了。对于前端来说最方便的自然就是 node.js 了。

在开发中使用

现在市面上所有的脚手架都提供了 proxy 的能力，底层基于 http-proxy-middleware, 这个包可以把所有符合正则匹配的请求转发到某个地址，下面是个简单的 demo：

  1. var express = require('express');
  2. var proxy = require('http-proxy-middleware');
  4. var app = express();
  6. app.use('/api', proxy({ target: 'http://www.example.org', changeOrigin: true }));
  7. app.listen(3000);
  9. // http://localhost:3000/api/foo/bar -> http://www.example.org/api/foo/bar

这个配置可以将所有 /api 开头的请求转到到 http://www.example.org/ ,并且附带所有的参数，包括头信息和 cookie。有一点需要注意的是，在浏览器控制台里看到的仍然是 http://localhost:3000/api/xxx ,转化的步骤是在 node.js 中完成。

在 Pro 中是用 proxy 更加简单在 config.ts 中配置即可，配置出来可能是这样的：

  1. proxy: {
  2.   '/server/api/': {
  3.     target: 'https://preview.pro.ant.design/',
  4.     changeOrigin: true,
  5.     pathRewrite: { '^/server': '' },
  6.   },
  7. },

详细的配置建议直接查看 webpack-dev 的配置。
zero-admin-ui\config\proxy.ts
image.png

CORS

如果觉得以上改动需要配置比较麻烦，系统又比较简单，无需引入新的复杂度。我们可以使用 CORS 的方式来允许跨域调用，在 express 中可以这么设置：

express 中的配置

  1. res.header('Access-Control-Allow-Origin', '你的项目地址，用*将会带来安全问题');
  2. res.header('Access-Control-Allow-Headers', '*');
  3. res.header('Access-Control-Allow-Methods', '*');
  4. res.header('Content-Type', 'application/json;charset=utf-8');

nginx 中的配置

  1. location ^~ /api {
  2.   proxy_set_header Origin '';
  3.   add_header Access-Control-Allow-Credentials true;
  4.   add_header Access-Control-Allow-Headers $http_access_control_request_headers;
  5.   add_header Access-Control-Allow-Methods POST,GET,OPTIONS,DELETE,PUT,HEAD,PATCH;
  6.   add_header Access-Control-Allow-Origin $http_origin;
  7.   add_header Access-Control-Expose-Headers $http_access_control_request_headers;
  9.   if ($request_method = 'OPTIONS') {
  10.     return 204;
  11.   }
  12.   if ($request_method != 'OPTIONS'){
  13.     proxy_pass "你的项目地址";
  14.   }
  15. }

需要注意的是，目前 nginx 1.7.5 之前的版本，add_header 只对 2xx，3xx 的请求生效，5xx 的请求无法增加 header，仍会被浏览器跨域策略拦截，在 5xx 请求的 body 中包含的错误信息，前端无法获取到。

java 手动配置

  1. import javax.servlet.http.HttpServletRequest;
  2. import javax.servlet.http.HttpServletResponse;
  4. public class HttpErrorResponseUtil {
  5.     public static void setResponeCorsHeader(HttpServletRequest request, HttpServletResponse response) {
  6.       response.addHeader("Access-Control-Allow-Credentials", "true");
  7.       response.addHeader("Access-Control-Allow-Methods", "POST,GET,OPTIONS,DELETE,PUT,HEAD,PATCH");
  8.       response.addHeader("Access-Control-Allow-Origin", request.getHeader("Origin"));
  9.       response.addHeader("Access-Control-Allow-Headers", request.getHeader("Access-Control-Request-Headers"));
  10.     }
  11. }

在别的语言中方法也大同小异，最重要的是 Access-Control-Allow-Origin Access-Control-Allow-Headers Access-Control-Allow-Methods 头的相应设置。

在这里强烈建议每个人通读一下 MDN 的 HTTP 访问控制 ，这篇图文并茂的文章可以解决跨域百分之八十的疑惑。

高级用法

在开发中我们可能需要区分多种情况，比如开发环境，测试环境，语法环境，在 Pro 中我们可以通过的环境变量来实现这个需求。

  1. const serveUrlMap = {
  2.   dev: 'https://dev.pro.ant.design/',
  3.   pre: 'https://pre.pro.ant.design/',
  4.   test: 'https://test.pro.ant.design/',
  5.   idc: 'https://idc.pro.ant.design/',
  6. };
  8. const { SERVE_ENV = 'idc' } = process.env;
  10. export default {
  11.   // ....
  12.   proxy: {
  13.     '/server/api/': {
  14.       target: serveUrlMap[SERVE_ENV],
  15.       changeOrigin: true,
  16.       pathRewrite: { '^/server': '' },
  17.     },
  18.   },
  19. };

zero-admin-ui\config\proxy.ts

  1. /**
  2.  * 在生产环境 代理是无法生效的，所以这里没有生产环境的配置
  3.  * The agent cannot take effect in the production environment
  4.  * so there is no configuration of the production environment
  5.  * For details, please see
  6.  * https://pro.ant.design/docs/deploy
  7.  */
  8. /**
  9.  const serveUrlMap = {
  10.   dev: 'https://dev.pro.ant.design/',
  11.   pre: 'https://pre.pro.ant.design/',
  12.   test: 'https://test.pro.ant.design/',
  13.   idc: 'https://idc.pro.ant.design/',
  14. };
  15. */
  16. const apiMap = {
  17.   dev: 'http://127.0.0.1:8888',
  18.   pre: 'https://pre.pro.ant.design/',
  19.   test: 'https://test.pro.ant.design/',
  20.   idc: 'https://idc.pro.ant.design/',
  21. };
  23. const { REACT_APP_ENV = 'dev' } = process.env;
  25. export default {
  26.   proxy: {
  27.     '/api/': {
  28.       target:apiMap[REACT_APP_ENV],
  29.       changeOrigin: true,
  30.       pathRewrite: { '^': '' },
  31.     },
  32.   }
  33. };

zero-admin-ui\config\config.ts
image.png

我们只要在 package.json 中配置好各种快捷命令，就可以做到快速切换。

  1. {
  2.     "scripts": {
  3.         "start:dev": "cross-env REACT_APP_ENV=dev MOCK=none UMI_ENV=dev umi dev",
  4.         "start:no-mock": "cross-env MOCK=none UMI_ENV=dev umi dev",
  5.         "start:no-ui": "cross-env UMI_UI=none UMI_ENV=dev umi dev",
  6.         "start:pre": "cross-env REACT_APP_ENV=pre UMI_ENV=dev umi pre ",
  7.         "start:test": "cross-env REACT_APP_ENV=test MOCK=none UMI_ENV=dev umi test",
  8.     }
  9. }

这里值得注意的是 config.ts 的环境为 node.js 的环境，里面是无法使用 dom 和浏览器的相关行为的。

zero-admin-ui\package.json
image.png

原文链接

https://pro.ant.design/zh-CN/docs/proxy