開發與維運

vue axios封裝以及API統一管理


在vue項目中,每次和後臺交互的時候,經常用到的就是axios請求數據,它是基於promise的http庫,可運行在瀏覽器端和node.js中。當項目越來越大的時候,接口的請求也會越來越多,怎麼去管理這些接口?多人合作怎麼處理?只有合理的規劃,才能方便往後的維護以及修改,

 

安裝

安裝axios依賴包

cnpm install axios --save
引入

一般會我會在項目src中新建一個untils目錄,其中base用於管理接口域名,http處理請求攔截和響應攔截,user.js負責接口文件(接口文件可以自己新建一個文件夾,然後放對應的接口文件)

1.在http.js文件中,用於處理axios中對請求攔截和響應攔截做處理,token處理,並引入element-ui加載動畫。

import axios from 'axios'
import { Loading, Message } from 'element-ui'
import router from '../router/index.js'

let loading

function startLoading() {

loading = Loading.service({
    lock: true,
    text: '加載中....',
    background: 'rgba(0, 0, 0, 0.7)'
})

}

function endLoading() {

loading.close()

}

// 請求攔截
axios.interceptors.request.use(

(confing) => {
    startLoading()

    //設置請求頭
    if (localStorage.eToken) {
        confing.headers.Authorization = localStorage.eToken
    }

    return confing
},
(error) => {
    return Promise.reject(error)
}

)

//響應攔截

axios.interceptors.response.use(

(response) => {
    endLoading()
    return response
},
(error) => {
    Message.error(error.response.data)
    endLoading()

    // 獲取狀態碼
    const { status } = error.response

    if (status === 401) {
        Message.error('請重新登錄')
            //清楚token
        localStorage.removeItem('eToken')
            //跳轉到登錄頁面
        router.push('/login')
    }
    return Promise.reject(error)
}

)
export default axios
通過創建一個axios實例然後export default方法導出,這樣使用起來更靈活一些。

2.在base.js文件中,用於管理我們請求接口的域名,極大的方便後期的維護和開發,如果以後更改域名地址或者增加域名,只需要修改這樣就可以了、

//域名統一管理

const base = {

url: 'http://localhost:5001/api'

}
export default base
3.接口統一管理,每一個js文件都對應一個功能請求接口管理,在下面實現get,post的實例請求,並且引入qs序列化的處理,使用之前先安裝qs

安裝qs
cnpm install qs --save
  3.1:更加模塊化管理

  3.2:更方便多人開發,有效減少解決命名衝突

  3.3:處理接口域名有多個情況

import axios from '../untils/http'
import QS from 'qs'
import base from './base'

/**

  • post方法,對應post請求
  • @desc註冊請求
  • @param {String} url [請求的url地址]
  • @param {Object} params [請求時攜帶的參數]

*/
export function userRejister(data) {

return axios({
    url: `${base.url}/users/register`,
    method: 'post',
    data: QS.stringify(data)
})

}
/**

  • get方法,對應get請求
  • @desc登錄請求
  • @param {String} url [請求的url地址]
  • @param {Object} params [請求時攜帶的參數]

*/
export function userInfo() {

return axios({
    url: `${base.url}/profile/all`,
    method: 'get'
})

}
4.使用。以上工作做完之後,只需要在我們需要發送請求接口的文件,引入

本實例中引入案例
import { userRejister} from "../../untils/user.js";
發送請求axios請求

async submitForm(formName) {

  this.$refs[formName].validate(valid => {
    if (valid) {
      //發送請求return new Promise((resolve, reject) => {
        userRejister(this.registerUser)
          .then(response => {
            console.log(response);
            resolve();
          })
          .catch(error => {
            reject(error);
          });
      });
    } else {
      console.log("error submit!!");
      return false;
    }
  });
},

以上都是這篇文章所有的說明,如果喜歡,可以多多關注一下

Leave a Reply

Your email address will not be published. Required fields are marked *