開發階段前端往往跑在 localhost:8080,而後端介面在另一個網域,於是就遇到跨域。webpack 內建了 http-proxy-middleware,可以在開發伺服器上把請求轉發出去,從根本上避開這個問題。
瀏覽器的同源政策只作用在瀏覽器本身。如果請求是由 webpack-dev-server(Node 進程)代為發出,就不受限制。因此只要設定代理規則,讓前端請求先打到自己的 dev server,再由 dev server 轉送給真正的後端即可。
需要代理的 pathname 前要加上斜線。
module.exports = { devtool: 'cheap-module-source-map', entry: './app/js/index.js' output: { path: path.resolve(__dirname, 'dev'), // 所有輸出文件的目標路徑 filename: 'js/bundle.js', publicPath: '/', chunkFilename: '[name].chunk.js' }, devServer: { contentBase: path.resolve(__dirname, 'dev'), publicPath: '/', historyApiFallback: true, proxy: { // 請求到 '/device' 下 的請求都會被代理到 target: https://debug.xxx.com 中 '/device/*': { target: 'https://debug.xxx.com', secure: false, // 接受 運行在 https 上的服務 changeOrigin: true } } } }
兩個關鍵選項值得說明:secure: false 用於接受使用 https 但憑證不受信任的後端服務;changeOrigin: true 則會把請求標頭中的 Host 改為目標伺服器,多數後端在開啟了網域白名單驗證時需要這個設定才能通過。
注意:請求的網址必須以斜線開頭,否則不會被代理,而會直接打到本地服務。
fetch('/device/space').then(res => { // 被代理到 https://debug.xxx.com/device/space return res.json(); }).then(res => { console.log(res); }) fetch('device/space').then(res => { // https://localhost:8080/device/space 訪問本地服務 return res.json(); }).then(res => { console.log(res); })
若需要更彈意的轉發規則,可以用函式形式判斷:把 proxy 設為 function,依 req 的內容動態決定目標。另外,多個後端可以並存,例如把 /api 導向正式環境、/mock 導向本地 mock server,key 寫成陣列即可同時設定多組規則。
要特別提醒的是,proxy 只在開發伺服器有效,正式上線後沒有這層代理,跨域問題必須改由後端設定 CORS 標頭,或在同一網域下用反向代理(如 Nginx)處理。因此建議在程式碼中把介面前綴抽成環境變數,透過 process.env 或 webpack 的 DefinePlugin 切換,避免上線後還要逐處修改網址。