axios

学习axios请务必对promise和ajax有了解。

axios是什么？

  1. 前端最流行的 ajax 请求库
  2. react/vue 官方都推荐使用 axios 发 ajax 请求
  3. 文档: https://github.com/axios/axios

axios的特点

  1. 基于XHR和promise的异步Ajax请求库。
  2. 支持浏览器端和服务器端（nodejs）。
  3. 支持请求拦截器和响应拦截器。
  4. 支持请求取消
  5. 支持请求和响应数据装换。
  6. 批量发送多个请求。

API（常用）

  1. axios(config): 通用/最本质的发任意类型请求的方式。
  2. axios(url[, config]): 可以只指定 url 发 get 请求。
  3. axios.request(config): 等同于 axios(config)。
  4. axios.get(url[, config]): 发 get 请求。
  5. axios.delete(url[, config]): 发 delete 请求。
  6. axios.post(url[, data, config]): 发 post 请求。
  7. axios.put(url[, data, config]): 发 put 请求。
  8. axios.defaults.xxx: 请求的默认全局配置。
  9. axios.interceptors.request.use(): 添加请求拦截器。
  10. axios.interceptors.response.use(): 添加响应拦截器。
  11. axios.create([config]): 创建一个新的 axios(它没有下面的功能)。
  12. 根据指定配置创建一个新的 axios, 也就就每个新 axios 都有自己的配置
  13. 新 axios 只是没有取消请求和批量发请求的方法, 其它所有语法都是一致的
  14. 为什么要设计这个语法?
    • 需求: 项目中有部分接口需要的配置与另一部分接口需要的配置不太一
      样, 如何处理
    • 解决: 创建 2 个新 axios, 每个都有自己特有的配置, 分别应用到不同要求的接口请求中。
  15. axios.Cancel(): 用于创建取消请求的错误对象。
  16. axios.CancelToken(): 用于创建取消请求的 token 对象。
  17. axios.isCancel(): 是否是一个取消请求的错误。
  18. axios.all(promises): 用于批量执行多个异步请求。
  19. axios.spread(): 用来指定接收所有成功数据的回调函数的方法。

拦截器函数/ajax 请求/请求的回调函数的调用顺序

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
// Promise
// 设置请求拦截器  config 配置对象
axios.interceptors.request.use(function (config) {
    console.log('请求拦截器 成功 - 1号');

    //...

    return config;
}, function (error) {
    console.log('请求拦截器 失败 - 1号');
    return Promise.reject(error);
});

axios.interceptors.request.use(function (config) {
    console.log('请求拦截器 成功 - 2号');

    //...

    return config;
}, function (error) {
    console.log('请求拦截器 失败 - 2号');
    return Promise.reject(error);
});

// 设置响应拦截器
axios.interceptors.response.use(function (response) {
    console.log('响应拦截器 成功 1号');
    return response.data;
    // return response;
}, function (error) {
    console.log('响应拦截器 失败 1号')
    return Promise.reject(error);
});

axios.interceptors.response.use(function (response) {
    console.log('响应拦截器 成功 2号')
    return response;
}, function (error) {
    console.log('响应拦截器 失败 2号')
    return Promise.reject(error);
});

//发送请求
axios({
    method: 'GET',
    url: 'http://localhost/xxxx'
}).then(response => {
    console.log('自定义回调处理成功的结果');
    console.log(response);
});
  1. 说明: 调用 axios()并不是立即发送 ajax 请求, 而是需要经历一个较长的流程
  2. 流程: 请求拦截器2 => 请求拦截器1 => 发ajax请求 => 响应拦截器1 => 响
    应拦截器 2 => 请求的回调。（上面代码先添加请求和响应拦截器1，再添加拦截器2，注意区分。）
  3. 注意: 此流程是通过 promise 串连起来的, 请求拦截器传递的是 config, 响应拦截器传递的是 response。

取消请求

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
<body>
    <div class="container">
        <h2 class="page-header">axios取消请求</h2>
        <button class="btn btn-primary"> 发送请求 </button>
        <button class="btn btn-warning" > 取消请求 </button>
    </div>
    <script>
        //获取按钮
        const btns = document.querySelectorAll('button');
        //2.声明全局变量
        let cancel = null;
        //发送请求
        btns[0].onclick = function(){
            //检测上一次的请求是否已经完成
            if(cancel !== null){
                //取消上一次的请求
                cancel();
            }
            axios({
                method: 'GET',
                url: 'http://localhost:3000/posts',
                //1. 添加配置对象的属性
                cancelToken: new axios.CancelToken(function(c){
                    //3. 将 c 的值赋值给 cancel
                    cancel = c;
                })
            }).then(response => {
                console.log(response);
                //将 cancel 的值初始化
                cancel = null;
            })
        }

        //绑定第二个事件取消请求
        btns[1].onclick = function(){
            cancel();
        }
    </script>   
</body>
  1. 基本流程
    • 配置 cancelToken 对象
    • 缓存用于取消请求的 cancel 函数
    • 在后面特定时机调用 cancel 函数取消请求
    • 在错误回调中判断如果 error 是 cancel, 做相应处理
  2. 实现功能
    点击按钮, 取消某个正在请求中的请求在请求一个接口前, 取消前面一个未完成的请求。

源码分析

访问 https://github1s.com/axios/axios 方便查看源码，当然也可以clone到本地。

1. axios 与 Axios 的关系

  1. 从语法上来说: axios 不是 Axios 的实例。
  2. 从功能上来说: axios 是 Axios 的实例。
  3. axios 是 Axios.prototype.request 函数 bind()返回的函数。
  4. axios 作为对象有 Axios 原型对象上的所有方法, 有 Axios 对象上所有属性。

2. instance 与 axios 的区别？

  1. 相同:
    (1) 都是一个能发任意请求的函数: request(config)。
    (2) 都有发特定请求的各种方法: get()/post()/put()/delete()。
    (3) 都有默认配置和拦截器的属性: defaults/interceptors。
  2. 不同:
    (1) 默认配置很可能不一样。
    (2) instance 没有 axios 后面添加的一些方法: create()/CancelToken()/all()。

3. axios 运行的整体流程

  1. 整体流程：request(config) ==> dispatchRequest(config) ==> xhrAdapter(config)。
  2. request(config)：将请求拦截器 / dispatchRequest() / 响应拦截器 通过 promise 链串连起来，返回 promise。
  3. dispatchRequest(config)：转换请求数据 ===> 调用 xhrAdapter()发请求 ===> 请求返回后转换响应数
    据. 返回 promise
  4. xhrAdapter(config)：创建 XHR 对象, 根据 config 进行相应设置, 发送特定请求, 并接收响应数据,
    返回 promise

4. axios 的请求/响应拦截器是什么?

  1. 请求拦截器:
    • 在真正发送请求前执行的回调函数
    • 可以对请求进行检查或配置进行特定处理
    • 成功的回调函数, 传递的默认是 config(也必须是)
    • 失败的回调函数, 传递的默认是 error
  2. 响应拦截器
    • 在请求得到响应后执行的回调函数
    • 可以对响应数据进行特定处理
    • 成功的回调函数, 传递的默认是 response
    • 失败的回调函数, 传递的默认是 error

5. axios 的请求/响应数据转换器是什么?

  1. 请求转换器: 对请求头和请求体数据进行特定处理的函数

    1
    2
    3
    4
    if (utils.isObject(data)) {
       setContentTypeIfUnset(headers, 'application/json;charset=utf-8');
       return JSON.stringify(data);
    }

  2. 响应转换器: 将响应体 json 字符串解析为 js 对象或数组的函数

    1
    response.data = JSON.parse(response.data)

6. response 的整体结构

1
2
3
4
5
6
7
8
{
   data,
   status,
   statusText,
   headers,
   config,
   request
}

7. error 的整体结构

1
2
3
4
5
{
   message,
   response,
   request,
}

8. 如何取消未完成的请求?

  1. 当配置了 cancelToken 对象时, 保存 cancel 函数
    (1) 创建一个用于将来中断请求的 cancelPromise
    (2) 并定义了一个用于取消请求的 cancel 函数
    (3) 将 cancel 函数传递出来
  2. 调用 cancel()取消请求
    (1) 执行 cacel 函数, 传入错误信息 message
    (2) 内部会让 cancelPromise 变为成功, 且成功的值为一个 Cancel 对象
    (3) 在 cancelPromise 的成功回调中中断请求, 并让发请求的 proimse 失败,
    失败的 reason 为 Cancel 对象

手写源码

//…

参考

  1. axios
  2. 《尚硅谷axios入门到源码分析》