React系列——用proxy 1分钟解决跨域问题

跨域问题是前端必然要遇到的问题

XMLHttpRequest cannot load http://www.xxx.com/login. Response to preflight request doesn't pass access control check: No 'Access-Control-Allow-Origin' header is present on the requested resource. Origin 'http://localhost:3213' is therefore not allowed access.

上面这段英文提示就是常见的跨域报错，在react工程项目中做的测试，前端项目开启的是本地3213端口，然后后端login的API接口是在www.xxx.com域名下面。

为了保证前端测试可行，为了让你的老板不扣你的工资，用一个最简单的方法解决API资源请求跨域问题：http-proxy-middleware

http-proxy-middleware不需要自己安装，在安装webpack过程中，会自动依赖安装到你的node_modules文件夹下，如果你发现没有，那么请自行安装

npm install --save-dev http-proxy-middleware

在react开发中，分下面2种情况。

1、前端部署了nodejs服务器，采用app.listen()启动前端服务器，那么你只需要在你的js中添加下面几行代码即可

假设你的前端服务器js文件叫做server.js

//导入proxy
var proxy = require('http-proxy-middleware')

//context可以是单个字符串，也可以是多个字符串数组，分别对应你需要代理的api,星号（*）表示匹配当前路径下面的所有api
const context = [`/login`, `/admin/*`]

//options可选的配置参数请自行看readme.md文档，通常只需要配置target，也就是你的api所属的域名。
const options = {
    target: 'http://www.xxx.com',
    changeOrigin: true
}

//将options对象用proxy封装起来，作为参数传递
const apiProxy = proxy(options)

//现在你只需要执行这一行代码，当你访问需要跨域的api资源时，就可以成功访问到了。
app.use(context, apiProxy)

2、你可能没有前端node服务器，但是你用来webpack的devServer来启动前端项目，这个时候的配置跟上面类似。

在你的webpack.config.js里面添加proxy配置。

  //导入proxy
    var proxy = require('http-proxy-middleware')
    
    //context可以是单个字符串，也可以是多个字符串数组，分别对应你需要代理的api,星号（*）表示匹配当前路径下面的所有api
    const context = [`/login`, `/admin/*`]
    
    module.exports = {
        devServer: {
           host: 'localhost',
           port: '3011',
           proxy: [
               {
                    context: context,
                    target: 'https://www.xxx.com',
                    secure: false
              }
           ]
        }
    }

现在，跨域将不会成为你的烦恼，可以放心写代码了。

补充：在create-react-app建立的项目下，其实只需要在package.json文件中添加proxy属性就可以了，跟webpack-dev-server的proxy配置一样，如"proxy":{"/api": "http://www.xxx.com"}

proxy属性添加在package.json的具体位置：就在JSON第一级（跟dependencies一级）添加

"proxy": {
  "/api": {
    "target": "http://192.168.1.100:5000"
  }
}

注意需要写上target，之前回复的没有target是在很早之前有这个写法，target后面就是你需要代理的地址。
当你启动服务的时候可以看到下面的内容，说明已经成功代理了：

[HPM] Proxy created: function (pathname) {
      return mayProxy(pathname) && pathname.match(context);
    }  ->  http://192.168.1.100:5000