Vue專案中封裝axios的方法

2022-05-31 22:00:22

一、axios是什麼

axios 是一個輕量的 HTTP使用者端

基於 XMLHttpRequest 服務來執行 HTTP 請求，支援豐富的設定，支援 Promise，支援瀏覽器端和 Node.js 端。自Vue2.0起，尤大宣佈取消對 vue-resource 的官方推薦，轉而推薦 axios。現在 axios 已經成為大部分 Vue 開發者的首選

特性

從瀏覽器中建立 XMLHttpRequests
從 node.js 建立 http請求
支援 Promise API
攔截請求和響應
轉換請求資料和響應資料
取消請求
自動轉換JSON 資料
使用者端支援防禦XSRF

基本使用

安裝

// 專案中安裝
npm install axios --S
// cdn 引入
<script src="https://unpkg.com/axios/dist/axios.min.js"></script>

匯入

import axios from 'axios'

傳送請求

axios({        
  url:'xxx',    // 設定請求的地址
  method:"GET", // 設定請求方法
  params:{      // get請求使用params進行引數憑藉,如果是post請求用data
    type: '',
    page: 1
  }
}).then(res => {  
  // res為後端返回的資料
  console.log(res);   
})

並行請求axios.all([])

function getUserAccount() {
    return axios.get('/user/12345');
}
function getUserPermissions() {
    return axios.get('/user/12345/permissions');
}
axios.all([getUserAccount(), getUserPermissions()])
    .then(axios.spread(function (res1, res2) { 
    // res1第一個請求的返回的內容，res2第二個請求返回的內容
    // 兩個請求都執行完成才會執行
}));

二、為什麼要封裝

axios 的 API 很友好，你完全可以很輕鬆地在專案中直接使用。

不過隨著專案規模增大，如果每發起一次HTTP請求，就要把這些比如設定超時時間、設定請求頭、根據專案環境判斷使用哪個請求地址、錯誤處理等等操作，都需要寫一遍

這種重複勞動不僅浪費時間，而且讓程式碼變得冗餘不堪，難以維護。為了提高我們的程式碼質量，我們應該在專案中二次封裝一下 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);
});

如果每個頁面都傳送類似的請求，都要寫一堆的設定與錯誤處理，就顯得過於繁瑣了

這時候我們就需要對axios進行二次封裝，讓使用更為便利

三、如何封裝

封裝的同時，你需要和後端協商好一些約定，請求頭，狀態碼，請求超時時間.......

設定介面請求字首：根據開發、測試、生產環境的不同，字首需要加以區分

請求頭 : 來實現一些具體的業務，必須攜帶一些引數才可以請求(例如：會員業務)

狀態碼: 根據介面返回的不同status ，來執行不同的業務，這塊需要和後端約定好

請求方法：根據get、post等方法進行一個再次封裝，使用起來更為方便

請求攔截器: 根據請求的請求頭設定，來決定哪些請求可以存取

響應攔截器：這塊就是根據後端`返回來的狀態碼判定執行不同業務

設定介面請求字首

利用node環境變數來作判斷，用來區分開發、測試、生產環境

if (process.env.NODE_ENV === 'development') {
  axios.defaults.baseURL = 'http://dev.xxx.com'
} else if (process.env.NODE_ENV === 'production') {
  axios.defaults.baseURL = 'http://prod.xxx.com'
}

在本地偵錯的時候，還需要在vue.config.js檔案中設定devServer實現代理轉發，從而實現跨域

devServer: {
    proxy: {
      '/proxyApi': {
        target: 'http://dev.xxx.com',
        changeOrigin: true,
        pathRewrite: {
          '/proxyApi': ''
        }
      }
    }
  }

設定請求頭與超時時間

大部分情況下，請求頭都是固定的，只有少部分情況下，會需要一些特殊的請求頭，這裡將普適性的請求頭作為基礎設定。當需要特殊請求頭時，將特殊請求頭作為引數傳入，覆蓋基礎設定

const service = axios.create({
    ...
    timeout: 30000,  // 請求 30s 超時
      headers: {
        get: {
          'Content-Type': 'application/x-www-form-urlencoded;charset=utf-8'
          // 在開發中，一般還需要單點登入或者其他功能的通用請求頭，可以一併設定進來
        },
        post: {
          'Content-Type': 'application/json;charset=utf-8'
          // 在開發中，一般還需要單點登入或者其他功能的通用請求頭，可以一併設定進來
        }
  },
})

封裝請求方法

先引入封裝好的方法，在要呼叫的介面重新封裝成一個方法暴露出去

// get 請求
export function httpGet({
  url,
  params = {}
}) {
  return new Promise((resolve, reject) => {
    axios.get(url, {
      params
    }).then((res) => {
      resolve(res.data)
    }).catch(err => {
      reject(err)
    })
  })
}

// post
// post請求
export function httpPost({
  url,
  data = {},
  params = {}
}) {
  return new Promise((resolve, reject) => {
    axios({
      url,
      method: 'post',
      transformRequest: [function (data) {
        let ret = ''
        for (let it in data) {
          ret += encodeURIComponent(it) + '=' + encodeURIComponent(data[it]) + '&'
        }
        return ret
      }],
      // 傳送的資料
      data,
      // •url引數
      params

    }).then(res => {
      resolve(res.data)
    })
  })
}

把封裝的方法放在一個api.js檔案中

import { httpGet, httpPost } from './http'
export const getorglist = (params = {}) => httpGet({ url: 'apps/api/org/list', params })

頁面中就能直接呼叫

// .vue
import { getorglist } from '@/assets/js/api'

getorglist({ id: 200 }).then(res => {
  console.log(res)
})

這樣可以把api統一管理起來，以後維護修改只需要在api.js檔案操作即可

請求攔截器

請求攔截器可以在每個請求里加上token，做了統一處理後維護起來也方便

// 請求攔截器
axios.interceptors.request.use(
  config => {
    // 每次傳送請求之前判斷是否存在token
    // 如果存在，則統一在http請求的header都加上token，這樣後臺根據token判斷你的登入情況，此處token一般是使用者完成登入後儲存到localstorage裡的
    token && (config.headers.Authorization = token)
    return config
  },
  error => {
    return Promise.error(error)
  })

響應攔截器

響應攔截器可以在接收到響應後先做一層操作，如根據狀態碼判斷登入狀態、授權

// 響應攔截器
axios.interceptors.response.use(response => {
  // 如果返回的狀態碼為200，說明介面請求成功，可以正常拿到資料
  // 否則的話丟擲錯誤
  if (response.status === 200) {
    if (response.data.code === 511) {
      // 未授權調取授權介面
    } else if (response.data.code === 510) {
      // 未登入跳轉登入頁
    } else {
      return Promise.resolve(response)
    }
  } else {
    return Promise.reject(response)
  }
}, error => {
  // 我們可以在這裡對異常狀態作統一處理
  if (error.response.status) {
    // 處理請求失敗的情況
    // 對不同返回碼對相應處理
    return Promise.reject(error.response)
  }
})