一、axios是什么

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

1.特性

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

    2.基本使用

    安装
    1. // 项目中安装
    2. npm install axios --S
    3. // cdn 引入
    4. <script src="https://unpkg.com/axios/dist/axios.min.js"></script>
    导入
    1. import axios from 'axios'
    发送请求
    1. axios({        
    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. })
    并发执行aixos.all([]) ```javascript function getUserAccount() { return axios.get(‘/user/btqf’); }

function getUserPermissions() { return axios.get(‘/user/btqf/permissions’); }

axios.all([getUserAccount(), getUserPermissions()]) .then(axios.spread(function (res1, res2) { // res1第一个请求的返回的内容，res2第二个请求返回的内容 // 两个请求都执行完成才会执行 }));

  1. <a name="lVQIT"></a>
  2. ## 二、为什么要封装
  3. `axios`的 API 很友好，我们可以很轻松地在项目中直接使用。<br />但是随着项目规模的增大，如果每发起一次`HTTP`请求，就要把这些比如设置超时时间、设置请求头、根据项目环境判断使用哪个请求地址、错误处理等操作，都要重写一遍，这种重复劳动不仅浪费时间，而且让代码变得冗余不堪，难以维护。<br />为了提供我们的代码质量，我们应该在项目中二次封装`axios`，再进行使用。<br />举个例子：
  4. ```javascript
  5. axios('http://localhost:3000/data', {
  6.   // 配置代码
  7.   method: 'GET',
  8.   timeout: 1000,
  9.   withCredentials: true,
  10.   headers: {
  11.     'Content-Type': 'application/json',
  12.     Authorization: 'xxx',
  13.   },
  14.   transformRequest: [function (data, headers) {
  15.     return data;
  16.   }],
  17.   // 其他请求配置...
  18. })
  19. .then((data) => {
  20.   // todo: 真正业务逻辑代码
  21.   console.log(data);
  22. }, (err) => {
  23.   // 错误处理代码  
  24.   if (err.response.status === 401) {
  25.   // handle authorization error
  26.   }
  27.   if (err.response.status === 403) {
  28.   // handle server forbidden error
  29.   }
  30.   // 其他错误处理.....
  31.   console.log(err);
  32. });

如果每个页面都发送类似的请求，都要写一堆的配置与错误处理，就显得过于繁琐。
这时候我们就需要对axios进行二次封装，让使用更为便利。

三、如何封装

封装的时候，我们需要与后端协商好一些约定，如请求头、状态码、请求超时时间….

  • 设置接口请求前缀：根据开发、测试、生产环境的不同，前缀需要加以区分
  • 请求头：实现一些具体的业务，必须携带一些参数才可以请求（例如会员业务）
  • 状态码：根据接口返回的不同status，来执行不同的业务，这块需要和后端约定好
  • 请求方法：根据get、post等方法进行一个再次封装，使用起来更为方便
  • 请求拦截器：根据请求头设定，来决定哪些请求可以访问
  • 响应拦截器：根据后端返回来的状态码来判断执行不同的业务

    1、设置接口请求前缀

    根据node环境变量来作判断，用来区分开发、测试、生产环境
    1. if (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实现代理转发，从而实现跨域
    1. devServer: {
    2.   proxy: {
    3.     '/proxyApi': {
    4.       target: 'http://dev.xxx.com',
    5.       changeOrigin: true,
    6.       pathRewrite: {
    7.         '/proxyApi': ''
    8.       }
    9.     }
    10.   }
    11. }

    2、设置请求头与超时时间

    大部分情况下，请求头都是固定的，只有少部分情况下，会需要一些特殊的请求头，这里将普适性的请求头作为基础配置。当需要特殊请求头时，将特殊请求头作为参数传入，覆盖基础配置。
    1. const 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. })

    3、封装请求方法

    先引入封装好的方法，在要调用的接口重新封装成一个方法暴露出去。、 ```javascript // get 请求 export function httpGet({ url, params = {} }) { return new Promise((resolve, reject) => { axios.get(url, {
    1. params
    }).then((res) => {
    1. resolve(res.data)
    }).catch(err => {
    1. 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

  1. }).then(res => {
  2.   resolve(res.data)
  3. })

}) }

  1. 把封装的方法放在一个`api.js`文件中
  2. ```javascript
  3. import { httpGet, httpPost } from './http'
  4. export const getorglist = (params = {}) => httpGet({ url: 'apps/api/org/list', params })

在页面中就能直接调用

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

如此一来我们可以将api进行统一管理，以后维护修改只需要在api.js文件操作即可。

4、请求拦截器

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

  1. // 请求拦截器
  2. axios.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.   })

5、响应拦截器

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

  1. // 响应拦截器
  2. axios.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 没有一个绝对的标准，只要你的封装可以满足你的项目需求，并且用起来方便，那就是一个好的封装方案。