使用vue項目配置多個代理的註意點

Posted on by

在Vue項目的開發過程中,為瞭本地調試方便，我們通常會在 vue.config.js 中配置 devServer 來在本地啟動一個服務器，在這個選項中，我們會配置proxy 屬性來將指向到本地的請求（例如： /api/action） 代理到後端的開發服務器上（例如： http://xxx.xxx.xxx/api/action）

devServer: {
        port: 8081,
        proxy: {
            '/api/action': {
                target: 'http://192.168.200.106:81',
                changeOrigin: true,
                ws: true,
                secure: false
            }
        }
    },
​```

在這個配置中，要註意以下兩點：

接口地址有重疊地址時，將匹配度低的放在後面。

例如：

  1. * 將 / 匹配到 192.191.1.1;
  2. * 將 /api 匹配到 192.191.1.2
  3. * 將 /api/action 匹配到 192.191.1.3

如果我們像下面一樣書寫：

proxy: {
            '/': {
                target: 'http://192.191.1.1',
                changeOrigin: true,
                ws: true,
                secure: false
            },
    '/api': {
                target: 'http://192.191.1.2',
                changeOrigin: true,
                ws: true,
                secure: false
            },
    '/api/action': {
                target: 'http://192.191.1.3',
                changeOrigin: true,
                ws: true,
                secure: false
            }
        }

那麼所有到/, /api和 /api/action 的請求將全部被代理到 192.191.1.1 上面去

原因是這裡的匹配實際上是一個正則匹配的過程，當我們請求 /api 時，首先讀取到瞭配置項中的第一個，拿配置中的 / 去匹配請求中的 /api ， 發現請求的/api 中包含配置項/, 匹配成功，直接將請求代理到瞭 192.191.1.1 上面去， 對/api/action的匹配也同理。

也就是說，它的匹配規則是： 拿配置項中的地址去匹配請求中的地址，如果請求中的地址中包含配置中的地址，則匹配成功，否則，拿下一個配置項繼續匹配。

所以，配置中的地址與請求地址中匹配的字符越少，匹配度越低。 上例中配置中的地址（/）與請求地址（/api）隻有一個字符是匹配的，所以匹配度低。

所以我們正確的寫法應該是：

proxy: {
            '/api/action': {
                target: 'http://192.191.1.3',
                changeOrigin: true,
                ws: true,
                secure: false
            },
    '/api': {
                target: 'http://192.191.1.2',
                changeOrigin: true,
                ws: true,
                secure: false
            },
    '/': {
                target: 'http://192.191.1.1',
                changeOrigin: true,
                ws: true,
                secure: false
            }
        }

這樣到三個地址的請求就都可以正確代理到相應的地址去瞭

多個地址代理同一個target 時，可進行合並

在實際應用中，由於後端采用微服務模式開發，在開發階段，我們可能會將不同的服務代理到不同的地址上，當服務很多時，我們代理的數量也就很多：

proxy: {
  		'/api/action': {
                target: 'http://192.191.1.3',
                changeOrigin: true,
                ws: true,
                secure: false
            },
              '/api/action2': {
                target: 'http://192.191.1.4',
                changeOrigin: true,
                ws: true,
                secure: false
            },
              '/api/action3': {
                target: 'http://192.191.1.3',
                changeOrigin: true,
                ws: true,
                secure: false
            },
              '/api/action4': {
                target: 'http://192.191.1.4',
                changeOrigin: true,
                ws: true,
                secure: false
            },
              '/api/action5': {
                target: 'http://192.191.1.5',
                changeOrigin: true,
                ws: true,
                secure: false
            },
              '/api/action6': {
                target: 'http://192.191.1.6',
                changeOrigin: true,
                ws: true,
                secure: false
            },
              '/api/action7': {
                target: 'http://192.191.1.5',
                changeOrigin: true,
                ws: true,
                secure: false
            },
              '/api/action8': {
                target: 'http://192.191.1.6',
                changeOrigin: true,
                ws: true,
                secure: false
            },
              '/api/action9': {
                target: 'http://192.191.1.7',
                changeOrigin: true,
                ws: true,
                secure: false
            },
			 '/api': {
                target: 'http://192.191.1.2',
                changeOrigin: true,
                ws: true,
                secure: false
            },
			 '/': {
                target: 'http://192.191.1.1',
                changeOrigin: true,
                ws: true,
                secure: false
            },              
        }

當配置的代理數量超過十個時，開發環境編譯打包時會報以下錯誤：

在這裡插入圖片描述

為瞭解決報錯，也同時減少代碼體積，我們可以對具有同一個target的配置項進行合並，由上文我們可知，這裡其實是一個正則匹配的過程，那我們就可以利用正則語法將他們進行合並：

proxy: {
  		'/api/action|/api/action3': {
                target: 'http://192.191.1.3',
                changeOrigin: true,
                ws: true,
                secure: false
            },
              '/api/action2|/api/action4'': {
                target: 'http://192.191.1.4',
                changeOrigin: true,
                ws: true,
                secure: false
            },
             
              '/api/action5|/api/action7': {
                target: 'http://192.191.1.5',
                changeOrigin: true,
                ws: true,
                secure: false
            },
              '/api/action6|/api/action8': {
                target: 'http://192.191.1.6',
                changeOrigin: true,
                ws: true,
                secure: false
            },
              '/api/action9': {
                target: 'http://192.191.1.7',
                changeOrigin: true,
                ws: true,
                secure: false
            },
			 '/api': {
                target: 'http://192.191.1.2',
                changeOrigin: true,
                ws: true,
                secure: false
            },
			 '/': {
                target: 'http://192.191.1.1',
                changeOrigin: true,
                ws: true,
                secure: false
            },              
        }

當然，在正式部署的時候，還是需要後端去做統一代理。

以上為個人經驗，希望能給大傢一個參考，也希望大傢多多支持WalkonNet。

推薦閱讀：