目錄

• 一、前言
• 二、axios封裝步驟
• 三、api介面統一管理
• 總結

一、前言

axios的封裝和api介面的統一管理，其實主要目的就是www.cppcns.com在幫助我們簡化程式碼和利於後期的更新維護。

二、axios封裝步驟

安裝：npm install axios -S

一般我會在專案的src目錄中，新建一個network資料夾,作為我們的網路請求模組，然後在裡面新建一個http.和一個api.js檔案和一個reques.js。http.js檔案用來封裝我們的axios，api.js用來統一管理我們的介面url,request.js對外暴露我們放在的api方法。

// 在http.js中引入axios
import axios from 'axios'; // 引入axios
import router from '../router';
// vant的toast提示框元件，大家可根據自己的ui元件更改。
import { Toast } from 'vant'; 
 

我們的專案環境可能有開發環境、測試環境和生產環境。我們通過node的環境變數來匹配我們的預設的介面url字首。axios.defaults.baseURL可以設定axios的預設請求地址就不多說了。

建立config目錄。

目錄下建立env.development.js+env.production.js+env.test.js

env.development.js內容：

module.exports={
    baseUrl:' http://www.devele.com:4456' //開發環境用到的baseurl
}

設定請求超時

通過axios.defaults.timeout設定預設的請求超時時間。例如超過了10s，就會告知使用者當前請求超時，請重新整理等。

// 環境的切換
const {baseUrl}=require('../config/env.'+process.env.NODE_ENV);
 
//同時 package.json的scripts需指定測試環境的模式  --mode test
 "scripts": {
    "serve": "-cli-service serve","build": "vue-cli-service build","test": "vue-cli-service build --mode test","lint": "vue-cli-service lint"
  }
 
const service = axios.create({
  baseURL: baseUrl,// url = base api url + request url
  withCredentials: false,// send cookies when cross-domain requests
  timeout: 1000*12 // 請求超時
})

post請求頭的設定

post請求的時候，我們需要加上一個請求頭，所以可以在這裡進行一個預設的設定，即設定post的請求頭為application/x-www-form-urlencoded;charset=UTF-8

// 設定post請求頭
service.defaults.headers.post['Content-Type'] = 'application/x-www-form-urlencoded';

請求攔截

我們在傳送請求前可以進行一個請求的攔截，為什麼要攔截呢，我們攔截請求是用來做什麼的呢？比如，有些請求是需要使用者登入之後才能訪問的，或者post請求的時候，我們需要序列化我們提交的資料。這時候，我們可以在請求被髮送之前進行一個攔截，從而進行我們想要的操作。

// 先匯入vuex,因為我們要使用到裡面的狀態物件
// vuex的路徑根據自己的路徑去寫
import store from '@/store/index';
 
// 請求攔截器
service.interceptors.request.use(
  config => {
    // 不傳遞預設開啟loading
    if (!config.hideloading) {
      // 請求是是否開啟loading
      Toast.loading({
        forbidClick: true
      })
    }
      // 每次傳送請求之前判斷vuex中是否存在token        
        // 如果存在，則統一在http請求的header都加上token，這樣後臺根據token判斷你的登入情況
        // 即使本地存在token，也有可能token是過期的，所以在響應攔截器中要對返回狀態進行判斷 
    if (store.state.token) {
      config.headers.token = store.state.token;
      //有些介面是 config.headers.Authorization = token
    }
    return config
  },error => {
    // do something with request error
    console.log(error) // for debug
    return Promise.reject(error)
  }
)

這裡說一下token，一般是在登入完成之後，將使用者的token通過localStorage或者cookie存在本地，然後使用者每次在進入頁面的時候（即在main.js中），會首先從本地儲存中讀取token，如果token存在說明使用者已經登陸過，則更新vuex中的token狀態。然後，在每次請求介面的時候，都會在請求的header中攜帶token，後臺人員就可以根據你攜帶的token來判斷你的登入是否過期，如果沒有攜帶，則說明沒有登入過。這時候或許有些小夥伴會有疑問了，就是每個請求都攜帶token，那麼要是一個頁面不需要使用者登入就可以訪問的怎麼辦呢？其實，你前端的請求可以攜帶token，但是後臺可以選擇不接收。

響應攔截

// 響應攔截器
service.interceptors.response.use(
    response => {   
        // 如果返回的狀態碼為200，說明介面請求成功，可以正常拿到資料     
        // 否則的話丟擲錯誤
        if (response.status === 200) {            
            return Promise.resolve(response);        
        } else {            
            return Promise.reject(response);        
        }    
    },// 伺服器狀態碼不是2開頭的的情況
    // 這裡可以跟你們的後臺開發人員協商好統一的錯誤狀態碼    
    // 然後根據返回的狀態碼進行一些操作，例如登入過期提示，錯誤提示等等
    // 下面列舉幾個常見的操作，其他需求可自行擴充套件
    error => {            
        if (error.response.status) {            
            switch (error.response.status) {                
                // 401: 未登入
                // 未登入則跳轉登入頁面，並攜帶當前頁面的路徑
                // 在登入成功後返回當前頁面，這一步需要在登入頁操作。                
                case 401:                    
                    router.replace({                        
                        path: '/login',query: { 
                            redirect: router.currentRoute.fullPath 
                        }
                    });
                    break;
 
                // 403 token過期
                // 登入過期對使用者進行提示
                // 清除本地token和清空vuex中token物件
                // 跳轉登入頁面                
                case 403:
                     Toast({
                        message: '登入過期，請重新登入',duration: 1000,forbidClick: true
                    });
                    // 清除token
                  store.dispatch('FedLogOut').then(() => {
                    // 跳轉登入頁面，並將要瀏覽的頁面fullPath傳過去，登入成功後跳轉需要訪問的頁面 
                 router.replace({                            
                            path: '/login',query: { 
                                redirect:router.currentRoute.fullPath 
                            }      
                  })      })       
                    break; 
 
                // 404請求不存在
                case 404:
                    Toast({
                        message: '網路請求不存在',duration: 1500,forbidClick: true
                    });
                    break;
                // 其他錯誤，直接丟擲錯誤提示
                default:
                    Toast({
                        message: error.response.dwww.cppcns.comata.message,forbidClick: true
                    });
            }
            return Promise.reject(error.response);
        }else {
            // 處理斷網的情況
            // eg:請求超時或斷網時，更新state的network狀態
            // network狀態在app.vue中控制著一個全域性的斷網提示元件的顯示隱藏
            // 關於斷網元件中的重新整理重新獲取資料，會在斷網元件中說明
            store.commit('changeNetwork',false);
        }
 
    
});
 
//最後匯出例項
export default service;

三、api介面統一管理

新建了一個api資料夾，裡面有一個index.js，以及多個根據模組劃分的介面js檔案。index.js是一個api的出口，其他js則用來管理各個模組的介面。

例如下面的article.js:

/**
 * article模組介面列表
 */
 
import request from '@/network/http'; // 匯入http中建立的axios例項
import qs from 'qs'; // 根據需求是否匯入qs模組
 
const article = {    
    // 新聞列表    
    articleList () {        
       return request({
       url: '/artical',method: 'get',params,hideloading: false //設定不隱藏載入loading
    })  
    },// 新聞詳情,演示    
    articleDetail (id,params) {        
         return request({
              url: '/detail',params:{
                goodsId
              },hideloading: true
            })
    },// post提交    
    login (data) {        
      returRSPYlFaqonn request({
      url:'/adduser',method:'post',data:qs.stringify(data),//注意post提交用data引數
      hideloading: true
 
     })   
    }
    // 其他介面…………
}
 
export default article;

index.js程式碼

/** 
 * api介面的統一出口
 */
// 文章模組介面
import article from '@/api/article';
// 其他模組的介面……
 
// 匯出介面
export default {    
    article,// ……
}
 
在元件中的使用（按需匯入）
import {article} from '@/api/index'
 
created(){
   article.articleList().then(info=>{
       if(info.code==200)
     this.num=info.data
  }
     })
}

api掛載到vue.prototype上省客棧去引入的步驟

為了方便api的呼叫，我們需要將其掛載到vue的原型上。在main.js中

import Vue from 'vue'
import App from './App'
import router from './router' // 匯入路由檔案
import store from './store' // 匯入vuex檔案
import api from './api' // 匯入api介面
 
Vue.prototype.$api = api; // 將api掛載到vue的原型上覆制程式碼

然後我們在元件中可以這麼用

//無需匯入
methods: {    
    onLoad(id) {      
        this.$api.article.articleDetail(id,{        
            api: 123      
        }).then(res=> {
            // 執行某些操作      
        })    
    }  
}
 
 
斷網情況處理
<template>  
    <div id="app">    
        <div v-if="!network">      
            <h3>我沒網了</h3>      
            <div @click="onRefresh">重新整理</div>      
        </div>    
        <router-view/>      
    </div>
</template>
 
<script>
    import { mapState } from 'vuex';
    export default {  
        name: 'App',computed: {    
            ...mapState(['network'])  
        },methods: {    
            // 通過跳轉一個空頁面再返回的方式來實現重新整理當前頁面資料的目的
            onRefresh () {      
                this.$router.replace('/refresh')    
            }  
        }
    }
</script>
 
// refresh.vue
beforeRouteEnter (to,from,next) {
    next(vm => {            
        vm.$router.replace(from.fullPath)        
    })    
}

總結

到此這篇關於vue封裝axios與api介面管理的文章就介紹到這了,更多相關vue封裝axios與api介面內容請搜尋我們以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援我們！