什么是Axios

Axios 是一个基于 promise 的 HTTP 库，简单的讲就是可以发送get、post请求。

前端常用的`http`请求发送方式有哪些

axios (后文详细描述)
ajax (就可以理解成jQuery)
fetch (Fetch 是浏览器提供的原生 AJAX 接口。作用和axios一样，不过axios配置更为方便)

Axios 特性

可以在浏览器中发送 XMLHttpRequests
可以在 node.js 发送 http 请求
支持 Promise API
拦截请求和响应
转换请求数据和响应数据
能够取消请求
自动转换 JSON 数据
户端支持保护安全免受 XSRF 攻击

Axios使用场景

浏览器发送请求，或者Node.js发送请求都可以用到Axios
用最直白的话说，只要是前端框架(Vue, React, Express....)写的都可以用axios,html三件套写的，我劝你还是用JQuery吧，省心省力

Axios的使用

1. 安装

1.1 npm 安装

$ npm install axios

1.2 CDN引入

<script src="https://unpkg.com/axios/dist/axios.min.js"></script>

2. 使用

2.1 常规使用

模块引入后就可以直接使用了

import axios from 'axios' // 不能忘记引入模块
// GET请求
axios.get('/user', {
  params: {
    id: 12345
  }
}.then(function (res) {
  console.log(res)
}).catch(function (error) {
  console.log(err)
})

// POST
axios.post('/user', {
  name: '江南小魏晨',
  email: 'www.wyyangyong9223@163.com'
}).then(function (res) {
  console.log(res)
}).catch(function (err) {
  console.log(err)
})

2.2 特殊使用

Axios 本身支持 Promise API 因此， Axios 接受并发请求

const axiosRequest1 = axios.get('/user')
const axiosRequest2 = axios.post('/login')
// 注意，这里axios.all()里接收的一定是一个【axios】请求的数组
axios.all([axiosRequest1, axiosRequest2]).then(res => {
    // 这里的res 也是返回值数组
    // 数组的排序，就是axios.all()中数组的排序
    [axiosRequest1Response, axiosRequest2Response] = res
    // 这里拿到数据，一定会是两个请求，全部执行完成
}).catch(err => {
    // 这里对axios进行错误处理
    // 只要传入的接口数组中有一个接口执行错误，都会走到这里
})

2.3 配置使用

也可以通过配置的形式，对Axios进行使用

// POST
axios({
  method: 'post',
  url: '/user/12345',
  data: {
    firstName: '小魏晨',
    lastName: '江南'
  }
})

语法

axios(url[, config])

可配置项

{
  // `url` 是用于请求的服务器地址
  url: '/user',
  // `method` 是创建请求时使用的方式
  // 请求方式 的种类 `GET` `POST` `PUT` `DELETE` `CONNECT` `OPTIONS` `TRACE` `HEAD`
  // 一般情况下 GET POST 已经足够满足常规请求了， 能用到 PUT DELETE 已经算后台玩的花了
  method: 'POST', // 默认是 post
  // `baseURL` 将自动拼接 `url` 前面，除非 `url` 是一个绝对 url (比如url是www.google.com)。
  // 它可以通过设置一个 `baseURL` 便于为 axios 实例的方法传递相对 url
  baseURL: 'http://localhost:9090/api/',
  // `transformRequest` 允许在向服务器发送前，修改请求数据
  // 只能用在 'PUT', 'POST' 和 'PATCH' 这几个请求方法
  // 后面数组中的函数必须返回一个字符串，或 ArrayBuffer，或 Stream
  transformRequest: [function (data) {
    // 对 data 进行任意转换处理

    return data;
  }],
  // `transformResponse` 在传递给 then/catch 前，允许修改响应数据
  transformResponse: [function (data) {
    // 对 data 进行任意转换处理

    return data;
  }],
  // `headers` 是即将被发送的自定义请求头
  headers: {'X-Requested-With': 'XMLHttpRequest'},
  // `params` 是即将与请求一起发送的 URL 参数
  // 通俗点说，get请求，拼接在url后面的参数
  // 必须是一个无格式对象(plain object)或 URLSearchParams 对象
  params: {
    id: 12345
  },
  // `paramsSerializer` 是一个负责 `params` 序列化的函数
  // (e.g. https://www.npmjs.com/package/qs, http://api.jquery.com/jquery.param/)
  // 常用的序列化方式 qs 或者 JSON.stringify()
  paramsSerializer: function(params) {
    return Qs.stringify(params, {arrayFormat: 'brackets'})
  },
  // `data` 是作为请求主体被发送的数据
  // 只适用于这些请求方法 'PUT', 'POST', 和 'PATCH'
  // 在没有设置 `transformRequest` 时，必须是以下类型之一：
  // - string, plain object, ArrayBuffer, ArrayBufferView, URLSearchParams
  // - 浏览器专属：FormData, File, Blob
  // - Node 专属： Stream
  data: {
    firstName: '江南小魏晨'
  },
  // `timeout` 指定请求超时的毫秒数(0 表示无超时时间)
  // 如果请求话费了超过 `timeout` 的时间，请求将被中断
  timeout: 1000 * 30, // 30秒
  // `withCredentials` 表示跨域请求时是否需要使用凭证
  withCredentials: false, // 默认的
  // `adapter` 允许自定义处理请求，以使测试更轻松
  // 返回一个 promise 并应用一个有效的响应 (查阅 [response docs](#response-api)).
  adapter: function (config) {
    /* ... */
  },
  // `auth` 表示应该使用 HTTP 基础验证，并提供凭据
  // 这将设置一个 `Authorization` 头，覆写掉现有的任意使用 `headers` 设置的自定 `Authorization`头
  auth: {
    username: 'janedoe',
    password: 's00pers3cret'
  },
  // `responseType` 表示服务器响应的数据类型，可以是 'arraybuffer', 'blob', 'document', 'json', 'text', 'stream'
  responseType: 'json', // 默认的
  // `xsrfCookieName` 是用作 xsrf token 的值的cookie的名称
  xsrfCookieName: 'XSRF-TOKEN', // default

  // `xsrfHeaderName` 是承载 xsrf token 的值的 HTTP 头的名称
  xsrfHeaderName: 'X-XSRF-TOKEN', // 默认的

  // `onUploadProgress` 允许为上传处理进度事件
  onUploadProgress: function (progressEvent) {
    // 对原生进度事件的处理
  },

  // `onDownloadProgress` 允许为下载处理进度事件
  onDownloadProgress: function (progressEvent) {
    // 对原生进度事件的处理
  },

  // `maxContentLength` 定义允许的响应内容的最大尺寸
  maxContentLength: 2000,

  // `validateStatus` 定义对于给定的HTTP 响应状态码是 resolve 或 reject  promise 。如果 `validateStatus` 返回 `true` (或者设置为 `null` 或 `undefined`)，promise 将被 resolve; 否则，promise 将被 rejecte
  validateStatus: function (status) {
    return status >= 200 && status < 300; // 默认的
  },

  // `maxRedirects` 定义在 node.js 中 follow 的最大重定向数目
  // 如果设置为0，将不会 follow 任何重定向
  maxRedirects: 5, // 默认的
  // `httpAgent` 和 `httpsAgent` 分别在 node.js 中用于定义在执行 http 和 https 时使用的自定义代理。允许像这样配置选项：
  // `keepAlive` 默认没有启用
  httpAgent: new http.Agent({ keepAlive: true }),
  httpsAgent: new https.Agent({ keepAlive: true }),

  // 'proxy' 定义代理服务器的主机名称和端口
  // `auth` 表示 HTTP 基础验证应当用于连接代理，并提供凭据
  // 这将会设置一个 `Proxy-Authorization` 头，覆写掉已有的通过使用 `header` 设置的自定义 `Proxy-Authorization` 头。
  proxy: {
    host: '127.0.0.1',
    port: 9090,
    auth: : {
      username: '江南小魏晨',
      password: '123456'
    }
  },
  // `cancelToken` 指定用于取消请求的 cancel token
  cancelToken: new CancelToken(function (cancel) {
  })
}

3. Axios的封装

结合上面的Axios的使用，我们可以结合 javascript ES6 的模块化想法将 Axios 作为一个单独的模块，独立出来，将所有开发中需要的共同参数，比如baseUrl,token等等这些内容放到一个 Axios 实例中通过对该实例的使用，从而实现Axios的复用

/**
 * @TODO axios 及 axios拦截配置
 * @author 江南小魏晨
 */
import axios from 'axios'
import router from '@/router' // 这里可以忽略 vue/react的路由
// 创建axios实例 添加axios基础配置项
const request = axios.create({
  baseURL: import.meta.env.VITE_BASE_URL,
  headers: {
    // 默认请求头为 application/json 请求
    'Content-Type': 'application/json;charset=utf8'
  },
  // 默认请求方式为 post 请求
  method: 'POST'
})

// 请求拦截配置
request.interceptors.request.use(
  (config) => {
    // 获取本地存储token信息
    const token = window.localstorage.getItem('token')
    // 校验token存在与否 存在 -> 默认添加token
    if (token) {
      config.headers.token = token
    }
    return Promise.resolve(config)
  },
  (err) => {
    return Promise.reject(err)
  }
)

// request 响应拦截
request.interceptors.response.use(
  (res) => {
    // 200 状态 -> 默认成功
    return Promise.resolve(res.data)
  },
  ({ response }) => {
    // 非200状态码 根据返回情况进行接口区分
    console.error(response)
    console.warn(response.status)
    switch (response.status) {
    case 302: // 未登录状态
      router.push('/login')
      StorageUtils.removeLocal('token')
      return Promise.reject(response.data)
    default:
      return Promise.reject(response)
    }
  }
)

export default request

4. 取消请求

场景：一个搜索框，每次输入字符都会调用接口，这时候没有办法来知道那个接口数据放回是最后一次的，只能取消之前发起的相同接口，所以就有了取消接口。(此时最好配合防抖节流)一起使用，效果最佳

const CancelToken = axios.CancelToken;
const source = CancelToken.source();

axios.get('/user/12345', {
  cancelToken: source.token
}).catch(res => {
  if (axios.isCancel(res)) {
    console.log('Request canceled', res.message);
  } else {
    // 处理错误
  }
});

// 取消请求（message 参数是可选的）
source.cancel('这个请求我不想发了');

Axios的常规使用及拦截配置