axios 详解

1. axios 特性

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

2. 基本使用

安装：

npm install axios --save

导入：

import axios from 'axios'

发送请求：

axios({
  url: '',
  method: '',
  params: { // GET 请求使用 params 进行参数拼接，POST 请求使用 data
    type: '',
    page: 1
  }
}).then(res => {
  // 成功
}, err => {
  // 失败
})

请求并发：

function getUserAccount() {
  return axios.get('/user/12345')
}

function getUserPermissions() {
  return axios.get('/user/12345/permissions')
}

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

3. 为什么要封装 axios

默认配置项较多，每个请求都重复写很冗余。
项目中接口路径、错误处理、loading、token 注入等逻辑统一在一处维护更清晰。
方便后期切换底层网络库（如从 axios 切换到 fetch 封装层）只改一处。

4. 如何封装

设置接口请求前缀

利用 node 环境变量来判断当前是开发/生产环境：

if (process.env.NODE_ENV === 'development') {
  axios.defaults.baseURL = ''
} else if (process.env.NODE_ENV === 'production') {
  axios.defaults.baseURL = ''
}

在本地调试的时候，还需要在 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=utf-8'
      // 在开发中，一般还需要单点登录或者其他功能的通用请求头，可以一并配置进来
    },
    post: {
      'Content-Type': 'application/json;charset=utf-8'
      // 在开发中，一般还需要单点登录或者其他功能的通用请求头，可以一并配置进来
    }
  }
})

取消请求

// 方式一
const CancelToken = axios.CancelToken
const source = CancelToken.source()

axios.get('xxxx', {
  cancelToken: source.token
})
// 取消请求（请求原因是可选的）
source.cancel('主动取消请求')

// 方式二
const CancelToken = axios.CancelToken
let cancel

axios.get('xxxx', {
  cancelToken: new CancelToken(function executor(c) {
    cancel = c
  })
})
cancel('主动取消请求')

封装请求方法

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

// 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 请求
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,    // 发送的数据
      params   // url 参数
    }).then(res => {
      resolve(res.data)
    })
  })
}

5. 拦截器

请求拦截器

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

// 请求拦截器
axios.interceptors.request.use(
  config => {
    // 每次发送请求之前判断是否存在 token
    // 如果存在，则统一在 http 请求的 header 都加上 token，后台根据 token 判断登录情况
    token && (config.headers.Authorization = token)
    return config
  },
  error => {
    return Promise.reject(error)
  }
)

响应拦截器

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

// 响应拦截器
axios.interceptors.response.use(response => {
  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)
  }
})

来源整理自：vue3js.cn 面试官系列