Webpack-dev-server的proxy用法

Lin_R 發布于2019-08-23 11:50 / 407人閱讀

摘要：原文首次發表在的用法前言如果你有多帶帶的后端開發服務器，并且希望在同域名下發送請求，那么代理某些會很有用。可以基于一個函數的返回值繞過代理。要為傳出連接綁定的本地接口字符串，默認值將主機標頭的原點更改為目標參考官方文檔

原文首次發表在: 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

云服務器 GPU云服務器 webpack-dev-server 的用法 cdn的用法 find的用法

文章版權歸作者所有，未經允許請勿轉載,若此文章存在違規行為，您可以聯系管理員刪除。

轉載請注明本文地址：http://specialneedsforspecialkids.com/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