vue封装axios与api接口管理的完整步骤

一、前言 

axios的封装和api接口的统一管理，其实主要目的就是在帮助我们简化代码和利于后期的更新维护。

二、axios封装步骤

安装：npm install axios -S 

一般我会在项目的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
}

设置请求超时

通过axios.defaults.timeout设置默认的请求超时时间。例如超过了10s，就会告知用户当前请求超时，请刷新等。 

// 环境的切换
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 // 请求超时
})

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;

三、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=> {
           // 执行某些操作      
       })    
   }  
}

断网情况处理
<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)        
   })    
}

来源：https://blog.csdn.net/xingyunwei1/article/details/120885465