webpack和vite devServer的进阶用法:配置proxy修改请求和响应

简介: 在前端日常开发中我们一般都是配置本地开发服务器的proxy来解决跨域问题,查看官网文档或者通过搜索引擎搜出来的都是比较基础的用法。

在前端日常开发中我们一般都是配置本地开发服务器的proxy来解决跨域问题,查看官网文档或者通过搜索引擎搜出来的都是比较基础的用法:

proxy: {
     '/api/': {
         target: 'http://dev.test.com'
     }
 }

我最近有这么一个需求,需要修改请求头里的一些东西,我最初使用node启动一个本地服务来做代理,后面我觉得有点麻烦,每次开发都要手动来开启。后来又瞄了下vue-cli的官网,里面提到:如果你想要更多的代理控制行为,也可以使用一个 path: options 成对的对象。

页面里给出了如下的代码:

createProxyMiddleware({
  target: 'http://www.example.org',
  on: {
    proxyReq: (proxyReq, req, res) => {
      /* handle proxyReq */
    },
    proxyRes: (proxyRes, req, res) => {
      /* handle proxyRes */
    },
    error: (err, req, res) => {
      /* handle error */
    },
  },
});

看到上述代码,你可能会直接把on那里面的东西直接复制到上面配置的target下面,不过我尝试了之后,并没有生效。我搜索了一下http-proxy-middleware之后,搜到了如下的代码,经过测试之后,确定可用

下面是正确的配置选项:

proxy: {
  '/api/': {
    target: 'http://www.abc.com',
      changeOrigin: true,
      onProxyReq: (proxyReq, req, res) => {
      proxyReq.removeHeader('referer')  //移除请求头
      proxyReq.removeHeader('origin') //移除请求头
      proxyReq.setHeader('host','www.abc.com') //添加请求头
    }
  }
}

上面的代码是移除请求头里面的referer和origin字段,因为我要请求的api对这个字段进行了校验,我们前端本地的服务器一般是localhost:8080之类的,通过浏览器请求携带的是本地地址,api拒绝请求,移除和修改这些请求头之后,就可以正常请求api了。

最近vite也逐渐流行起来,我最近在新项目中也开始使用vite,查看了vite官网文档,官网给出了如下用法:

'/api': {
        target: 'http://jsonplaceholder.typicode.com',
        changeOrigin: true,
        configure: (proxy, options) => {
          // proxy 是 'http-proxy' 的实例
        }
      }

代码如下:

proxy.on('proxyRes', function (proxyRes, req, res) {
  console.log('RAW Response from the target', JSON.stringify(proxyRes.headers, true, 2));
});

直接将上述代码复制到configure里面就可以运行了,下面是示例:

proxy: {
      '/api/': {
        target: 'http://www.abc.com',
        changeOrigin: true,
        prependPath: true,
        configure: (proxy, options) => {
          proxy.on('proxyReq', function (proxyReq, req, res) {
            proxyReq.removeHeader('referer')  //移除请求头
            proxyReq.removeHeader('origin') //移除请求头
            proxyReq.setHeader('host','www.abc.com') //添加请求头
          });
        }
      }
    }

上面示例均是将地址/api/的请求转发到www.abc.com ,例:本地地址:127.0.0.1:8080/api/getUserInfo,目标api是:www.abc.com/api/getUserInfo

以上示例之给出了proxyReq事件,完整事件如下(机翻):

error:如果对目标的请求失败,则会发出错误事件。我们不对客户端和代理之间传递的消息以及代理和目标之间传递的消息进行任何错误处理,因此建议您侦听错误并进行处理。
proxyReq:在发送数据之前发出此事件。它使您有机会更改 proxyReq 请求对象。适用于“网络”连接
proxyReqWs:在发送数据之前发出此事件。它使您有机会更改 proxyReq 请求对象。适用于“websocket”连接
proxyRes:如果对目标的请求得到响应,则会发出此事件。
open:一旦创建代理 websocket 并将其通过管道传输到目标 websocket,就会发出此事件。
close:一旦代理 websocket 关闭,就会触发此事件。
proxySocket(已弃用):建议使用open.

如果你想修改api响应的数据,代码如下,写在proxyRes事件里:

// 响应头里添加允许跨域的字段
res.header("Access-Control-Allow-Origin", req.headers.origin);
    res.header("Access-Control-Allow-Credentials", 'true');
    res.header("Access-Control-Allow-Headers", "Content-Type,Content-Length, Authorization, Accept,X-Requested-With");
    res.header("Access-Control-Allow-Methods", "PUT,POST,GET,DELETE,OPTIONS");
    if(req.method=='OPTIONS'){
      res.writeHead(204)
    }
//  添加cookie字段
res.header('set-cookie',`cookieKey=${cookieValue};Path=/;SameSite=None;Secure=true;HttpOnly`)
目录
相关文章
|
1月前
|
前端开发
在Webpack配置文件中,如何配置loader以处理其他类型的文件,如CSS或图片
在Webpack配置文件中,通过设置`module.rules`来配置loader处理不同类型的文件。例如,使用`css-loader`和`style-loader`处理CSS文件,使用`file-loader`或`url-loader`处理图片等资源文件。配置示例:在`rules`数组中添加对应规则,指定`test`匹配文件类型,`use`指定使用的loader。
|
1月前
|
缓存 前端开发 JavaScript
Webpack与Babel的进阶配置与优化
通过以上的进阶配置和优化策略,可以更好地发挥`Webpack`与`Babel`的功能,提高项目的性能和开发效率。
|
1月前
|
JavaScript 前端开发 UED
如何配置 Webpack 进行代码分离?
通过以上方法,可以有效地配置Webpack进行代码分离,根据项目的具体需求和场景选择合适的方式,能够显著提高应用的性能和用户体验。在实际应用中,还可以结合其他优化技术,进一步优化Webpack的打包结果和应用的加载速度。
52 5
|
1月前
|
前端开发 JavaScript
webpack相关配置
以上只是Webpack配置的一些常见部分,实际应用中还可以根据具体的项目需求和场景进行更复杂和细致的配置,以满足不同的构建和优化要求。
45 2
|
1月前
|
前端开发 JavaScript 开发者
工程化(webpack+vite)
在现代前端开发中,工程化是提高开发效率和项目质量的关键。UniApp 结合 Webpack 和 Vite,提供强大的工程化支持。Webpack 功能强大,支持复杂项目的构建;Vite 则利用现代浏览器的 ESM 特性,提供快速的开发体验。开发者可根据项目需求选择合适的工具,显著提升开发效率和项目质量。
|
1月前
|
缓存 JavaScript 前端开发
配置 Webpack 进行代码分离的常见方法有哪些?
通过以上常见方法,可以根据项目的具体需求和场景,灵活地配置Webpack进行代码分离,从而提高应用的性能和加载速度,优化用户体验。
35 3
|
1月前
|
缓存 前端开发 JavaScript
前端性能优化:Webpack与Babel的进阶配置与优化策略
【10月更文挑战第28天】在现代Web开发中,Webpack和Babel是不可或缺的工具,分别负责模块打包和ES6+代码转换。本文探讨了它们的进阶配置与优化策略,包括Webpack的代码压缩、缓存优化和代码分割,以及Babel的按需引入polyfill和目标浏览器设置。通过这些优化,可以显著提升应用的加载速度和运行效率,从而改善用户体验。
60 6
|
1月前
|
缓存 监控 前端开发
前端工程化:Webpack与Gulp的构建工具选择与配置优化
【10月更文挑战第26天】前端工程化是现代Web开发的重要趋势,通过将前端代码视为工程来管理,提高了开发效率和质量。本文详细对比了Webpack和Gulp两大主流构建工具的选择与配置优化,并提供了具体示例代码。Webpack擅长模块化打包和资源管理,而Gulp则在任务编写和自动化构建方面更具灵活性。两者各有优势,需根据项目需求进行选择和优化。
76 7
|
1月前
|
前端开发
配置 Webpack 实现热更新
【10月更文挑战第23天】还可以进一步深入探讨热更新的具体实现细节、不同场景下的应用案例,以及如何针对特定需求进行优化等方面的内容。通过全面、系统地了解 Webpack 热更新的配置方法,能够更好地利用这一功能,提升项目的开发效率和性能表现。同时,要不断关注 Webpack 及相关技术的发展动态,以便及时掌握最新的热更新技术和最佳实践。
|
1月前
|
缓存 前端开发 JavaScript
前端工程化:Webpack与Gulp的构建工具选择与配置优化
【10月更文挑战第27天】在现代前端开发中,构建工具的选择对项目的效率和可维护性至关重要。本文比较了Webpack和Gulp两个流行的构建工具,介绍了它们的特点和适用场景,并提供了配置优化的最佳实践。Webpack适合大型模块化项目,Gulp则适用于快速自动化构建流程。通过合理的配置优化,可以显著提升构建效率和性能。
54 2