詳細講解axios封裝與api接口封裝管理

一、前言

axios的封裝和api接口的統一管理，其實主要目的就是在幫助我們簡化代碼和利于後期的更新維護。

在vue項目中，和背景互動擷取資料這塊，我們通常使用的是axios庫，它是基于promise的http庫，可運作在浏覽器端和node.js中。他有很多優秀的特性，例如攔截請求和響應、取消請求、轉換json、用戶端防禦XSRF等。是以我們的尤大大也是果斷放棄了對其官方庫vue-resource的維護，直接推薦我們使用axios庫

二、axios封裝步驟

安裝axios

npm install axios -S; // 安裝axios複制代碼

一般我會在項目的src目錄中，建立一個network檔案夾,作為我們的網絡請求子產品，然後在裡面建立一個http.js和一個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
}

// 環境的切換
const {baseUrl}=require('../config/env.'+process.env.NODE_ENV);
//同時 package.json的scripts需指定測試環境的模式  --mode test
 "scripts": {
    "serve": "vue-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 // 請求逾時
})

4.如上設定請求逾時

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

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.data.message,
                        duration: 1500,
                        forbidClick: true
                    });
            }
            return Promise.reject(error.response);
        }else {
            // 處理斷網的情況
            // eg:請求逾時或斷網時，更新state的network狀态
            // network狀态在app.vue中控制着一個全局的斷網提示元件的顯示隐藏
            // 關于斷網元件中的重新整理重新擷取資料，會在斷網元件中說明
            store.commit('changeNetwork', false);
        }    
});
//最後導出執行個體
export default service;

響應攔截器很好了解，就是伺服器傳回給我們的資料，我們在拿到之前可以對他進行一些處理。例如上面的思想：如果背景傳回的狀态碼是200，則正常傳回資料，否則的根據錯誤的狀态碼類型進行一些我們需要的錯誤，其實這裡主要就是進行了

錯誤的統一處理

和

沒登入

或

登入過期

後調整登入頁的一個操作。

到此處, axios的封裝基本就完成了,下面再簡單說下api的統一管理

三、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',
              method: 'get',
              params:{
                goodsId
              },
              hideloading: true
            })
    },
    // post送出    
    login (data) {        
      return 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=> {
            // 執行某些操作      
        })    
    }  
}

斷網情況處理

如下app.vue新增

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

這是app.vue，這裡簡單示範一下斷網。在http.js中介紹了，我們會在斷網的時候，來更新vue中network的狀态，那麼這裡我們根據network的狀态來判斷是否需要加載這個斷網元件。斷網情況下，加載斷網元件，不加載對應頁面的元件。當點選重新整理的時候，我們通過跳轉refesh頁面然後立即傳回的方式來實作重新擷取資料的操作。是以我們需要建立一個refresh.vue頁面，并在其beforeRouteEnter鈎子中再傳回目前頁面。

// refresh.vue
beforeRouteEnter (to, from, next) {
    next(vm => {            
        vm.$router.replace(from.fullPath)        
    })    
}

一、前言

axios的封裝和api接口的統一管理，其實主要目的就是在幫助我們簡化代碼和利于後期的更新維護。

二、axios封裝步驟

安裝axios

npm install axios -S; // 安裝axios複制代碼

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

詳細講解axios封裝與api接口封裝管理

一、前言

二、axios封裝步驟

到此處, axios的封裝基本就完成了,下面再簡單說下api的統一管理

三、api接口統一管理

在元件中的使用（按需導入）

api挂載到vue.prototype上省去引入的步驟

斷網情況處理

一、前言

二、axios封裝步驟

繼續閱讀

CodeChef PALPROB Palindromeness

ZOJ 1032 Area 2

UVA 590 Always on the run

FZU 1978 Repair the brackets

UVA 10344- 23 out of 5

POJ 2115 C Looooops

ZOJ 3700 Ever Dream

UVA 620 Cellular Structure

GNU科學函數庫[參考手冊][v0.1 Build 090129 Beta][GNU Scientific Library]

與專家面對面：Android開發入門問與答

vue3 transitionvue3 transition元件和vue2 transition元件

swift資料合集

蘋果稽核 Guideline 2.1 - Information Needed

vue學習筆記day12 vue的生命周期

父子元件間傳值的實作父子元件間傳值的實作

手把手教你配置：Jenkins+Github+Webhook +Nginx自動化打包部署Vue項目