技術文章 » 解析vue中axios的封裝請求（附步驟程式碼）

解析vue中axios的封裝請求（附步驟程式碼）

2022-08-10 14:02:28

一、簡介

axios 是一個輕量的HTTP使用者端，它基於 XMLHttpRequest 服務來執行 HTTP 請求，支援豐富的設定，支援 Promise，支援瀏覽器端和 Node.js 端。自Vue2.0起，尤大大宣佈取消對vue-resource 的官方推薦，轉而推薦 axios。現在 axios 已經成為大部分 Vue 開發者的首選。（ 如果你還不熟悉 axios，可以在這裡檢視它的API。）【相關推薦：】

封裝前，先來看下，不封裝的情況下，一個實際專案中axios請求的樣子。

大概是長這樣：

axios('http://localhost:3000/data', {
  method: 'GET',
  timeout: 1000,
  withCredentials: true,
  headers: {
    'Content-Type': 'application/json',
    Authorization: 'xxx',
  },
  transformRequest: [function (data, headers) {
    return data;
  }],
  // 其他請求設定...
})
.then((data) => {
  // todo: 真正業務邏輯程式碼
  console.log(data);
}, (err) => {
  if (err.response.status === 401) {
  // handle authorization error
  }
  if (err.response.status === 403) {
  // handle server forbidden error
  }
  // 其他錯誤處理.....
  console.log(err);
});

可以看到在這段程式碼中，頁面程式碼邏輯只在第15行處，上方的一大塊請求設定程式碼和下方一大塊響應錯誤處理程式碼，幾乎跟頁面功能沒有關係，而且每個請求中這些內容都差不多，甚至有的部分完全一樣。

二、封裝後

1.封裝步驟

封裝的本質就是在待封裝的內容外面新增各種東西，然後把它們作為一個新的整體呈現給使用者，以達到擴充套件和易用的目的。

封裝 axios 要做的事情，就是把所有HTTP請求共用的設定，事先都在axios上設定好，預留好必要的引數和介面，然後把它作為新的axios返回。

目錄結構如下(由Vue-cli 3.0 生成)：

|--public/
|--mock/
| |--db.json # 我新建的介面模擬資料
|--src/
| |--assets/
| |--components/
| |--router/
| |--store/
| |--views/
| |--Home.Vue
| |--App.vue
| |--main.js
| |--theme.styl
|--package.json
|...

2.封裝目標

在 Home 頁，發起 axios 請求時就像呼叫一個只有少量引數的方法一樣簡單，這樣我就可以專注業務程式碼了。

1. 將 axios 封裝到一個獨立的檔案

  • 在src下建立 utils/http.js 檔案
  cd src
  mkdir utils
  touch http.js
  • 引入 axios
  // src/utils/http.js
  import axios from 'axios';
  • 建立一個類
  //src/utils/http.js
  //...
  class NewAxios {
  
  }
  • 給不同環境設定不同請求地址

根據process.env.NODE_ENV 設定不同的 baseURL，使專案只需執行相應打包命令，就可以在不同環境中自動切換請求主機地址。

// src/utils/http.js

//...
const getBaseUrl = (env) => {
  let base = {
    production: '/',
    development: 'http://localhost:3000',
    test: 'http://localhost:3001',
  }[env];
  if (!base) {
    base = '/';
  }
  return base;
};

class NewAxios {
  constructor() {
    this.baseURL = getBaseUrl(process.env.NODE_ENV);
  }
}
  • 設定超時時間

timeout屬性，我一般設定10秒。

// src/utils/http.js

//...
class NewAxios {
  constructor() {
    //...
    this.timeout = 10000;
  }
}
  • 設定允許攜帶憑證

widthCredentials屬性設為true

// src/utils/http.js

//...
class NewAxios {
  constructor() {
    //...
    this.withCredentials = true;
  }
}
  • 給這個類建立範例上的方法request

在 request 方法裡，建立新的axios範例，接收請求設定引數，處理引數，新增設定，返回axios範例的請求結果（一個promise物件）。

你也可以不建立，直接使用預設匯出的axios範例，然後把所有設定都放到它上面，不過這樣一來整個專案就會共用一個axios範例。雖然大部分專案下這樣夠用沒問題，但是有的專案中不同服務地址的請求和響應結構可能完全不同，這個時候共用一個範例就沒辦法支援了。所以為了封裝可以更通用，更具靈活性，我會使用axios的create方法，使每次發請求都是新的axios範例。

// src/utils/http.js

//...
class NewAxios {
  //...
  request(options) {
    // 每次請求都會建立新的axios範例。
    const instance = axios.create();
    const config = { // 將使用者傳過來的引數與公共設定合併。
      ...options,
      baseURL: this.baseURL,
      timeout: this.timeout,
      withCredentials: this.withCredentials,
    };
    // 設定攔截器，支援根據不同url設定不同的攔截器。
    this.setInterceptors(instance, options.url);
    return instance(config); // 返回axios範例的執行結果
  }
}

因為攔截器設定內容比較多，所以封裝成一個內部函數了。

  • 設定請求攔截器

在傳送請求前對請求引數做的所有修改都在這裡統一設定。比如統一新增token憑證、統一設定語言、統一設定內容型別、指定資料格式等等。做完後記得返回這個設定，否則整個請求不會進行。

我這裡就設定一個token。

// src/utils/http.js

//...
class NewAxios {
  //...
  // 這裡的url可供你針對需要特殊處理的介面路徑設定不同攔截器。
  setInterceptors = (instance, url) => { 
    instance.interceptors.request.use((config) => { // 請求攔截器
      // 設定token
      config.headers.AuthorizationToken = localStorage.getItem('AuthorizationToken') || '';
      return config;
    }, err => Promise.reject(err));
  }
  //...
}
  • 設定響應攔截器

在請求的then或catch處理前對響應資料進行一輪預先處理。比如過濾響應資料，更多的，是在這裡對各種響應錯誤碼進行統一錯誤處理，還有斷網處理等等。

我這裡就判斷一下403和斷網。

// src/utils/http.js

//...
class NewAxios {
  //...
  setInterceptors = (instance, url) => {
    //...
    instance.interceptors.response.use((response) => { // 響應攔截器
      // todo: 想根據業務需要，對響應結果預先處理的，都放在這裡
      console.log();
      return response;
    }, (err) => {
      if (err.response) { // 響應錯誤碼處理
        switch (err.response.status) {
          case '403':
            // todo: handler server forbidden error
            break;
            // todo: handler other status code
          default:
            break;
        }
        return Promise.reject(err.response);
      }
      if (!window.navigator.online) { // 斷網處理
        // todo: jump to offline page
        return -1;
      }
      return Promise.reject(err);
    });
  }
  //...
}

另外，在攔截器裡，還適合放置loading等緩衝效果：在請求攔截器裡顯示loading，在響應攔截器裡移除loading。這樣所有請求就都有了一個統一的loading效果。

  • 預設匯出新的範例
  // src/utils/http.js
  
  //...
  export default new NewAxios();

最後完整的程式碼如下：

// src/utils/http.js

import axios from 'axios';

const getBaseUrl = (env) => {
  let base = {
    production: '/',
    development: 'http://localhost:3000',
    test: 'http://localhost:3001',
  }[env];
  if (!base) {
    base = '/';
  }
  return base;
};

class NewAxios {
  constructor() {
    this.baseURL = getBaseUrl(process.env.NODE_ENV);
    this.timeout = 10000;
    this.withCredentials = true;
  }

  // 這裡的url可供你針對需要特殊處理的介面路徑設定不同攔截器。
  setInterceptors = (instance, url) => {
    instance.interceptors.request.use((config) => {
      // 在這裡新增loading
      // 設定token
      config.headers.AuthorizationToken = localStorage.getItem('AuthorizationToken') || '';
      return config;
    }, err => Promise.reject(err));

    instance.interceptors.response.use((response) => {
      // 在這裡移除loading
      // todo: 想根據業務需要，對響應結果預先處理的，都放在這裡
      return response;
    }, (err) => {
      if (err.response) { // 響應錯誤碼處理
        switch (err.response.status) {
          case '403':
            // todo: handler server forbidden error
            break;
            // todo: handler other status code
          default:
            break;
        }
        return Promise.reject(err.response);
      }
      if (!window.navigator.online) { // 斷網處理
        // todo: jump to offline page
        return -1;
      }
      return Promise.reject(err);
    });
  }

  request(options) {
    // 每次請求都會建立新的axios範例。
    const instance = axios.create();
    const config = { // 將使用者傳過來的引數與公共設定合併。
      ...options,
      baseURL: this.baseURL,
      timeout: this.timeout,
      withCredentials: this.withCredentials,
    };
    // 設定攔截器，支援根據不同url設定不同的攔截器。
    this.setInterceptors(instance, options.url);
    return instance(config); // 返回axios範例的執行結果
  }
}

export default new NewAxios();

現在 axios 封裝算是完成了80%。我們還需要再進一步把axios和介面結合再封裝一層，才能達到我在一開始定的封裝目標。

3. 使用新的 axios 封裝API

  • 在 src 目錄下新建 api 資料夾。把所有涉及HTTP請求的介面統一集中到這個目錄來管理。
  • 新建 home.js。我們需要把介面根據一定規則分好類，一類介面對應一個js檔案。這個分類可以是按頁面來劃分，或者按模組等等。為了演示更直觀，我這裡就按頁面來劃分了。實際根據自己的需求來定。
  • 使用新的 axios 封裝API（固定url的值，合併使用者傳過來的引數），然後命名匯出這些函數。
// src/api/home.js 

import axios from '@/utils/http';
export const fetchData = options => axios.request({
  ...options,
  url: '/data',
});
export default {};

在 api 目錄下新建 index.js，把其他檔案的介面都在這個檔案裡彙總匯出。

 // src/api/index.js
  
  export * from './home';

這層封裝將我們的新的axios封裝到了更簡潔更語意化的介面方法中。

現在我們的目錄結構長這樣：

|--public/
|--mock/
| |--db.json # 介面模擬資料
|--src/
| |--api/ # 所有的介面都集中在這個目錄下
| |--home.js # Home頁面裡涉及到的介面封裝在這裡
| |--index.js # 專案中所有介面呼叫的入口
| |--assets/
| |--components/
| |--router/
| |--store/
| |--utils/
| |--http.js # axios封裝在這裡
| |--views/
| |--Home.Vue
| |--App.vue
| |--main.js
| |--theme.styl
|--package.json
|...

4.使用封裝後的axios

現在我們要發HTTP請求時，只需引入 api 下的 index.js 檔案就可以呼叫任何介面了，並且用的是封裝後的 axios。

// src/views/Home.vue

<template>
  <div class="home">
    <h1>This is home page</h1>
  </div>
</template>

<script>
// @ is an alias to /src
import { fetchData } from '@/api/index';

export default {
  name: 'home',
  mounted() {
    fetchData()  // axios請求在這裡
      .then((data) => {
        console.log(data);
      })
      .catch((err) => {
        console.log(err);
      });
  },
};
</script>

axios請求被封裝在fetchData函數裡，頁面請求壓根不需要出現任何axios API，悄無聲息地發起請求獲取響應，就像在呼叫一個簡單的 Promise 函數一樣輕鬆。並且在頁面中只需專注處理業務功能，不用被其他事物干擾。

以上就是解析vue中axios的封裝請求（附步驟程式碼）的詳細內容，更多請關注TW511.COM其它相關文章！