React Proxy 详细流程与配置方式(webpack、setupProxy.js、package.json)

简介: React Proxy 详细流程与配置方式(webpack、setupProxy.js、package.json)

一、 package.json 配置方式

  • 全部以 GET 请求为例,每次修改配置后,重启项目,否则不生效
访问 http://127.0.0.1:6000/api/user/list 接口为例
  • 检查自己脚手架版本
$ create-react-app -V
  • 若脚手架版本在 2.0 以下,可以使用对象类型配置代理,在项目的 package.json 文件中配置如下:
"proxy": {
  "/api": {
    "target": "http://127.0.0.1:6000/api", # 跨域地址
    "changeOrigin": true,              # 是否允许跨域
    "pathRewrite": {                   # 重写路径
      "^/api": ""
    }
  }
}
  • 举例: 配置好后,按代理标识访问
useEffect(() => { 
  $get('/api/user/list').then(res => {
    console.log(res)
  }).catch((err) => {
    console.log(err)
  })
}, [])
  • 若脚手架版本在 2.0 以上,只能配置 string 类型
"proxy": "http://127.0.0.1:6000"
  • 举例: 配置好之后可以直接访问
// 方式一:不带域名,直接接口地址即可
useEffect(() => {
  $get('/api/user/config_name').then(res => {
    console.log(res)
  }).catch((err) => {
    console.log(err)
  })
}, [])
// 方式二:带上域名也没问题,但是这种写法发布到线上就会有问题,需要判断环境切换域名
useEffect(() => {
  $get('http://127.0.0.1:6000/api/user/list').then(res => {
    console.log(res)
  }).catch((err) => {
    console.log(err)
  })
}, [])

二、 setupProxy.js 配置方式 (推荐方案)

  • 配置一个或多个代理,最好的方式是使用 middleware 中间件进行配置。
  • 检查 package.json 中是否安装了 http-proxy-middleware,如果没有手动安装下:
# yarn
$ yarn add http-proxy-middleware
# npm
$ npm i http-proxy-middleware
  • src 中,新建 setupProxy.js(文件名固定,不可自定义,react 脚手架会识别),在文件中写以下配置内容(新项目都是推荐使用高版本,不然可能会无法启动项目)。
文件路径: /src/setupProxy.js
  • http-proxy-middleware1.0 以后):
const proxy = require('http-proxy-middleware')
module.exports = function (app)  {
  app.use(
    // 代理 1
    proxy.createProxyMiddleware('/api', {             // 匹配到 '/api' 前缀的请求,就会触发该代理配置
      target: 'http://127.0.0.1:6000/api',  // 请求转发地址
      changeOrigin: true,                             // 是否跨域
      /*
        changeOrigin 为 true 时,服务器收到的请求头中的host为:127.0.0.1:6000,也就是代理地址的 host
        changeOrigin 为 false 时,服务器收到的请求头中的host为:localhost:3000,也就是本地站点地址的 host
        changeOrigin 默认 false,但一般需要将 changeOrigin 值设为 true,根据自己需求调整
      */
      pathRewrite: {
        '^/api': ''                                   // 重写请求路径
      }
    }),
    // 代理 2,为什么 2 写前面,因为匹配规则,上面第一个已经是 /api 了,要不然会优先匹配到第一个代理上
    proxy.createProxyMiddleware('/2api', {
      target: 'http://127.0.0.1:6000/api',
      changeOrigin: true,
      pathRewrite: {
        '^/2api': ''
      }
    }),
    // 代理 3,这种写法是最规范的,前后都加 /
    proxy.createProxyMiddleware('/3api/', {
      target: 'http://127.0.0.1:6000/api/',
      changeOrigin: true,
      pathRewrite: {
        '^/3api/': ''
      }
    }),
    // 代理 4,这种代理标识尾部加 / ,代理地址尾部没有
    proxy.createProxyMiddleware('/4api/', {
      target: 'http://127.0.0.1:6000/api',
      changeOrigin: true,
      pathRewrite: {
        // '^/4api/': ''  // 这种替换成空,也没问题,但是不严谨
        '^/4api/': '/'    // 这样写更规范
      }
    })
    // ..... 多个代理
  )
}
  • http-proxy-middleware1.0 以前,老版本):
const proxy = require('http-proxy-middleware')
module.exports = function (app)  {
  app.use(
    // 代理 1
    proxy('/api', {
      target: 'http://127.0.0.1:6000/api',
      changeOrigin: true,
      pathRewrite: {
        '^/api': ''
      }
    }),
    // 代理 2
    proxy('/2api', {
      target: 'http://127.0.0.1:6000/api',
      changeOrigin: true,
      pathRewrite: {
        '^/2api': ''
      }
    })
  )
}

三、 webpack 配置方式

$ npm run eject
  • 找到 webpack 代理相关配置,在 /config/webpackDevServer.config.js 文件中搜索 proxy

  • proxy 修改为
proxy: {
  '/api': {
    target: 'http://127.0.0.1:6000/api',
    changeOrigin: true,
    pathRewrite: {
      '^/api': ''
    }
  }
  // 更多代理配置
},

四、 自定义 webpack 配置文件方式

  • 这种就不写了,写个 demo 麻烦,比如用最新版本的 webpack 搭建一个 React 项目,脚手架可能还不支持,或者手痒想全部走自定义的 webpack 配置,这个时候就需要单独 webpack 各个环境的配置文件,然后修改 package.json 中的执行命令,走自定义的 webpack 配置文件。

土、上面几种代理配置方式,配置后的使用案例代码

  • 案例代码
useEffect(() => {
  // '/api'
  $get('/api/user/config_name').then(res => {
    console.log(res)
  }).catch((err) => {
    console.log(err)
  })
  // '/2api'
  $get('/2api/user/config_name').then(res => {
    console.log(res)
  }).catch((err) => {
    console.log(err)
  })
  // '/3api/'
  $get('/3api/user/config_name').then(res => {
    console.log(res)
  }).catch((err) => {
    console.log(err)
  })
  // '/4api/'
  $get('/4api/user/config_name').then(res => {
    console.log(res)
  }).catch((err) => {
    console.log(err)
  })
}, [])
目录
打赏
0
0
0
1
270
分享
相关文章
如何在React Router中进行嵌套路由配置?
如何在React Router中进行嵌套路由配置?
101 57
在Webpack配置文件中,如何配置loader以处理其他类型的文件,如CSS或图片
在Webpack配置文件中,通过设置`module.rules`来配置loader处理不同类型的文件。例如,使用`css-loader`和`style-loader`处理CSS文件,使用`file-loader`或`url-loader`处理图片等资源文件。配置示例:在`rules`数组中添加对应规则,指定`test`匹配文件类型,`use`指定使用的loader。
Webpack与Babel的进阶配置与优化
通过以上的进阶配置和优化策略,可以更好地发挥`Webpack`与`Babel`的功能,提高项目的性能和开发效率。
如何配置 Webpack 进行代码分离?
通过以上方法,可以有效地配置Webpack进行代码分离,根据项目的具体需求和场景选择合适的方式,能够显著提高应用的性能和用户体验。在实际应用中,还可以结合其他优化技术,进一步优化Webpack的打包结果和应用的加载速度。
156 5
webpack相关配置
以上只是Webpack配置的一些常见部分,实际应用中还可以根据具体的项目需求和场景进行更复杂和细致的配置,以满足不同的构建和优化要求。
107 2
React 中集成 Chart.js 图表库
本文介绍了如何在 React 项目中集成 Chart.js 创建动态图表,涵盖基础概念、安装步骤、代码示例及常见问题解决方法,帮助开发者轻松实现数据可视化。
131 11
聊聊 Go 语言中的 JSON 序列化与 js 前端交互类型失真问题
在Web开发中,后端与前端的数据交换常使用JSON格式,但JavaScript的数字类型仅能安全处理-2^53到2^53间的整数,超出此范围会导致精度丢失。本文通过Go语言的`encoding/json`包,介绍如何通过将大整数以字符串形式序列化和反序列化,有效解决这一问题,确保前后端数据交换的准确性。
100 4
配置 Webpack 进行代码分离的常见方法有哪些?
通过以上常见方法,可以根据项目的具体需求和场景,灵活地配置Webpack进行代码分离,从而提高应用的性能和加载速度,优化用户体验。
80 3
前端性能优化:Webpack与Babel的进阶配置与优化策略
【10月更文挑战第28天】在现代Web开发中,Webpack和Babel是不可或缺的工具,分别负责模块打包和ES6+代码转换。本文探讨了它们的进阶配置与优化策略,包括Webpack的代码压缩、缓存优化和代码分割,以及Babel的按需引入polyfill和目标浏览器设置。通过这些优化,可以显著提升应用的加载速度和运行效率,从而改善用户体验。
145 6
前端工程化:Webpack与Gulp的构建工具选择与配置优化
【10月更文挑战第26天】前端工程化是现代Web开发的重要趋势,通过将前端代码视为工程来管理,提高了开发效率和质量。本文详细对比了Webpack和Gulp两大主流构建工具的选择与配置优化,并提供了具体示例代码。Webpack擅长模块化打包和资源管理,而Gulp则在任务编写和自动化构建方面更具灵活性。两者各有优势,需根据项目需求进行选择和优化。
159 7

热门文章

最新文章