Webpack-dev-server的proxy用法

時間 2019-11-06

標籤 webpack dev server proxy 用法简体版

原文原文鏈接

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

使用二

若是你想要代碼多個路徑代理到同一個target下, 你可使用由一個或多個「具備 context 屬性的對象」構成的數組：vue

module.exports = {
    //...
    devServer: {
        proxy: [{
            context: ['/auth', '/api'],
            target: 'http://localhost:3000',
        }]
    }
};

使用三:

若是你不想始終傳遞 /api ，則須要重寫路徑：node

module.exports = {
    //...
    devServer: {
        proxy: {
            '/api': {
                target: 'http://localhost:3000',
                pathRewrite: {'^/api' : ''}
            }
        }
    }
};

請求到 /api/xxx 如今會被代理到請求 http://localhost:3000/xxx, 例如 /api/user 如今會被代理到請求 http://localhost:3000/userwebpack

使用四:

默認狀況下，不接受運行在 HTTPS 上，且使用了無效證書的後端服務器。若是你想要接受，只要設置 secure: false 就行。修改配置以下：nginx

module.exports = {
    //...
    devServer: {
        proxy: {
            '/api': {
                target: 'https://other-server.example.com',
                secure: false
            }
        }
    }
};

使用五:

有時你不想代理全部的請求。能夠基於一個函數的返回值繞過代理。
在函數中你能夠訪問請求體、響應體和代理選項。必須返回 false 或路徑，來跳過代理請求。git

例如：對於瀏覽器請求，你想要提供一個 HTML 頁面，可是對於 API 請求則保持代理。你能夠這樣作：github

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, 本地就會虛擬一個服務器接收你的請求並代你發送該請求,web

module.exports = {
    //...
    devServer: {
        proxy: {
            '/api': {
                target: 'http://localhost:3000',
                changeOrigin: true,
            }
        }
    }
};

vue-cli中proxyTable配置接口地址代理示例

修改 config/index.jsvue-cli

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
}