Vue二次封装axios过程以及代码实现

axios的API很友好，你完全可以很轻松地在项目中直接使用

不过随着项目规模增大，如果每发起一次HTTP请求，就要把这些比如设置超时时间，设置请求头，根据项目环境判断使用哪个请求地址，错误处理等等操作，都需要写一遍

这种重复劳动不仅浪费时间，而且让代码变得冗余不堪，难以维护，为了提高我们的代码质量，我们应该在项目中二次封装一下axios再调用

举个例子：

axios('http://localhost:3000/data', {
 // 配置代码
 method: 'GET',
 timeout: 1000,
 withCredentials: true,
 headers: {
 'Content-Type': 'application/json',
 Authorization: 'xxx',
 },
 transformRequest: [function (data, headers) {
 return data;
 }],
 // 其他请求配置...
})
.then((data) => {
 // todo: 真正业务逻辑代码
 console.log(data);
}, (err) => {
 // 错误处理代码
 if (err.response.status === 401) {
 // handle authorization error
 }
 if (err.response.status === 403) {
 // handle server forbidden error
 }
 // 其他错误处理.....
 console.log(err);
});

如果每个页面都发送类似的请求，都要写一堆的配置与错误处理，就显得过于繁琐了

这时候我们就需要对axios进行二次封装，让使用更为便利

一，如何封装 

封装的同时，你需要和后端协商好一些约定，请求头，状态码，请求超时时间……

设置接口请求前缀：根据开发，测试，生产环境的不同，前缀需要加以区分

请求头：来实现一些具体的业务，必须携带一些参数才可以请求（例如：会员业务）

状态码：根据接口返回不同的status，来执行不同的业务，这块需要和后端约定好

请求方法：根据get，post等方法进行一个再次封装，使用起来更为方便

请求拦截器：根据请求的请求头的设定，来决定哪些请求可以访问

响应拦截器：这块就是根据后端返回来的状态码判定执行不同业务

设置接口请求前缀

利用node环境变量来作判断，用来区分开发，测试，生产环境

if (process.env.NODE_ENV === 'development') {
 axios.defaults.baseURL = 'http://dev.xxx.com'
} else if (process.env.NODE_ENV === 'production') {
 axios.defaults.baseURL = 'http://prod.xxx.com'
}

在本地调试的时候，还需要再vue.config.js文件中配置devServer实现代理转发，从而实现跨域

devServer: {
 proxy: {
 '/proxyApi': {
 target: 'http://dev.xxx.com',
 changeOrigin: true,
 pathRewrite: {
 '/proxyApi': ''
 }
 }
 }
 }

设置请求头与超时时间

大部分情况下，请求头都是固定的，只有少部分情况下，会需要一些特殊的请求头，这里将普适性的请求头作为基础配置，当需要特殊请求头时，将特殊请求头作为参数传入，覆盖基础配置

const service = axios.create({
 ...
 timeout: 30000, // 请求 30s 超时
 headers: {
 get: {
'Content-Type': 'application/x-www-form-urlencoded;charset=utf8'
 // 在开发中，⼀般还需要单点登录或者其他功能的通⽤请求头，可以⼀并配置进来
 },
 post: {
 'Content-Type': 'application/json;charset=utf-8'
 // 在开发中，⼀般还需要单点登录或者其他功能的通⽤请求头，可以⼀并配置进来
 }
 },
})

封装请求方法

先引入封装好的方法，在要调用的接口重新封装成一个方法暴露出去

// get 请求
export function httpGet({
 url,
 params = {}
}) {
 return new Promise((resolve, reject) => {
 axios.get(url, {
 params
 }).then((res) => {
 resolve(res.data)
 }).catch(err => {
 reject(err)
 })
 })
}
// post
// post请求
export function httpPost({
 url,
 data = {},
 params = {}
}) {
 return new Promise((resolve, reject) => {
 axios({
 url,
 method: 'post',
 transformRequest: [function (data) {
 let ret = ''
 for (let it in data) {
 ret += encodeURIComponent(it) + '=' +
encodeURIComponent(data[it]) + '&'
 }
 return ret
}],
 // 发送的数据
 data,
 // •url参数
 params
 }).then(res => {
 resolve(res.data)
 })
 })
}

把封装方法放在一个api.js文件中

import { httpGet, httpPost } from './http'
export const getorglist = (params = {}) => httpGet({ url:
'apps/api/org/list', params })

页面中就能直接调用

// .vue
import { getorglist } from '@/assets/js/api'
getorglist({ id: 200 }).then(res => {
 console.log(res)
})

这样可以把api统一管理起来，以后维护修改只需要在api.js文件操作即可

请求拦截器

请求拦截器可以在每个请求里加上token，做了统一处理后后期维护起来也方便

// 请求拦截器
axios.interceptors.request.use(
 config => {
 // 每次发送请求之前判断是否存在token
 // 如果存在，则统⼀在http请求的header都加上token，这样后台根据token判断你的登录
情况，此处token⼀般是⽤户完成登录后储存到localstorage⾥的
 token && (config.headers.Authorization = token)
 return config
 },
 error => {
 return Promise.error(error)
 })

响应拦截器

响应拦截器可以在接收到响应后先做一层操作，如根据状态码判断登录状态，授权

// 响应拦截器
axios.interceptors.response.use(response => {
 // 如果返回的状态码为200，说明接⼝请求成功，可以正常拿到数据
 // 否则的话抛出错误
 if (response.status === 200) {
 if (response.data.code === 511) {
 // 未授权调取授权接⼝
 } else if (response.data.code === 510) {
 // 未登录跳转登录⻚
 } else {
 return Promise.resolve(response)
 }
 } else {
 return Promise.reject(response)
 }
}, error => {
 // 我们可以在这⾥对异常状态作统⼀处理
 if (error.response.status) {
 // 处理请求失败的情况
 // 对不同返回码对相应处理
 return Promise.reject(error.response)
 }
})

小结

· 封装时编程中很有意义的手段，简单的axios封装，就可以让我们可以领略到它的魅力

· 封装axios没有一个绝对的标准，只要你的封装可以满足你的项目需求，并且用起来方便，那就是一个好的封装方案