本文介绍关于在react脚手架开发过程中碰到跨域问题该如何进行处理,不进行跨域原因的阐述。
react脚手架中可通过两种方式配置代理:
- 在package.json文件中配置;
- 新建setupProxy.js文件进行配置
package.json配置代理
假设我们要在本地3000端口向本地5000端口发起请求,完整的请求地址为:http://localhost:5000/study。由于浏览器的**同源策略**,不同的端口交互会产生跨域:
我们可以通过在package.json文件中进行配置,打开这个文件,在最后添加一行代理的代码:
"proxy": "http://localhost:5000"
具体代码内容如下:
{ "name": "todolist", "version": "0.1.0", "private": true, "dependencies": { "@testing-library/jest-dom": "^5.11.4", "@testing-library/react": "^11.1.0", "@testing-library/user-event": "^12.1.10", "axios": "^0.21.1", "react": "^17.0.1", "react-dom": "^17.0.1", "react-scripts": "4.0.3", "web-vitals": "^1.0.1" }, "scripts": { "start": "react-scripts start", "build": "react-scripts build", "test": "react-scripts test", "eject": "react-scripts eject" }, "eslintConfig": { "extends": [ "react-app", "react-app/jest" ] }, "browserslist": { "production": [ ">0.2%", "not dead", "not op_mini all" ], "development": [ "last 1 chrome version", "last 1 firefox version", "last 1 safari version" ] }, "proxy": "http://localhost:5000"}
添加这行代码表示当客户端向端口为5000的服务端发起请求,会由代理转发这次请求,代理端和服务器不受浏览器同源策略的限制,不会产生跨域问题,返回结果如下图:
**问题:**但是这种方式配置代理有一定的局限性,当客户端需要向多个不同服务器发起请求时,proxy只能允许配置一个代理,因此便有了以下方式。
setupProxy文件配置代理
我们可以在src目录下新建一个名为**"setupProxy.js"的文件,react脚手架会自动识别该文件的配置并编译,在该文件中,只能使用Common JS,无法使用ES6**高级语法,否则会无法识别并报错,让我们看看如何配置。
首页我们需要引入**http-proxy-middleware**
这个模块,该模块不需要我们手动下载,项目中自带该模块,直译为:**http代理中间件,**具体代码如下:
const proxy = require('http-proxy-middleware')
module.exports = function(app) {
app.use(
proxy('/api1', { //api1是需要转发的请求(所有带有/api1前缀的请求都会转发给5000)
target: 'http://localhost:5000', //配置转发目标地址(能返回数据的服务器地址)
changeOrigin: true, //控制服务器接收到的请求头中host字段的值
/*
changeOrigin设置为true时,服务器收到的请求头中的host为:localhost:5000
changeOrigin设置为false时,服务器收到的请求头中的host为:localhost:3000
changeOrigin默认值为false,但我们一般将changeOrigin值设为true
*/
pathRewrite: {'^/api1': ''} //去除请求前缀,保证交给后台服务器的是正常请求地址(必须配置)
}),
proxy('/api2', {
target: 'http://localhost:5001',
changeOrigin: true,
pathRewrite: {'^/api2': ''}
})
)
}
注意:webpack会自动识别该文件进行编译,所以若新建了该文件或者修改了该文件,必须重启项目才会生效。
说明:
-
优点:可以配置多个代理,可以灵活的控制请求是否走代理。
-
缺点:配置繁琐,前端请求资源时必须加前缀。