基於 Vue 配置 axios

NoManReady發表於2017-11-09
VueiOS

1、背景

  • 在專案開發中ajax請求是必不可缺少
  • 一部分ajax請求不需要loading或則請求時間少於多少是不顯示loading
  • 專案中對請求的同一化處理（錯誤處理，返回資料格式化處理，loading處理，token處理）
  • 配置基於個人vue專案進行配置，已載入vux相關元件，會進行一些依賴的import（可以按需配置）
import Vue from 'vue'
import axios from 'axios'
//專案的一些環境配置引數，讀取host
import config from '@/config'
//vuex狀態管理，這裡主要進行對全域性loading的控制
import store from '@/store'
//vue-router對相應狀態碼的頁面操作（router例項）
import router from '@/router'
//console對應封裝
import { log } from '@/utils'複製程式碼

2、解決方案

對於axios的封裝中我們定義幾個引數進行申明

// 載入最小時間
const MINI_TIME = 300
// 超時時間（超時時間）
let TIME_OUT_MAX = 5000
// 環境value
let _env = process.env.NODE_ENV
// 請求介面host
let _apiHost = config.api
// 請求組（判斷當前請求數）
let _requests = []複製程式碼

一般一個專案中的根host和Content-Type都是統一的，這裡對axios進行統一的配置（如果這個後端需要formData格式的表單即content-type='application/x-www-form-urlencoded;charset=utf-8'資料，需要對請求資料進行表單序列化，比較快的方式就是引入qs庫qs.stringify進行處理後傳輸）

axios.defaults.headers.common['Content-Type'] = 'application/json'
axios.defaults.baseURL = _apiHost複製程式碼

一般情況下專案中同一時刻都會有不止一個請求在進行（還沒有返回），要判斷當前是否還存在進行中的ajax，就需要對_requests這個陣列進行維護；

/**
 * 新增請求，顯示loading
 * @param {請求配置} config 
 */
function pushRequest(config) {
  log(`${config.url}--begin`)
  _requests.push(config)
  Vue.$vux.loading.show({
    text: 'Loading'
  })
  store.dispatch('loading')
}

/**
 * 移除請求，無請求時關閉loading
 * @param {請求配置} config 
 */
function popRequest(config) {
  log(`${config.url}--end`)
  let _index = _requests.findIndex(r => {
    return r === config
  })
  if (_index > -1) {
    _requests.splice(_index, 1)
  }
  if (!_requests.length) {
    Vue.$vux.loading.hide(0)
    store.dispatch('loading', false)
  }
}複製程式碼

接下來對axios基於上面的準備進行處理

/**
 * 請求地址，請求資料，是否靜默，請求方法
 */
export default (url, data = {}, isSilence = false, method = 'POST') => {
  let _opts = { method, url }
  //通用資料的合併（token）
  let _data = Object.assign({}, data, { token: store.getters.token })
  const _query = {}
  for (let _key in _data) {
    if (_data.hasOwnProperty(_key) && _data[_key] !== '') {
      _query[_key] = _data[_key]
    }
  }
  //axios例項請求定時器ID
  let _timer = null
  //判斷請求型別
  if (method.toLocaleUpperCase() === 'POST') {
    _opts.data = _query
  } else {
    _opts.params = _query
  }
  //返回一個promise
  return new Promise((resolve, reject) => {
    //例項化axios
    const _instance = axios.create({
      timeout: TIME_OUT_MAX
    })
    //定義請求的唯一標識
    let _random = { stamp: Date.now(), url: `${_apiHost + url}` }
    //判斷是否靜默（靜默的話就不加入請求標識佇列，不是則申明此請求例項的定時器）
    if (!isSilence) {
      _timer = setTimeout(() => {
        pushRequest(_random)
      }, MINI_TIME)
    }
    //axios例項傳送當前請求
    //請求完成：1、取消當前請求的定時器；2、在當前請求標識佇列中移除當前標識；
    3、成功的話返回統一處理後的資料，失敗則對狀態碼進行判斷
    _instance(_opts)
      .then(res => {
        let responseData = res.data
        clearTimeout(_timer)
        popRequest(_random)
        resolve(res.data)
      })
      .catch(res => {
        let _response = res.response
        let _message = null
        clearTimeout(_timer)
        popRequest(_random)
        switch (_response.status) {
          case 404:
            _message = '404,錯誤請求'
            break
          case 401:
            router.push({ path: '/login', query: { redirect: router.currentRoute.fullPath } })
            _message = '未授權'
            break
          case 403:
            _message = '禁止訪問'
            break
          case 408:
            _message = '請求超時'
            break
          case 500:
            _message = '伺服器內部錯誤'
            break
          case 501:
            _message = '功能未實現'
            break
          case 503:
            _message = '服務不可用'
            break
          case 504:
            _message = '閘道器錯誤'
            break
          default:
            _message = '未知錯誤'
        }
        if (!isSilence) {
          Vue.$vux.toast.show({
            text: _response.data && _response.data.error ? _response.data.error : _message,
            type: 'warn',
            width: '10em'
          })
        }
        reject(res)
      })
  })
}複製程式碼

原始檔路徑

#來點積極向上有活力的Image

相關文章