axios封装 - 技术栈

一、axios是什么特性基本使用二、为什么要封装三、如何封装设置接口请求前缀设置请求头与超时时间封装请求方法请求拦截器响应拦截器小结

一、axios是什么

axios 是一个轻量的 HTTP客户端

基于 XMLHttpRequest 服务来执行 HTTP 请求，支持丰富的配置，支持 Promise，支持浏览器端和 Node.js 端。自Vue2.0起，尤大宣布取消对 vue-resource 的官方推荐，转而推荐 axios。现在 axios 已经成为大部分 Vue 开发者的首选

特性

从浏览器中创建 XMLHttpRequests
从 node.js 创建 http请求
支持 Promise API
拦截请求和响应
转换请求数据和响应数据
取消请求
自动转换JSON 数据
客户端支持防御XSRF

基本使用

安装

复制代码

1// 项目中安装
2npm install axios --S
3// cdn 引入
4<script src="https://unpkg.com/axios/dist/axios.min.js"></script>

导入

复制代码

1import axios from 'axios'

发送请求

复制代码

1axios({        
2  url:'xxx',    // 设置请求的地址
3  method:"GET", // 设置请求方法
4  params:{      // get请求使用params进行参数凭借,如果是post请求用data
5    type: '',
6    page: 1
7  }
8}).then(res => {  
9  // res为后端返回的数据
10  console.log(res);   
11})

并发请求axios.all([])

复制代码

1function getUserAccount() {
2    return axios.get('/user/12345');
3}
4
5function getUserPermissions() {
6    return axios.get('/user/12345/permissions');
7}
8
9axios.all([getUserAccount(), getUserPermissions()])
10    .then(axios.spread(function (res1, res2) { 
11    // res1第一个请求的返回的内容，res2第二个请求返回的内容
12    // 两个请求都执行完成才会执行
13}));

二、为什么要封装

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

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

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

举个例子：

复制代码

1axios('http://localhost:3000/data', {
2  // 配置代码
3  method: 'GET',
4  timeout: 1000,
5  withCredentials: true,
6  headers: {
7    'Content-Type': 'application/json',
8    Authorization: 'xxx',
9  },
10  transformRequest: [function (data, headers) {
11    return data;
12  }],
13  // 其他请求配置...
14})
15.then((data) => {
16  // todo: 真正业务逻辑代码
17  console.log(data);
18}, (err) => {
19  // 错误处理代码  
20  if (err.response.status === 401) {
21  // handle authorization error
22  }
23  if (err.response.status === 403) {
24  // handle server forbidden error
25  }
26  // 其他错误处理.....
27  console.log(err);
28});

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

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

三、如何封装

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

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

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

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

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

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

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

设置接口请求前缀

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

复制代码

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

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

复制代码

1devServer: {
2    proxy: {
3      '/proxyApi': {
4        target: 'http://dev.xxx.com',
5        changeOrigin: true,
6        pathRewrite: {
7          '/proxyApi': ''
8        }
9      }
10    }
11  }

设置请求头与超时时间

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

复制代码

1const service = axios.create({
2    ...
3    timeout: 30000,  // 请求 30s 超时
4     headers: {
5        get: {
6          'Content-Type': 'application/x-www-form-urlencoded;charset=utf-8'
7          // 在开发中，一般还需要单点登录或者其他功能的通用请求头，可以一并配置进来
8        },
9        post: {
10          'Content-Type': 'application/json;charset=utf-8'
11          // 在开发中，一般还需要单点登录或者其他功能的通用请求头，可以一并配置进来
12        }
13  },
14})

封装请求方法

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

复制代码

1// get 请求
2export function httpGet({
3  url,
4  params = {}
5}) {
6  return new Promise((resolve, reject) => {
7    axios.get(url, {
8      params
9    }).then((res) => {
10      resolve(res.data)
11    }).catch(err => {
12      reject(err)
13    })
14  })
15}
16
17// post
18// post请求
19export function httpPost({
20  url,
21  data = {},
22  params = {}
23}) {
24  return new Promise((resolve, reject) => {
25    axios({
26      url,
27      method: 'post',
28      transformRequest: [function (data) {
29        let ret = ''
30        for (let it in data) {
31          ret += encodeURIComponent(it) + '=' + encodeURIComponent(data[it]) + '&'
32        }
33        return ret
34      }],
35      // 发送的数据
36      data,
37      // url参数
38      params
39
40    }).then(res => {
41      resolve(res.data)
42    })
43  })
44}

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

复制代码

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

页面中就能直接调用

复制代码

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

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

请求拦截器

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

复制代码

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

响应拦截器

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

复制代码

1// 响应拦截器
2axios.interceptors.response.use(response => {
3  // 如果返回的状态码为200，说明接口请求成功，可以正常拿到数据
4  // 否则的话抛出错误
5  if (response.status === 200) {
6    if (response.data.code === 511) {
7      // 未授权调取授权接口
8    } else if (response.data.code === 510) {
9      // 未登录跳转登录页
10    } else {
11      return Promise.resolve(response)
12    }
13  } else {
14    return Promise.reject(response)
15  }
16}, error => {
17  // 我们可以在这里对异常状态作统一处理
18  if (error.response.status) {
19    // 处理请求失败的情况
20    // 对不同返回码对相应处理
21    return Promise.reject(error.response)
22  }
23})

小结

封装是编程中很有意义的手段，简单的axios封装，就可以让我们可以领略到它的魅力
封装 axios 没有一个绝对的标准，只要你的封装可以满足你的项目需求，并且用起来方便，那就是一个好的封装方案