axios拦截，api统一管理

Posted 2021-06-21 郭郭郭牧鑫

axios的封装

• 关于封装axios
• 封装axios
• api接口统一管理

关于封装axios

封装axios是我们使用前端经常做的事情，为什么要封装axios，因为在封装他里面，我们可以做好多东西，比如响应拦截，请求拦截，还有加载动画，使我们请求接口是变得方便且简单。
并且在vue项目中，和后台交互获取数据这块，我们通常使用的是axios库，它是基于promise的http库，可运行在浏览器端和node.js中。

封装axios

1.首先我们要先下载axios

   npm install axios -S;

2.创建目录
在项目的src目录中，新建一个http文件夹,作为我们的网络请求模块，然后在里面新建一个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提示框组件
import { Toast } from 'vant';

3.考虑环境变量
我们的项目环境可能有开发环境、测试环境和生产环境。我们通过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);

 "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,
  withCredentials: false,
  timeout: 1000*12 // 请求超时
})

4.设置请求超时
通过axios.defaults.timeout设置请求时间。例如超过了5s，就会告知请求超时，请刷新。

5.post请求头的设置
post请求的时候，我们需加上一个请求头，所以我们进行一个默认的设置，即设置post的请求头为application/x-www-form-urlencoded;charset=UTF-8

// 设置post请求头
service.defaults.headers.post['Content-Type'] = 'application/x-www-form-urlencoded';

6.请求拦截
我们在发送请求前可以进行一个请求的拦截。

为什么要拦截呢，比如有些请求是需要用户登录之后才能访问的。

我们可以在请求被发送之前进行一个拦截，从而进行我们想要的操作。

// 导入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)
  }

7.响应的拦截

// 响应拦截器
service.interceptors.response.use(
    response => {   
        // 如果返回的状态码为200，可以正常拿到数据     
        if (response.status === 200) {            
            return Promise.resolve(response);        
        } else {            
            return Promise.reject(response);        
        }    
    },    
    error => {            
        if (error.response.status) {            
            switch (error.response.status) {                
                // 401: 未登录
                // 未登录则跳转登录页面，并携带当前页面的路径
                // 在登录成功后返回当前页面，这一步需要在登录页操作。                
                case 401:                    
                    router.replace({                        
                        path: '/login',                        
                        query: { 
                            redirect: router.currentRoute.fullPath 
                        }
                    });
                    break;
 
                // 403 token过期              
                case 403:
                     Toast({
                        message: '登录过期，请重新登录',
                        duration: 1000,
                        forbidClick: true
                    });
                    // 清除token
                  store.dispatch('FedLogOut').then(() => {
                 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 {
            // 处理断网的情况
            store.commit('changeNetwork', false);
        }

    
});

//导出实例
export default service;

响应拦截器就是服务器返回给我们的数据，我们在拿到之前可以对他进行一些处理。例如上面的思想：如果后台返回的状态码是200，则正常返回数据，否则根据错误的状态码类型进行一些我们需要的错误。
主要就是进行了错误的统一处理和没登录或登录过期后调整登录页的一个操作。

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的原型上。在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=> {
            // 某些操作      
        })    
    }  
}