vue如何封裝axios

今天小編給大家分享一下vue如何封裝axios的相關(guān)知識(shí)點(diǎn)，內(nèi)容詳細(xì)，邏輯清晰，相信大部分人都還太了解這方面的知識(shí)，所以分享這篇文章給大家參考一下，希望大家閱讀完這篇文章后有所收獲，下面我們一起來了解一下吧。

vue封裝axios可以提高代碼質(zhì)量、讓使用更為便利。axios的API很友好，開發(fā)者完全可以很輕松地在項(xiàng)目中直接使用；不過隨著項(xiàng)目規(guī)模增大，如果每發(fā)起一次HTTP請(qǐng)求，需要寫一遍設(shè)置超時(shí)時(shí)間、設(shè)置請(qǐng)求頭、錯(cuò)誤處理等等操作。這種重復(fù)勞動(dòng)不僅浪費(fèi)時(shí)間，而且讓代碼變得冗余不堪，難以維護(hù)；為了提高我們的代碼質(zhì)量，應(yīng)該在項(xiàng)目中二次封裝一下axios再使用，這樣可以讓使用更為便利。

axios是什么

axios 是一個(gè)輕量的 HTTP客戶端

基于 XMLHttpRequest 服務(wù)來執(zhí)行 HTTP 請(qǐng)求，支持豐富的配置，支持 Promise，支持瀏覽器端和 Node.js 端。自Vue2.0起，尤大宣布取消對(duì) vue-resource 的官方推薦，轉(zhuǎn)而推薦 axios?，F(xiàn)在 axios 已經(jīng)成為大部分 Vue 開發(fā)者的首選

為什么要封裝

axios 的 API 很友好，你完全可以很輕松地在項(xiàng)目中直接使用。

不過隨著項(xiàng)目規(guī)模增大，如果每發(fā)起一次HTTP請(qǐng)求，就要把這些比如設(shè)置超時(shí)時(shí)間、設(shè)置請(qǐng)求頭、根據(jù)項(xiàng)目環(huán)境判斷使用哪個(gè)請(qǐng)求地址、錯(cuò)誤處理等等操作，都需要寫一遍

這種重復(fù)勞動(dòng)不僅浪費(fèi)時(shí)間，而且讓代碼變得冗余不堪，難以維護(hù)。為了提高我們的代碼質(zhì)量，我們應(yīng)該在項(xiàng)目中二次封裝一下 axios 再使用

舉個(gè)例子：

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

如果每個(gè)頁面都發(fā)送類似的請(qǐng)求，都要寫一堆的配置與錯(cuò)誤處理，就顯得過于繁瑣了

這時(shí)候我們就需要對(duì)axios進(jìn)行二次封裝，讓使用更為便利

如何封裝

封裝的同時(shí)，你需要和 后端協(xié)商好一些約定，請(qǐng)求頭，狀態(tài)碼，請(qǐng)求超時(shí)時(shí)間.......

設(shè)置接口請(qǐng)求前綴：根據(jù)開發(fā)、測(cè)試、生產(chǎn)環(huán)境的不同，前綴需要加以區(qū)分

請(qǐng)求頭 : 來實(shí)現(xiàn)一些具體的業(yè)務(wù)，必須攜帶一些參數(shù)才可以請(qǐng)求(例如：會(huì)員業(yè)務(wù))

狀態(tài)碼: 根據(jù)接口返回的不同status ， 來執(zhí)行不同的業(yè)務(wù)，這塊需要和后端約定好

請(qǐng)求方法：根據(jù)get、post等方法進(jìn)行一個(gè)再次封裝，使用起來更為方便

請(qǐng)求攔截器: 根據(jù)請(qǐng)求的請(qǐng)求頭設(shè)定，來決定哪些請(qǐng)求可以訪問

響應(yīng)攔截器： 這塊就是根據(jù) 后端`返回來的狀態(tài)碼判定執(zhí)行不同業(yè)務(wù)

設(shè)置接口請(qǐng)求前綴

利用node環(huán)境變量來作判斷，用來區(qū)分開發(fā)、測(cè)試、生產(chǎn)環(huán)境

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'
}

在本地調(diào)試的時(shí)候，還需要在vue.config.js文件中配置devServer實(shí)現(xiàn)代理轉(zhuǎn)發(fā)，從而實(shí)現(xiàn)跨域

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

設(shè)置請(qǐng)求頭與超時(shí)時(shí)間

大部分情況下，請(qǐng)求頭都是固定的，只有少部分情況下，會(huì)需要一些特殊的請(qǐng)求頭，這里將普適性的請(qǐng)求頭作為基礎(chǔ)配置。當(dāng)需要特殊請(qǐng)求頭時(shí)，將特殊請(qǐng)求頭作為參數(shù)傳入，覆蓋基礎(chǔ)配置

const service = axios.create({
    ...
    timeout: 30000,  // 請(qǐng)求 30s 超時(shí)
	  headers: {
        get: {
          'Content-Type': 'application/x-www-form-urlencoded;charset=utf-8'
          // 在開發(fā)中，一般還需要單點(diǎn)登錄或者其他功能的通用請(qǐng)求頭，可以一并配置進(jìn)來
        },
        post: {
          'Content-Type': 'application/json;charset=utf-8'
          // 在開發(fā)中，一般還需要單點(diǎn)登錄或者其他功能的通用請(qǐng)求頭，可以一并配置進(jìn)來
        }
  },
})

封裝請(qǐng)求方法

先引入封裝好的方法，在要調(diào)用的接口重新封裝成一個(gè)方法暴露出去

// get 請(qǐng)求
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請(qǐng)求
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
      }],
      // 發(fā)送的數(shù)據(jù)
      data,
      // url參數(shù)
      params

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

把封裝的方法放在一個(gè)api.js文件中

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

頁面中就能直接調(diào)用

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

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

這樣可以把a(bǔ)pi統(tǒng)一管理起來，以后維護(hù)修改只需要在api.js文件操作即可

請(qǐng)求攔截器

請(qǐng)求攔截器可以在每個(gè)請(qǐng)求里加上token，做了統(tǒng)一處理后維護(hù)起來也方便

// 請(qǐng)求攔截器
axios.interceptors.request.use(
  config => {
    // 每次發(fā)送請(qǐng)求之前判斷是否存在token
    // 如果存在，則統(tǒng)一在http請(qǐng)求的header都加上token，這樣后臺(tái)根據(jù)token判斷你的登錄情況，此處token一般是用戶完成登錄后儲(chǔ)存到localstorage里的
    token && (config.headers.Authorization = token)
    return config
  },
  error => {
    return Promise.error(error)
  })

響應(yīng)攔截器

響應(yīng)攔截器可以在接收到響應(yīng)后先做一層操作，如根據(jù)狀態(tài)碼判斷登錄狀態(tài)、授權(quán)

// 響應(yīng)攔截器
axios.interceptors.response.use(response => {
  // 如果返回的狀態(tài)碼為200，說明接口請(qǐng)求成功，可以正常拿到數(shù)據(jù)
  // 否則的話拋出錯(cuò)誤
  if (response.status === 200) {
    if (response.data.code === 511) {
      // 未授權(quán)調(diào)取授權(quán)接口
    } else if (response.data.code === 510) {
      // 未登錄跳轉(zhuǎn)登錄頁
    } else {
      return Promise.resolve(response)
    }
  } else {
    return Promise.reject(response)
  }
}, error => {
  // 我們可以在這里對(duì)異常狀態(tài)作統(tǒng)一處理
  if (error.response.status) {
    // 處理請(qǐng)求失敗的情況
    // 對(duì)不同返回碼對(duì)相應(yīng)處理
    return Promise.reject(error.response)
  }
})

以上就是“vue如何封裝axios”這篇文章的所有內(nèi)容，感謝各位的閱讀！相信大家閱讀完這篇文章都有很大的收獲，小編每天都會(huì)為大家更新不同的知識(shí)，如果還想學(xué)習(xí)更多的知識(shí)，請(qǐng)關(guān)注億速云行業(yè)資訊頻道。