Webpack-dev-server的proxy用法

Lin_R 发布于2019-08-23 11:50 / 302人阅读

摘要：原文首次发表在的用法前言如果你有多带带的后端开发服务器，并且希望在同域名下发送请求，那么代理某些会很有用。可以基于一个函数的返回值绕过代理。要为传出连接绑定的本地接口字符串，默认值将主机标头的原点更改为目标参考官方文档

原文首次发表在: Webpack-dev-server的proxy用法

前言

如果你有多带带的后端开发服务器 API，并且希望在同域名下发送 API 请求，那么代理某些 URL 会很有用。

解决开发环境的跨域问题(不用在去配置nginx和host, 爽歪歪~~)

在webpack.config.js中配置

下面简单介绍一下五个经常使用的场景

使用一:

mmodule.exports = {
    //...
    devServer: {
        proxy: {
            "/api": "http://localhost:3000"
        }
    }
};

请求到 /api/xxx 现在会被代理到请求 http://localhost:3000/api/xxx, 例如 /api/user 现在会被代理到请求 http://localhost:3000/api/user

使用二

如果你想要代码多个路径代理到同一个target下, 你可以使用由一个或多个「具有 context 属性的对象」构成的数组：

module.exports = {
    //...
    devServer: {
        proxy: [{
            context: ["/auth", "/api"],
            target: "http://localhost:3000",
        }]
    }
};

使用三:

如果你不想始终传递 /api ，则需要重写路径：

module.exports = {
    //...
    devServer: {
        proxy: {
            "/api": {
                target: "http://localhost:3000",
                pathRewrite: {"^/api" : ""}
            }
        }
    }
};

请求到 /api/xxx 现在会被代理到请求 http://localhost:3000/xxx, 例如 /api/user 现在会被代理到请求 http://localhost:3000/user

使用四:

默认情况下，不接受运行在 HTTPS 上，且使用了无效证书的后端服务器。如果你想要接受，只要设置 secure: false 就行。修改配置如下：

module.exports = {
    //...
    devServer: {
        proxy: {
            "/api": {
                target: "https://other-server.example.com",
                secure: false
            }
        }
    }
};

使用五:

有时你不想代理所有的请求。可以基于一个函数的返回值绕过代理。
在函数中你可以访问请求体、响应体和代理选项。必须返回 false 或路径，来跳过代理请求。

例如：对于浏览器请求，你想要提供一个 HTML 页面，但是对于 API 请求则保持代理。你可以这样做：

module.exports = {
  //...
    devServer: {
        proxy: {
            "/api": {
                target: "http://localhost:3000",
                bypass: function(req, res, proxyOptions) {
                    if (req.headers.accept.indexOf("html") !== -1) {
                        console.log("Skipping proxy for browser request.");
                        return "/index.html";
                    }
                }
            }
        }
    }   
};

解决跨域原理

上面的参数列表中有一个changeOrigin参数, 是一个布尔值, 设置为true, 本地就会虚拟一个服务器接收你的请求并代你发送该请求,

module.exports = {
    //...
    devServer: {
        proxy: {
            "/api": {
                target: "http://localhost:3000",
                changeOrigin: true,
            }
        }
    }
};

vue-cli中proxyTable配置接口地址代理示例

修改 config/index.js

module.exports = {
    dev: {
    // 静态资源文件夹
    assetsSubDirectory: "static",
    // 发布路径
    assetsPublicPath: "/",

    // 代理配置表，在这里可以配置特定的请求代理到对应的API接口
    // 使用方法：https://vuejs-templates.github.io/webpack/proxy.html
    proxyTable: {
        // 例如将"localhost:8080/api/xxx"代理到"https://wangyaxing.cn/api/xxx"
        "/api": {
            target: "https://wangyaxing.cn", // 接口的域名
            secure: false,  // 如果是https接口，需要配置这个参数
            changeOrigin: true, // 如果接口跨域，需要进行这个参数配置
        },
        // 例如将"localhost:8080/img/xxx"代理到"https://cdn.wangyaxing.cn/xxx"
        "/img": {
            target: "https://cdn.wangyaxing.cn", // 接口的域名
            secure: false,  // 如果是https接口，需要配置这个参数
            changeOrigin: true, // 如果接口跨域，需要进行这个参数配置
            pathRewrite: {"^/img": ""}  // pathRewrite 来重写地址，将前缀 "/api" 转为 "/"。
        }
    },
    // Various Dev Server settings
    host: "localhost", // can be overwritten by process.env.HOST
    port: 4200, // can be overwritten by process.env.PORT, if port is in use, a free one will be determined
}

更多参数

dev-server 使用了非常强大的 http-proxy-middleware , http-proxy-middleware 基于 http-proxy 实现的，可以查看 http-proxy 的源码和文档:https://github.com/nodejitsu/... 。

target：要使用url模块解析的url字符串
forward：要使用url模块解析的url字符串
agent：要传递给http（s）.request的对象（请参阅Node的https代理和http代理对象）
ssl：要传递给https.createServer（）的对象
ws：true / false，是否代理websockets
xfwd：true / false，添加x-forward标头
secure：true / false，是否验证SSL Certs
toProxy：true / false，传递绝对URL作为路径（对代理代理很有用）
prependPath：true / false，默认值：true - 指定是否要将目标的路径添加到代理路径
ignorePath：true / false，默认值：false - 指定是否要忽略传入请求的代理路径（注意：如果需要，您必须附加/手动）。
localAddress：要为传出连接绑定的本地接口字符串
changeOrigin：true / false，默认值：false - 将主机标头的原点更改为目标URL

参考

官方文档

http-proxy-middleware

node-http-proxy

API Proxying During Development

服务器托管专线服务 webpack-dev-server 的用法 cdn的用法 find的用法

文章版权归作者所有，未经允许请勿转载,若此文章存在违规行为，您可以联系管理员删除。

转载请注明本文地址：https://www.ucloud.cn/yun/97545.html

[Webpack并不难]使用教程（四）--- devServer

摘要：使用教程一，，，使用教程二使用教程三我的版本是官方的文档在开发模式下，提供虚拟服务器，让我们进行开发和调试。文档如果为，开启虚拟服务器时，为你的代码进行压缩。的警告和错误是不输出到终端的。而则作用于请求路径上的。不想启用也可以填。使用教程（一）--- entry，devtool，output，resolve使用教程（二）--- module.loaders使用教程（三）--- pl...

Anonymous1 2019-08-22 11:15 评论0 收藏0
webpack在前端项目中使用心得一二

摘要：熟悉了之后，各种新旧项目，大小项目都能用耍的飞起。使用作为文件中的模板安装，记住不是，也不用配置，只需在标签中指定，就可以愉快的使用语法了，比起看起来简洁多了。 webpack做文件合并使用构建工具非常常用一个功能就是合并js和css文件，gulp和grunt都是编写相应的任务来完成，转到webpack突然懵逼了，简单的项目怎么做文件合并呢？其实只需把多个js文件同时引入到main....

qieangel2013 2019-08-20 16:11 评论0 收藏0
Webpack系列——关于Webpack-dev-server配置的点点滴滴

文章首发于我的github及个人博客，github请看https://github.com/huruji/blo...，转载请注明出处。我们都知道webpack-dev-server为我们在开发的时候提供了一个服务器以便于我们的开发，我们在使用之前当然需要安装： npm i webpack webpack-dev-server -D 安装完成之后我们只需要在webpack配置中配置devServ...

melody_lql 2019-08-21 16:51 评论0 收藏0
本地开发环境cookie丢失?

摘要：代理响应事件，可以在这里修改响应。再贴一遍代码修改修改此处使用了对象进行操作，遍历，替换相应的值，删除原来的再重新设置一遍即可。至此，我们可以在的中来进行配置，解决开发环境下丢失的问题。问题最近项目对接口进行安全改造,需要用到一个Path=/XXX/的cookie值,但是本地开发环境会出现cookie丢失的问题,因为本地开发环境目录都是http://localhost:8000/h...

thekingisalwaysluc 2019-08-22 15:25 评论0 收藏0
基于gulp，webpack实现灵活的 livereload 服务

摘要：假设后台使用端口，我们使用模式需要如下配置现在可以启动服务了，但同时请求也要修改为这样才能进行热加载。 webpack 提供了 webpack-dev-server 可以实现高效的页面自动刷新，但是这个 server 有一点局限性：虽然可以做为 server 中间件使用，但本身不提供其它资源的静态服务对于打包文件以外的变化它是无知的，也就无法去刷新如果是自己的页面需要引入 sc...

vboy1010 2019-08-21 10:44 评论0 收藏0