Webpack-dev-server的proxy用法

Lin_R 發(fā)布于2019-08-23 11:50 / 458人閱讀

摘要：原文首次發(fā)表在的用法前言如果你有多帶帶的后端開發(fā)服務(wù)器，并且希望在同域名下發(fā)送請求，那么代理某些會(huì)很有用?？梢曰谝粋€(gè)函數(shù)的返回值繞過代理。要為傳出連接綁定的本地接口字符串，默認(rèn)值將主機(jī)標(biāo)頭的原點(diǎn)更改為目標(biāo)參考官方文檔

原文首次發(fā)表在: Webpack-dev-server的proxy用法

前言

如果你有多帶帶的后端開發(fā)服務(wù)器 API，并且希望在同域名下發(fā)送 API 請求，那么代理某些 URL 會(huì)很有用。

解決開發(fā)環(huán)境的跨域問題(不用在去配置nginx和host, 爽歪歪~~)

在webpack.config.js中配置

下面簡單介紹一下五個(gè)經(jīng)常使用的場景

使用一:

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

請求到 /api/xxx 現(xiàn)在會(huì)被代理到請求 http://localhost:3000/api/xxx, 例如 /api/user 現(xiàn)在會(huì)被代理到請求 http://localhost:3000/api/user

使用二

如果你想要代碼多個(gè)路徑代理到同一個(gè)target下, 你可以使用由一個(gè)或多個(gè)「具有 context 屬性的對象」構(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" : ""}
            }
        }
    }
};

請求到 /api/xxx 現(xiàn)在會(huì)被代理到請求 http://localhost:3000/xxx, 例如 /api/user 現(xiàn)在會(huì)被代理到請求 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í)你不想代理所有的請求。可以基于一個(gè)函數(shù)的返回值繞過代理。
在函數(shù)中你可以訪問請求體、響應(yīng)體和代理選項(xiàng)。必須返回 false 或路徑，來跳過代理請求。

例如：對于瀏覽器請求，你想要提供一個(gè) 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";
                    }
                }
            }
        }
    }   
};

解決跨域原理

上面的參數(shù)列表中有一個(gè)changeOrigin參數(shù), 是一個(gè)布爾值, 設(shè)置為true, 本地就會(huì)虛擬一個(gè)服務(wù)器接收你的請求并代你發(fā)送該請求,

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: "/",

    // 代理配置表，在這里可以配置特定的請求代理到對應(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/... 。

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標(biāo)頭
secure：true / false，是否驗(yàn)證SSL Certs
toProxy：true / false，傳遞絕對URL作為路徑（對代理代理很有用）
prependPath：true / false，默認(rèn)值：true - 指定是否要將目標(biāo)的路徑添加到代理路徑
ignorePath：true / false，默認(rèn)值：false - 指定是否要忽略傳入請求的代理路徑（注意：如果需要，您必須附加/手動(dòng)）。
localAddress：要為傳出連接綁定的本地接口字符串
changeOrigin：true / false，默認(rèn)值：false - 將主機(jī)標(biāo)頭的原點(diǎn)更改為目標(biāo)URL

參考

官方文檔

http-proxy-middleware

node-http-proxy

API Proxying During Development

云服務(wù)器 GPU云服務(wù)器 webpack-dev-server 的用法 cdn的用法 find的用法

文章版權(quán)歸作者所有，未經(jīng)允許請勿轉(zhuǎn)載,若此文章存在違規(guī)行為，您可以聯(lián)系管理員刪除。

轉(zhuǎn)載請注明本文地址：http://www.ezyhdfw.cn/yun/97545.html

發(fā)表評論

登陸后可評論

0條評論

Lin_R

男|高級講師

我要關(guān)注我要私信

TA的文章

tensorflow標(biāo)準(zhǔn)化

閱讀 2747·2023-04-26 02:44
極客業(yè)務(wù)架構(gòu)實(shí)戰(zhàn)營李運(yùn)華

閱讀 10018·2021-11-22 14:44
[C/C++]C++的IO流

閱讀 2190·2021-09-27 13:36
舍利云：linode月拋機(jī)上線，新加坡機(jī)房2核4G內(nèi)存80G ssd，100元/臺(tái)，附簡單測評

閱讀 2772·2021-09-08 10:43
display有哪些值與 position的值relative和absolute定位的原點(diǎn)是？

閱讀 760·2019-08-30 15:56
實(shí)現(xiàn)marquee滾動(dòng)效果

閱讀 1453·2019-08-30 15:55
用“五個(gè)為什么”寫CSS

閱讀 2940·2019-08-28 18:12
React Hook 不完全指南

閱讀 2900·2019-08-26 13:50

亚洲中字慕日产2020,大陆极品少妇内射AAAAAA,无码av大香线蕉伊人久久,久久精品国产亚洲av麻豆网站

資訊專欄INFORMATION COLUMN

上云采購季！| 2核2G4M爆款云服務(wù)器低至59元/年，更有多臺(tái)、長期優(yōu)惠，快來選購！

Webpack-dev-server的proxy用法

相關(guān)文章

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

webpack在前端項(xiàng)目中使用心得一二

**Webpack系列——關(guān)于Webpack-dev-server配置的點(diǎn)點(diǎn)滴滴**

本地開發(fā)環(huán)境cookie丟失?

基于gulp，webpack實(shí)現(xiàn)靈活的 livereload 服務(wù)

發(fā)表評論

0條評論

Lin_R

男|高級講師

TA的文章

tensorflow標(biāo)準(zhǔn)化

極客業(yè)務(wù)架構(gòu)實(shí)戰(zhàn)營李運(yùn)華

[C/C++]C++的IO流

舍利云：linode月拋機(jī)上線，新加坡機(jī)房2核4G內(nèi)存80G ssd，100元/臺(tái)，附簡單測評

display有哪些值與 position的值relative和absolute定位的原點(diǎn)是？

實(shí)現(xiàn)marquee滾動(dòng)效果

用“五個(gè)為什么”寫CSS

React Hook 不完全指南

最新活動(dòng)

資訊專欄INFORMATION COLUMN

上云采購季！| 2核2G4M爆款云服務(wù)器低至59元/年，更有多臺(tái)、長期優(yōu)惠，快來選購！

Webpack-dev-server的proxy用法

相關(guān)文章

發(fā)表評論

0條評論

男|高級講師

TA的文章

最新活動(dòng)

上云采購季！| 2核2G4M爆款云服務(wù)器低至59元/年，更有多臺(tái)、長期優(yōu)惠，快來選購！