亚洲乱码中文字幕综合,中国熟女仑乱hd,亚洲精品乱拍国产一区二区三区,一本大道卡一卡二卡三乱码全集资源,又粗又黄又硬又爽的免费视频

詳解vue中axios封裝與api接口封裝管理

 更新時(shí)間:2023年06月05日 09:51:02   作者:電商數(shù)據(jù)girl  
axios的封裝和api接口的統(tǒng)一管理,其實(shí)主要目的就是在幫助我們簡(jiǎn)化代碼和利于后期的更新維護(hù),在vue項(xiàng)目中,和后臺(tái)交互獲取數(shù)據(jù)這塊,我們通常使用的是axios庫(kù),本文就給大家介紹一下axios封裝與api接口封裝管理,需要的朋友可以參考下

一、前言

axios的封裝和api接口的統(tǒng)一管理,其實(shí)主要目的就是在幫助我們簡(jiǎn)化代碼和利于后期的更新維護(hù)。

在vue項(xiàng)目中,和后臺(tái)交互獲取數(shù)據(jù)這塊,我們通常使用的是axios庫(kù),它是基于promise的http庫(kù),可運(yùn)行在瀏覽器端和node.js中。他有很多優(yōu)秀的特性,例如攔截請(qǐng)求和響應(yīng)、取消請(qǐng)求、轉(zhuǎn)換json、客戶(hù)端防御XSRF等。所以我們的尤大大也是果斷放棄了對(duì)其官方庫(kù)vue-resource的維護(hù),直接推薦我們使用axios庫(kù)

二、axios封裝步驟

  • 安裝axios
    npm install axios -S; // 安裝axios復(fù)制代碼
  • 目錄創(chuàng)建

一般我會(huì)在項(xiàng)目的src目錄中,新建一個(gè)network文件夾,作為我們的網(wǎng)絡(luò)請(qǐng)求模塊,然后在里面新建一個(gè)http.js和一個(gè)api.js文件和一個(gè)reques.js。http.js文件用來(lái)封裝我們的axios,api.js用來(lái)統(tǒng)一管理我們的接口url, request.js對(duì)外暴露我們放在的api方法。

// 在http.js中引入axios
import axios from 'axios'; // 引入axios
import router from '../router';
// vant的toast提示框組件,大家可根據(jù)自己的ui組件更改。
import { Toast } from 'vant'; 
  • 環(huán)境的切換

我們的項(xiàng)目環(huán)境可能有開(kāi)發(fā)環(huán)境、測(cè)試環(huán)境和生產(chǎn)環(huán)境。我們通過(guò)node的環(huán)境變量來(lái)匹配我們的默認(rèn)的接口url前綴。axios.defaults.baseURL可以設(shè)置axios的默認(rèn)請(qǐng)求地址就不多說(shuō)了。

創(chuàng)建config目錄。 目錄下創(chuàng)建env.development.js+env.production.js+env.test.js

env.development.js內(nèi)容如下:

module.exports={
    baseUrl:' http://www.devele.com:4456' //開(kāi)發(fā)環(huán)境用到的baseurl
}
// 環(huán)境的切換
const {baseUrl}=require('../config/env.'+process.env.NODE_ENV);
//同時(shí) package.json的scripts需指定測(cè)試環(huán)境的模式  --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 // 請(qǐng)求超時(shí)
})

如上 設(shè)置請(qǐng)求超時(shí)

通過(guò)axios.defaults.timeout設(shè)置默認(rèn)的請(qǐng)求超時(shí)時(shí)間。例如超過(guò)了10s,就會(huì)告知用戶(hù)當(dāng)前請(qǐng)求超時(shí),請(qǐng)刷新等。

  • post請(qǐng)求頭的設(shè)置 post請(qǐng)求的時(shí)候,我們需要加上一個(gè)請(qǐng)求頭,所以可以在這里進(jìn)行一個(gè)默認(rèn)的設(shè)置,即設(shè)置post的請(qǐng)求頭為application/x-www-form-urlencoded;charset=UTF-8
// 設(shè)置post請(qǐng)求頭
service.defaults.headers.post['Content-Type'] = 'application/x-www-form-urlencoded';
  • 請(qǐng)求攔截

我們?cè)诎l(fā)送請(qǐng)求前可以進(jìn)行一個(gè)請(qǐng)求的攔截,為什么要攔截呢,我們攔截請(qǐng)求是用來(lái)做什么的呢?比如,有些請(qǐng)求是需要用戶(hù)登錄之后才能訪問(wèn)的,或者post請(qǐng)求的時(shí)候,我們需要序列化我們提交的數(shù)據(jù)。這時(shí)候,我們可以在請(qǐng)求被發(fā)送之前進(jìn)行一個(gè)攔截,從而進(jìn)行我們想要的操作。

// 先導(dǎo)入vuex,因?yàn)槲覀円褂玫嚼锩娴臓顟B(tài)對(duì)象
// vuex的路徑根據(jù)自己的路徑去寫(xiě)
import store from '@/store/index';
// 請(qǐng)求攔截器
service.interceptors.request.use(
  config => {
    // 不傳遞默認(rèn)開(kāi)啟loading
    if (!config.hideloading) {
      // 請(qǐng)求是是否開(kāi)啟loading
      Toast.loading({
        forbidClick: true
      })
    }
      // 每次發(fā)送請(qǐng)求之前判斷vuex中是否存在token        
        // 如果存在,則統(tǒng)一在http請(qǐng)求的header都加上token,這樣后臺(tái)根據(jù)token判斷你的登錄情況
        // 即使本地存在token,也有可能token是過(guò)期的,所以在響應(yīng)攔截器中要對(duì)返回狀態(tài)進(jìn)行判斷 
    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)
  }
)

這里說(shuō)一下token,一般是在登錄完成之后,將用戶(hù)的token通過(guò)localStorage或者cookie存在本地,然后用戶(hù)每次在進(jìn)入頁(yè)面的時(shí)候(即在main.js中),會(huì)首先從本地存儲(chǔ)中讀取token,如果token存在說(shuō)明用戶(hù)已經(jīng)登陸過(guò),則更新vuex中的token狀態(tài)。然后,在每次請(qǐng)求接口的時(shí)候,都會(huì)在請(qǐng)求的header中攜帶token,后臺(tái)人員就可以根據(jù)你攜帶的token來(lái)判斷你的登錄是否過(guò)期,如果沒(méi)有攜帶,則說(shuō)明沒(méi)有登錄過(guò)。這時(shí)候或許有些小伙伴會(huì)有疑問(wèn)了,就是每個(gè)請(qǐng)求都攜帶token,那么要是一個(gè)頁(yè)面不需要用戶(hù)登錄就可以訪問(wèn)的怎么辦呢?其實(shí),你前端的請(qǐng)求可以攜帶token,但是后臺(tái)可以選擇不接收??!

  • 響應(yīng)的攔截
// 響應(yīng)攔截器
service.interceptors.response.use(
    response => {   
        // 如果返回的狀態(tài)碼為200,說(shuō)明接口請(qǐng)求成功,可以正常拿到數(shù)據(jù)     
        // 否則的話(huà)拋出錯(cuò)誤
        if (response.status === 200) {            
            return Promise.resolve(response);        
        } else {            
            return Promise.reject(response);        
        }    
    },    
    // 服務(wù)器狀態(tài)碼不是2開(kāi)頭的的情況
    // 這里可以跟你們的后臺(tái)開(kāi)發(fā)人員協(xié)商好統(tǒng)一的錯(cuò)誤狀態(tài)碼    
    // 然后根據(jù)返回的狀態(tài)碼進(jìn)行一些操作,例如登錄過(guò)期提示,錯(cuò)誤提示等等
    // 下面列舉幾個(gè)常見(jiàn)的操作,其他需求可自行擴(kuò)展
    error => {            
        if (error.response.status) {            
            switch (error.response.status) {                
                // 401: 未登錄
                // 未登錄則跳轉(zhuǎn)登錄頁(yè)面,并攜帶當(dāng)前頁(yè)面的路徑
                // 在登錄成功后返回當(dāng)前頁(yè)面,這一步需要在登錄頁(yè)操作。                
                case 401:                    
                    router.replace({                        
                        path: '/login',                        
                        query: { 
                            redirect: router.currentRoute.fullPath 
                        }
                    });
                    break;
                // 403 token過(guò)期
                // 登錄過(guò)期對(duì)用戶(hù)進(jìn)行提示
                // 清除本地token和清空vuex中token對(duì)象
                // 跳轉(zhuǎn)登錄頁(yè)面                
                case 403:
                     Toast({
                        message: '登錄過(guò)期,請(qǐng)重新登錄',
                        duration: 1000,
                        forbidClick: true
                    });
                    // 清除token
                  store.dispatch('FedLogOut').then(() => {
                    // 跳轉(zhuǎn)登錄頁(yè)面,并將要瀏覽的頁(yè)面fullPath傳過(guò)去,登錄成功后跳轉(zhuǎn)需要訪問(wèn)的頁(yè)面 
                 router.replace({                            
                            path: '/login',                            
                            query: { 
                                redirect:router.currentRoute.fullPath 
                            }      
                  })      })       
                    break; 
                // 404請(qǐng)求不存在
                case 404:
                    Toast({
                        message: '網(wǎng)絡(luò)請(qǐng)求不存在',
                        duration: 1500,
                        forbidClick: true
                    });
                    break;
                // 其他錯(cuò)誤,直接拋出錯(cuò)誤提示
                default:
                    Toast({
                        message: error.response.data.message,
                        duration: 1500,
                        forbidClick: true
                    });
            }
            return Promise.reject(error.response);
        }else {
            // 處理斷網(wǎng)的情況
            // eg:請(qǐng)求超時(shí)或斷網(wǎng)時(shí),更新state的network狀態(tài)
            // network狀態(tài)在app.vue中控制著一個(gè)全局的斷網(wǎng)提示組件的顯示隱藏
            // 關(guān)于斷網(wǎng)組件中的刷新重新獲取數(shù)據(jù),會(huì)在斷網(wǎng)組件中說(shuō)明
            store.commit('changeNetwork', false);
        }    
});
//最后導(dǎo)出實(shí)例
export default service;

響應(yīng)攔截器很好理解,就是服務(wù)器返回給我們的數(shù)據(jù),我們?cè)谀玫街翱梢詫?duì)他進(jìn)行一些處理。例如上面的思想:如果后臺(tái)返回的狀態(tài)碼是200,則正常返回?cái)?shù)據(jù),否則的根據(jù)錯(cuò)誤的狀態(tài)碼類(lèi)型進(jìn)行一些我們需要的錯(cuò)誤,其實(shí)這里主要就是進(jìn)行了錯(cuò)誤的統(tǒng)一處理和沒(méi)登錄或登錄過(guò)期后調(diào)整登錄頁(yè)的一個(gè)操作。

到此處, axios的封裝基本就完成了,下面再簡(jiǎn)單說(shuō)下api的統(tǒng)一管理

三、api接口統(tǒng)一管理

新建了一個(gè)api文件夾,里面有一個(gè)index.js,以及多個(gè)根據(jù)模塊劃分的接口js文件。index.js是一個(gè)api的出口,其他js則用來(lái)管理各個(gè)模塊的接口。

例如下面的article.js:

/**
 * article模塊接口列表
 */
import request from '@/network/http'; // 導(dǎo)入http中創(chuàng)建的axios實(shí)例
import qs from 'qs'; // 根據(jù)需求是否導(dǎo)入qs模塊 
const article = {    
    // 新聞列表    
    articleList () {        
       return request({
       url: '/artical',
       method: 'get',
       params,
       hideloading: false //設(shè)置不隱藏加載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參數(shù)
      hideloading: true
     })   
    }
    // 其他接口…………
}
export default article;

index.js代碼:

/** 
 * api接口的統(tǒng)一出口
 */
// 文章模塊接口
import article from '@/api/article';
// 其他模塊的接口…… 
// 導(dǎo)出接口
export default {    
    article,
    // ……
}

在組件中的使用(按需導(dǎo)入)

import {article} from '@/api/index'
created(){
   article.articleList().then(info=>{
       if(info.code==200)
     this.num=info.data
  }
     })
}

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

為了方便api的調(diào)用,我們需要將其掛載到vue的原型上。在main.js中:

import Vue from 'vue'
import App from './App'
import router from './router' // 導(dǎo)入路由文件
import store from './store' // 導(dǎo)入vuex文件
import api from './api' // 導(dǎo)入api接口
Vue.prototype.$api = api; // 將api掛載到vue的原型上復(fù)制代碼

然后我們?cè)诮M件中可以這么用

//無(wú)需導(dǎo)入
methods: {    
    onLoad(id) {      
        this.$api.article.articleDetail(id, {        
            api: 123      
        }).then(res=> {
            // 執(zhí)行某些操作      
        })    
    }  
}

斷網(wǎng)情況處理

如下app.vue新增

<template>  
    <div id="app">    
        <div v-if="!network">      
            <h3>我沒(méi)網(wǎng)了</h3>      
            <div @click="onRefresh">刷新</div>      
        </div>    
        <router-view/>      
    </div>
</template>
<script>
    import { mapState } from 'vuex';
    export default {  
        name: 'App',  
        computed: {    
            ...mapState(['network'])  
        },  
        methods: {    
            // 通過(guò)跳轉(zhuǎn)一個(gè)空頁(yè)面再返回的方式來(lái)實(shí)現(xiàn)刷新當(dāng)前頁(yè)面數(shù)據(jù)的目的
            onRefresh () {      
                this.$router.replace('/refresh')    
            }  
        }
    }
</script>

這是app.vue,這里簡(jiǎn)單演示一下斷網(wǎng)。在http.js中介紹了,我們會(huì)在斷網(wǎng)的時(shí)候,來(lái)更新vue中network的狀態(tài),那么這里我們根據(jù)network的狀態(tài)來(lái)判斷是否需要加載這個(gè)斷網(wǎng)組件。斷網(wǎng)情況下,加載斷網(wǎng)組件,不加載對(duì)應(yīng)頁(yè)面的組件。當(dāng)點(diǎn)擊刷新的時(shí)候,我們通過(guò)跳轉(zhuǎn)refesh頁(yè)面然后立即返回的方式來(lái)實(shí)現(xiàn)重新獲取數(shù)據(jù)的操作。因此我們需要新建一個(gè)refresh.vue頁(yè)面,并在其beforeRouteEnter鉤子中再返回當(dāng)前頁(yè)面。

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

以上就是詳解axios封裝與api接口封裝管理的詳細(xì)內(nèi)容,更多關(guān)于axios封裝與api接口封裝的資料請(qǐng)關(guān)注腳本之家其它相關(guān)文章!

相關(guān)文章

  • 前端vue3?setup使用教程

    前端vue3?setup使用教程

    這篇文章主要為大家介紹了前端vue3架構(gòu)setup使用教程,詳細(xì)介紹?setup?的用法,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進(jìn)步,早日升職加薪
    2022-02-02
  • 解決Vue的組件屬性this不存在問(wèn)題

    解決Vue的組件屬性this不存在問(wèn)題

    這篇文章主要介紹了解決Vue的組件屬性this不存在問(wèn)題,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教
    2022-01-01
  • 解決vue中reader.onload讀取文件的異步問(wèn)題

    解決vue中reader.onload讀取文件的異步問(wèn)題

    這篇文章主要介紹了解決vue中reader.onload讀取文件的異步問(wèn)題,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教
    2022-10-10
  • 在vue項(xiàng)目中封裝echarts的步驟

    在vue項(xiàng)目中封裝echarts的步驟

    這篇文章主要介紹了在vue項(xiàng)目中封裝echarts的步驟,幫助大家更好的理解和使用vue,感興趣的朋友可以了解下
    2020-12-12
  • vue項(xiàng)目實(shí)現(xiàn)國(guó)際化的基本思路與詳細(xì)步驟

    vue項(xiàng)目實(shí)現(xiàn)國(guó)際化的基本思路與詳細(xì)步驟

    國(guó)際化是指項(xiàng)目能夠根據(jù)不同國(guó)家的語(yǔ)言進(jìn)行轉(zhuǎn)換,便于不同國(guó)家的用戶(hù)使用,這篇文章主要給大家介紹了關(guān)于vue項(xiàng)目實(shí)現(xiàn)國(guó)際化的基本思路與詳細(xì)步驟,文中通過(guò)代碼介紹的非常詳細(xì),需要的朋友可以參考下
    2024-04-04
  • vue實(shí)現(xiàn)無(wú)限消息無(wú)縫滾動(dòng)

    vue實(shí)現(xiàn)無(wú)限消息無(wú)縫滾動(dòng)

    這篇文章主要為大家詳細(xì)介紹了vue實(shí)現(xiàn)無(wú)限消息無(wú)縫滾動(dòng),文中示例代碼介紹的非常詳細(xì),具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下
    2022-04-04
  • vue3如何優(yōu)雅的實(shí)現(xiàn)移動(dòng)端登錄注冊(cè)模塊

    vue3如何優(yōu)雅的實(shí)現(xiàn)移動(dòng)端登錄注冊(cè)模塊

    這篇文章主要給大家介紹了關(guān)于vue3如何優(yōu)雅的實(shí)現(xiàn)移動(dòng)端登錄注冊(cè)模塊的相關(guān)資料,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧
    2021-03-03
  • vue安裝和使用scss及sass與scss的區(qū)別詳解

    vue安裝和使用scss及sass與scss的區(qū)別詳解

    這篇文章主要介紹了vue安裝和使用教程,用了很久css預(yù)編譯器,但是一直不太清楚到底用的sass還是scss,直到有天被問(wèn)住了有點(diǎn)尷尬,感興趣的朋友一起看看吧
    2018-10-10
  • vue項(xiàng)目在env文件中設(shè)置的變量無(wú)效問(wèn)題及解決

    vue項(xiàng)目在env文件中設(shè)置的變量無(wú)效問(wèn)題及解決

    這篇文章主要介紹了vue項(xiàng)目在env文件中設(shè)置的變量無(wú)效問(wèn)題及解決方案,具有很好的參考價(jià)值,希望對(duì)大家有所幫助,如有錯(cuò)誤或未考慮完全的地方,望不吝賜教
    2024-03-03
  • Vue結(jié)合路由配置遞歸實(shí)現(xiàn)菜單欄功能

    Vue結(jié)合路由配置遞歸實(shí)現(xiàn)菜單欄功能

    這篇文章主要介紹了Vue結(jié)合路由配置遞歸實(shí)現(xiàn)菜單欄,本文通過(guò)實(shí)例代碼給大家介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)火鍋工作具有一定的參考借鑒價(jià)值,需要的朋友可以參考下
    2020-06-06

最新評(píng)論