快捷導(dǎo)航

Vue接口封裝的完整步驟記錄

更新時(shí)間：2021年05月14日 11:18:07 作者：火腿腸燒烤大賽冠軍

對(duì)于中小型企業(yè),vue應(yīng)用越來(lái)越多,學(xué)習(xí)vue相對(duì)于react的成本要低點(diǎn),入門相對(duì)簡(jiǎn)單。這篇文章主要給大家介紹了關(guān)于Vue接口封裝的相關(guān)資料,需要的朋友可以參考下

首先根據(jù)接口寫好對(duì)應(yīng)頁(yè)面的請(qǐng)求

內(nèi)容如圖盡量保證js文件名稱與頁(yè)面文件名稱相同（易于查找）

根據(jù)文件目錄動(dòng)態(tài)引入/導(dǎo)出接口

提高便捷性

/**
 * 自動(dòng)引入當(dāng)前文件夾下所有module
 * require.context(directory, useSubdirectories = false, regExp = /^.//);
 * @param {String} directory 讀取文件的路徑
 * @param {Boolean} directory 匹配文件的正則表達(dá)式
 * @param {regExp} regExp 讀取文件的路徑
 */
 const modulesFiles = require.context(
    './', // 在當(dāng)前目錄下查找
    false, // 不遍歷子文件夾
    /\.js$/ // 正則匹配 以 .js結(jié)尾的文件
)
 const modules = modulesFiles.keys().reduce((modules, modulePath) => {
   const moduleName = modulePath.replace(/^.\/(.*)\.js/,'$1')
   const value = modulesFiles(modulePath)
   modules[moduleName] = value.default
   return modules
   }, {})

export default modules

根據(jù)項(xiàng)目情況編寫攔截/插入內(nèi)容

import axios from 'axios'
import { MessageBox, Message } from 'element-ui'
import store from '@/store'
import { getToken } from '@/utils/auth'

// create an axios instance
const service = axios.create({
  baseURL: process.env.VUE_APP_BASE_API, // url = base url + request url
  // withCredentials: true, // send cookies when cross-domain requests
  timeout: 5000 // request timeout
})

// request interceptor
service.interceptors.request.use(
  config => {
    // 在發(fā)送請(qǐng)求之前做些什么

    if (store.getters.token) {
      // let each request carry token讓每個(gè)請(qǐng)求攜帶令牌
      // ['X-Token'] is a custom headers key 是一個(gè)自定義標(biāo)題鍵
      // please modify it according to the actual situation請(qǐng)根據(jù)實(shí)際情況修改
      config.headers['X-Token'] = getToken()
    }
    return config
  },
  error => {
    // do something with request error
    console.log(error) // for debug
    return Promise.reject(error)
  }
)

// response interceptor
service.interceptors.response.use(
  /**
   * If you want to get http information such as headers or status如果您想獲取http信息，如標(biāo)頭或狀態(tài)
   * Please return  response => response
  */

  /**
   * Determine the request status by custom code通過(guò)自定義代碼確定請(qǐng)求狀態(tài)
   * Here is just an example這里只是一個(gè)例子
   * You can also judge the status by HTTP Status Code您還可以通過(guò)HTTP狀態(tài)碼來(lái)判斷狀態(tài)
   */
  response => {
    const res = response.data
    // console.log(res);
    // 如果自定義代碼不是20000，則判斷為錯(cuò)誤.
    if (res.code !== 200) {
      Message({
        message: res.message || 'Error',
        type: 'error',
        duration: 5 * 1000
      })
      
      // 50008: 非法token; 50012: 其他客戶端已登錄; 50014: Token 已過(guò)期;
      if (res.code === 50008 || res.code === 50012 || res.code === 50014) {
        // to re-login
        MessageBox.confirm('您已注銷，可以取消以停留在此頁(yè)面，或重新登錄', '確認(rèn)注銷', {
          confirmButtonText: 'Re-Login',
          cancelButtonText: 'Cancel',
          type: 'warning'
        }).then(() => {
          store.dispatch('user/resetToken').then(() => {
            location.reload()
          })
        })
      }
      return Promise.reject(new Error(res.message || 'Error'))
    } else {
      return res
    }
  },
  error => {
    console.log('err' + error) // for debug
    Message({
      message: error.message,
      type: 'error',
      duration: 5 * 1000
    })
    return Promise.reject(error)
  }
)

export default service

編寫env文件

# just a flag
ENV = 'development'

# base api
VUE_APP_BASE_API = 'http://192.168.2.44:5001/v1'

vue繼承api

import serve from './api/index'
Vue.prototype.$api = serve;

使用

getAssetsList() {
  this.$api.assets
    .getAssetsList(this.queryInfo.num, this.queryInfo.size)
    .then((res) => {
      this.assetsList = res.data.cards
      this.total = res.data.page.totalCount
    })
    .catch(() => {
      this.$message.error({
        message: "失敗",
        duration: 700,
      })
    })
},