Vue-cli3.x + axios 跨域方案踩坑指北

這篇文章主要介紹了Vue-cli3.x + axios 跨域方案踩坑指北,文中通過示例代碼介紹的非常詳細,對大家的學習或者工作具有一定的參考學習價值,需要的朋友們下面隨着小編來一起學習學習吧

緣起

最近實驗課上需要重構以前寫過的一個項目(垃圾堆),需要添加發生郵件提醒的功能,記得以前寫過一個PHP版的實現,所以想把PHP寫的功能整理成一個服務,然後在前端調用。但是這個項目是JavaWeb,也就是說我需要面對跨域的問題。不過本篇文章,講的並不是如何解決這樣的跨域問題,而是我在找如何解決這個問題的路上遇到的坑。

其實,在前端工程化大行其道的現在,前後端已經分離開來,前端爲了提高工作流效率往往自己開一個小型的服務器,就比如webpack.devServer。這樣在前端調用後端接口的時候必然會面臨跨域的問題,如題,Vue-cli 3.x + axios 跨域方案 就是解決這裏的跨域問題。這裏的跨域是基於webpack的devServer的代理功能(proxy)來實現開發環境中的跨域,也就是說本篇所討論的並不能解決生產環境下的跨域問題,因爲webpack.devServer是DevDependencies,一旦打包上線,這個proxy代理就會失效。但是這並不妨礙我們開發中使用跨域來提高開發效率和體驗。

開始填坑

其實這個問題解決起來很簡單,網上也是很多教程,爲了文章完整性,我這裏也做一個儘量完備的展示,介紹如何配置Vue-cli 3.x來實現跨域 。

vue.config.js中devServer.proxy的配置解析

Vue-cli3.x比Vue-cli2.x構建的項目要簡化很多,根目錄下只有./src和./public文件夾,所以網上很多教程說config目錄下的vue.config.js是說的vue-cli 2.x版本。那麼對於Vue-cli 3.x版本,構建也很簡單,直接在根目錄裏建一個vue.config.js配置文件就可以了,我們直接看devServer.proxy裏的代碼:

我這裏devServer的地址是:localhost:8080/,需要代理的地址是:localhost/index/phpinfo.php (我自己寫的一個測試跨域用的php,返回一個‘ok')

下面是根據上面的地址需要配置的proxy對象

devServer : {
    proxy : {
      '/index' : {
        target : 'http://localhost/index',
        // ws : true,
        changeOrigin : true,
        pathRewrite : {
          '^/index' : ''
        }
      }
    }
  }

大部分教程到這裏就停止了,但是我在這裏做一個擴展,爲了讓讀者理解這裏的配置是如何起作用的(以下內容整理自http-proxy-middleware的npm描述裏,http-proxy-middleware是一個npm模塊,是proxy的底層原理實現)。

     foo://example.com:8042/over/there?name=ferret#nose
     \_/  \______________/\_________/ \_________/ \__/
     |      |      |      |    |
    scheme   authority    path    query  fragment

以我上面的配置爲例,'/index'這個key在http-proxy-middleware中被稱爲context——用來決定哪些請求需要被target對應的主機地址(這裏是http://localhost/index)代理,它可以是 字符串,含有通配符的字符串,或是一個數組,分別對應於path matching(路徑匹配)wildcard path matching(通配符路徑匹配)multiple path matching(多路徑匹配),而這裏的path指的就是上圖所標識的path段。

簡言之,這個key就是匹配path的,一旦匹配到符合的path,就會把請求轉發的代理主機去,而代理主機的地址就是target字段對應的內容。

那pathRewrit是什麼意思呢?意如其名,路徑重寫。就是把模式(這裏是^/index)匹配到的path重寫爲對應的路徑(這裏是'',相當於刪除了這個匹配到的路徑)。除了刪除,還有在原有路徑上添加一個基礎路徑,或是改寫一個路徑的方式,這可以參考http-proxy-middleware的npm描述的option.pathRewrite章節

在Vue中使用axios

這個使用任意一個ajax封裝的庫都是可行的,axios,jquery.ajax或者是vue-resource都是可以的。

在Vue中使用axios,網上有兩種方法,一種是將axios加入Vue的原型裏,我更推薦第二種方法:

npm install axios vue-axios
import axios from 'axios';
import VueAxios from 'vue-axios';
Vue.use(VueAxios,axios);

以我上面的proxy配置爲基礎,想要讓代理成功轉發到localhost/index/phpinfo.php,在Vue實例中axios需要這樣寫訪問地址:

this.axios.get('/index/phpinfo.php').then((res)=>{
    console.log(res);
   })

我們來分析這些代碼整個發揮作用的原理是什麼?首先,axios去訪問/index/phpinfo.php,這是個相對地址,所以真實訪問地址其實是localhost:8080/index/phpinfo.php,然而/index/phpinfo.php被我們配置的/index匹配到了 ,所以訪問被proxy代理,那轉發到哪個路徑呢?在pathRewrite中,我們將模式^/index的路徑清除了,所以最終的訪問路徑是 target+pathRewrite+ 剩餘的部分 , 這樣也就是 http://localhost/index++/phpinfo.php

坑點

可能出現即使配置了proxy,但是依然沒有任何卵用。

  • 大部分情況是因爲你的proxy配置和你的訪問路徑不匹配,或者即使匹配到了,但是轉發出去的地址不對,沒有命中後端給的API
  • 或者看看axios,有沒有使用正確姿勢?
  • 還有一點,或許你看到返回的response裏的url依然顯示的是本地主機,但是數據已經正常返回,這是正常的,因爲我們訪問的本來就是本地主機,只不過proxy轉發了這個請求到一個新的地址。

後續

本篇只解決了開發環境下的跨域問題,實際線上還不能跨域,目前這裏有一些方案:

  1. Nginx反向代理跨域
  2. JSONP
  3. CORS

下一次討論這個跨域問題,嘗試解決。

以上就是本文的全部內容,希望對大家的學習有所幫助,也希望大家多多支持神馬文庫。

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章