vue日常開發基礎Axios網絡庫封裝

Posted on by

引言

首先Axios，一個基於 promise 的 HTTP 庫，可以用在瀏覽器和 node.js 中。

網絡請求庫無疑是項目開發中最基礎的建設瞭，在這個前後端分離的時代，市面上有不少優秀的請求庫，其中Axios就是優秀代表之一。

  • 攔截請求和響應
  • 轉換請求數據和響應數據
  • 自動轉換 JSON 數據
  • 客戶端支持防禦 XSRF
  • 支持 PromiseAPI

以上是axios的優秀點

axios使用

本文是基於Vue項目去使用Axios:

第一步安裝 npm install axios 已經邁出瞭一步，打開我們的package.json文件發現已經安裝成功，

接下來我們去具體實現功能：

1.配置請求基本信息

2.設置請求攔截器

3.設置請求響應器

實現以上三個方法

配置請求基本信息

//request.js
import axios from 'axios'
// 創建axios實例
const service = axios.create({
  // axios中請求配置有baseURL選項，表示請求URL公共部分
  baseURL: process.env.VUE_APP_BASE_API,
  // 超時
  timeout: 20000
})

設置請求攔截器

在發送請求之前我們總得做一些事情：

  • 是否需要token（如需要的話將每個請求攜帶token）
  • 如果是get需要傳遞參數的話需要將特殊字符過濾掉
// request攔截器
service.interceptors.request.use(
  config => {
    // 是否需要設置 token
    const isToken = (config.headers || {}).isToken === false
    if (getToken() && !isToken) {
      config.headers['Authorization'] = 'Bearer ' + getToken() // 讓每個請求攜帶自定義token 請根據實際情況自行修改
    }
    // get請求映射params參數
    if (config.method === 'get' && config.params) {
      let url = config.url + '?'
      for (const propName of Object.keys(config.params)) {
        const value = config.params[propName]
        var part = encodeURIComponent(propName) + '='
        if (value !== null && typeof value !== 'undefined' && value !== '') {
          if (typeof value === 'object') {
            for (const key of Object.keys(value)) {
              let params = propName
              // let params = propName + '[' + key + ']'
              var subPart = encodeURIComponent(params) + '='
              url += subPart + encodeURIComponent(value[key]) + '&'
            }
          } else {
            url += part + encodeURIComponent(value) + '&'
          }
        }
      }
      url = url.slice(0, -1)
      config.params = {}
      config.url = url
    }
    return config
  },
  error => {
    console.log(error)
    Promise.reject(error)
  }
)

補充：

encodeURIComponent方法是js提供的一個方法，把字符串作為 URI 組件進行編碼，該方法不會對 ASCII 字母和數字進行編碼，主要作用是過濾掉特殊字符

設置請求響應器

當數據回來的時候，我們也得幹一點事情：

  • 判斷登錄狀態
  • 錯誤處理
import { Message, MessageBox, Notification } from 'element-ui'
import errorCode from '@/utils/errorCode'
// 響應攔截器
service.interceptors.response.use(
  res => {
    // 未設置狀態碼則默認成功狀態
    const code = Number(res.data.code) || 200
    // 獲取錯誤信息
    const msg = errorCode[code] || res.data.msg || errorCode['default']
    if (code === 401) {
      MessageBox.confirm(
        '登錄狀態已過期，您可以繼續留在該頁面，或者重新登錄',
        '系統提示',
        {
          confirmButtonText: '重新登錄',
          cancelButtonText: '取消',
          type: 'warning'
        }
      ).then(() => {
        store.dispatch('LogOut').then(() => {
          location.href = '/index'
        })
      })
    } else if (code === 500) {
      Message({
        message: msg,
        type: 'error'
      })
      return Promise.reject(new Error(msg))
    } else if (code !== 200) {
      Notification.error({
        title: msg
      })
      return Promise.reject(msg)
    } else {
      return res.data
    }
  },
  error => {
    console.log('err' + error)
    let { message } = error
    if (message == 'Network Error') {
      message = '後端接口連接異常'
    } else if (message.includes('timeout')) {
      message = '系統接口請求超時'
    } else if (message.includes('Request failed with status code')) {
      message = '系統接口' + message.substr(message.length - 3) + '異常'
    }
    Message({
      message: message,
      type: 'error',
      duration: 5 * 1000
    })
    return Promise.reject(error)
  }
)

export default {
  '401': '認證失敗，無法訪問系統資源',
  '403': '當前操作沒有權限',
  '404': '訪問資源不存在',
  'default': '系統未知錯誤,請反饋給管理員'
}

項目中使用

import request from '@/utils/request'
// 登錄方法
export function login(username, password, code, uuid) {
  return request({
    url: '/auth/admin/login',
    method: 'post',
    data: { username, password, code, uuid }
  })
}

結尾

此時我們的網絡庫的基礎版已經實現，把service進行一個導出，就可以在項目中使用瞭，這個版本基本可以滿足日常項目的開發，如果需要其他設置可以另行添加。 擴展：

  • axios取消重復請求
  • axios無感token刷新

以上也是比較常見的場景，在本文註重實現基礎版網絡庫，日後需要對以上的場景進行探索。完結撒花~😉

export default service

以上就是vue日常開發基礎Axios網絡庫封裝的詳細內容，更多關於vue開發Axios網絡庫封裝的資料請關註WalkonNet其它相關文章！

推薦閱讀：