今天遇到一個(gè)項(xiàng)目中输拇,服務(wù)那邊使用的是roadhog阿里出品的打包工具
服務(wù)中配置了proxy 順便看了一下proxy的文檔幢哨。 記錄一下;希望幫助到有需要的小伙伴吧奕翔;
當(dāng)你擁有單獨(dú)的API后端開發(fā)服務(wù)器并且希望在同一域上發(fā)送API請(qǐng)求時(shí)哥放,代理某些URL可能會(huì)很有用牍鞠。
1.正常使用
proxy: {
'/api':{ // 這個(gè)是你要替換的位置
target: 'http://www.baidu.com'//這個(gè)是被替換的目標(biāo)地址
}
比如我們有一個(gè)接口請(qǐng)求為叫做 localhost:8081/api/query
那會(huì)將請(qǐng)求代理到http://www.baidu.com/api/query
上面咖摹;
就是我們接口中有/api的字段 就會(huì)匹配到代理上面;
2. secure的使用
proxy: {
'/api':{ // 這個(gè)是你要替換的位置
target: 'http://www.baidu.com',//這個(gè)是被替換的目標(biāo)地址
secure:true //接受對(duì)方是https的接口
}
默認(rèn)情況下 secure為false难述, 是不接受轉(zhuǎn)發(fā)到https的接口的萤晴。 需要支持的話 配置成true即可
3. changeOrigin的使用
proxy: {
'/api':{ // 這個(gè)是你要替換的位置
target: 'http://www.baidu.com',//這個(gè)是被替換的目標(biāo)地址
secure:true ,//接受對(duì)方是https的接口
changeOrigin:true // 是否需要跨域
}
是否需要支持跨域處理
4. pathRewrite的使用
proxy: {
'/api':{ // 這個(gè)是你要替換的位置
target: 'http://www.baidu.com',//這個(gè)是被替換的目標(biāo)地址
secure:true ,//接受對(duì)方是https的接口
changeOrigin:true ,// 是否需要跨域
pathRewrite: {'^/api' : ''}
}
通過名字就知道了 這個(gè)是路徑重寫的意思吐句;如果我們接口中不需要/api
的話 就可以通過這個(gè)進(jìn)行重寫
例子: 發(fā)起請(qǐng)求接口localhose:8081/api/query
進(jìn)過代理的話 他調(diào)用的請(qǐng)求 就會(huì)被重寫成 www.baidu.com/query
配置的/api
就沒了;
初次學(xué)習(xí)使用 店读;如有不對(duì)的地方歡迎指正嗦枢;
前言
如果你有單獨(dú)的后端開發(fā)服務(wù)器 API,并且希望在同域名下發(fā)送 API 請(qǐng)求 屯断,那么代理某些 URL 會(huì)很有用文虏。
解決開發(fā)環(huán)境的跨域問題(不用在去配置nginx和host, 爽歪歪~~)
在webpack.config.js中配置
下面簡單介紹一下五個(gè)經(jīng)常使用的場(chǎng)景
使用一:
mmodule.exports = {
//...
devServer: {
proxy: {
'/api': 'http://localhost:3000'
}
}
};
請(qǐng)求到 /api/xxx 現(xiàn)在會(huì)被代理到請(qǐng)求 http://localhost:3000/api/xxx, 例如 /api/user 現(xiàn)在會(huì)被代理到請(qǐng)求 http://localhost:3000/api/user
使用二
如果你想要代碼多個(gè)路徑代理到同一個(gè)target下, 你可以使用由一個(gè)或多個(gè)「具有 context 屬性的對(duì)象」構(gòu)成的數(shù)組:
module.exports = {
//...
devServer: {
proxy: [{
context: ['/auth', '/api'],
target: 'http://localhost:3000',
}]
}
};
使用三:
如果你不想始終傳遞 /api ,則需要重寫路徑:
module.exports = {
//...
devServer: {
proxy: {
'/api': {
target: 'http://localhost:3000',
pathRewrite: {'^/api' : ''}
}
}
}
};
請(qǐng)求到 /api/xxx 現(xiàn)在會(huì)被代理到請(qǐng)求 http://localhost:3000/xxx, 例如 /api/user 現(xiàn)在會(huì)被代理到請(qǐng)求 http://localhost:3000/user
使用四:
默認(rèn)情況下殖演,不接受運(yùn)行在 HTTPS 上氧秘,且使用了無效證書的后端服務(wù)器。如果你想要接受趴久,只要設(shè)置 secure: false 就行丸相。修改配置如下:
module.exports = {
//...
devServer: {
proxy: {
'/api': {
target: 'https://other-server.example.com',
secure: false
}
}
}
};
使用五:
有時(shí)你不想代理所有的請(qǐng)求”斯鳎可以基于一個(gè)函數(shù)的返回值繞過代理灭忠。
在函數(shù)中你可以訪問請(qǐng)求體、響應(yīng)體和代理選項(xiàng)座硕。必須返回 false 或路徑弛作,來跳過代理請(qǐng)求。
例如:對(duì)于瀏覽器請(qǐng)求华匾,你想要提供一個(gè) HTML 頁面映琳,但是對(duì)于 API 請(qǐng)求則保持代理。你可以這樣做:
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';
}
}
}
}
}
};
解決跨域原理
上面的參數(shù)列表中有一個(gè)changeOrigin參數(shù), 是一個(gè)布爾值, 設(shè)置為true, 本地就會(huì)虛擬一個(gè)服務(wù)器接收你的請(qǐng)求并代你發(fā)送該請(qǐng)求,
module.exports = {
//...
devServer: {
proxy: {
'/api': {
target: 'http://localhost:3000',
changeOrigin: true,
}
}
}
};
vue-cli中proxyTable配置接口地址代理示例
修改 config/index.js
module.exports = {
dev: {
// 靜態(tài)資源文件夾
assetsSubDirectory: 'static',
// 發(fā)布路徑
assetsPublicPath: '/',
// 代理配置表瘦真,在這里可以配置特定的請(qǐng)求代理到對(duì)應(yīng)的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接口刊头,需要配置這個(gè)參數(shù)
changeOrigin: true, // 如果接口跨域,需要進(jìn)行這個(gè)參數(shù)配置
},
// 例如將'localhost:8080/img/xxx'代理到'https://cdn.wangyaxing.cn/xxx'
'/img': {
target: 'https://cdn.wangyaxing.cn', // 接口的域名
secure: false, // 如果是https接口诸尽,需要配置這個(gè)參數(shù)
changeOrigin: true, // 如果接口跨域原杂,需要進(jìn)行這個(gè)參數(shù)配置
pathRewrite: {'^/img': ''} // pathRewrite 來重寫地址,將前綴 '/api' 轉(zhuǎn)為 '/'您机。
}
},
// 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
}
更多參數(shù)
dev-server 使用了非常強(qiáng)大的 http-proxy-middleware , http-proxy-middleware 基于 http-proxy 實(shí)現(xiàn)的穿肄,可以查看 http-proxy 的源碼和文檔:https://github.com/nodejitsu/node-http-proxy 。
target:要使用url模塊解析的url字符串
forward:要使用url模塊解析的url字符串
agent:要傳遞給http(s).request的對(duì)象(請(qǐng)參閱Node的https代理和http代理對(duì)象)
ssl:要傳遞給https.createServer()的對(duì)象
ws:true / false际看,是否代理websockets
xfwd:true / false咸产,添加x-forward標(biāo)頭
secure:true / false,是否驗(yàn)證SSL Certs
toProxy:true / false仲闽,傳遞絕對(duì)URL作為路徑(對(duì)代理代理很有用)
prependPath:true / false脑溢,默認(rèn)值:true - 指定是否要將目標(biāo)的路徑添加到代理路徑
ignorePath:true / false,默認(rèn)值:false - 指定是否要忽略傳入請(qǐng)求的代理路徑(注意:如果需要,您必須附加/手動(dòng))屑彻。
localAddress:要為傳出連接綁定的本地接口字符串
changeOrigin:true / false验庙,默認(rèn)值:false - 將主機(jī)標(biāo)頭的原點(diǎn)更改為目標(biāo)URL
使用中的注意要點(diǎn):
使用fastmock模擬后端接口時(shí),發(fā)現(xiàn)同樣的三個(gè)接口社牲,其中一個(gè)可以代理粪薛,另外兩個(gè)不能代理,讓人不能理解搏恤,具體配置方式如下所示:
devServer: {
// development server port 8000
port: '8000', // 開發(fā)模式默認(rèn)端口
proxy: {
'/api': {
target: 'http://10.203.13.66:8030', //實(shí)際的api地址
ws: false,
changeOrigin: true,
pathRewrite: {
'^/api': '/'
}
},
'/ceshi': {
target: 'https://www.fastmock.site/mock/e35a162557a2455f8ba553a72aae693c',
ws: false,
changeOrigin: true,
pathRewrite: {
'/ceshi': '/'
}
}
}
},