devServer 配置
注意
本机服务端口默认:localhost:8080
本地运行时开发环境接口地址可写作localhost:8080/phalapi/login
也可写作/phalapi/login,两者均可.
1.代理
proxy: {
'/phalapi':{ // 要替换的位置
target: 'http://www.abc.com' // 被替换的目标地址
}
说明:
- 初始地址
localhost:8080/phalapi/login的请求会被代理到http://www.abc.com/phalapi/login
2.secure
proxy: {
'/phalapi':{ // 要替换的位置
target:'http://www.abc.com', // 被替换的目标地址
secure:true // 接受对方是https的接口
}
3.changeOrigin
proxy: {
'/phalapi':{ // 要替换的位置
target:'http://www.abc.com', // 被替换的目标地址
secure:true, // 接受对方是https的接口
changeOrigin:true // 是否需要跨域
}
4.pathRewrite
proxy: {
'/phalapi':{ // 要替换的位置
target:'http://www.abc.com', // 被替换的目标地址
secure:true, // 接受对方是https的接口
changeOrigin:true, // 是否需要跨域
pathRewrite: {
'^/phalapi':''
}
}
说明:
- 路径重写: 例如
localhost:8080/phalapi/login经过代理后会变为http://www.abc.com/login,前面的/phalapi就被替换为空了
更多配置
如果拥有单独的后端开发服务器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: {
// 例如将'/api/xxx'代理到'https://yuan920.github.io/api/xxx'
'/api': {
target: 'https://yuan920.github.io', // 接口的域名
secure: false, // 如果是https接口，需要配置这个参数
changeOrigin: true, // 如果接口跨域，需要进行这个参数配置
},
// 例如将'/abc/xxx'代理到'https://yuan920.github.io/xxx'
'/abc': {
target: 'https://yuan920.github.io', // 接口的域名
secure: false, // 如果是https接口，需要配置这个参数
changeOrigin: true, // 如果接口跨域，需要进行这个参数配置
pathRewrite: {'^/abc': ''} // pathRewrite 来重写地址，将前缀 '/abc' 转为 ''。
}
},
// 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的源码和文档
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
使用中的注意要点：
使用fastmock模拟后端接口时，发现同样的三个接口，其中一个可以代理，另外两个不能代理，让人不能理解，具体配置方式如下所示：
devServer: {
// development server port 8000
port: '8000', // 开发模式默认端口
proxy: {
'/api': {
target: 'http://10.203.13.66:8030', //实际的api地址
ws: false,
changeOrigin: true,
pathRewrite: {
'^/api': '/'
}
},
'/ceshi': {
target: 'https://www.fastmock.site/mock/e35a162557a2455f8ba553a72aae693c',
ws: false,
changeOrigin: true,
pathRewrite: {
'/ceshi': '/'
}
}
}
}
