axios特点、常用语法、发ajax请求、create方法、拦截器、取消请求、拦截器实现复用功能、当发送一个请求之后，再发送第二个请求，会自动取消前一个请求，源码分析

发布于：2023-01-19 ⋅ 阅读:(367) ⋅ 点赞:(0)

目录

axios特点

1、基于promise的封装XHR的异步ajax请求库
2、 浏览器端/node端都可以使用
3、支持请求／响应拦截器
4、 支持请求取消
5、请求/响应数据转换
6、批量发送多个请求

axios常用语法

axios(config): 通用/最本质的发任意类型请求的方式
axios(url[, config]): 可以只指定url发get请求
axios.request(config): 等同于axios(config)
axios.get(url[, config]): 发get请求
axios.delete(url[, config]): 发delete请求
axios.post(url[, data, config]): 发post请求
axios.put(url[, data, config]): 发put请求

axios.defaults.xxx: 请求的默认全局配置
axios.interceptors.request.use(): 添加请求拦截器
axios.interceptors.response.use(): 添加响应拦截器

axios.create([config]): 创建一个新的axios(它没有下面的功能)

axios.Cancel(): 用于创建取消请求的错误对象
axios.CancelToken(): 用于创建取消请求的token对象
axios.isCancel(): 是否是一个取消请求的错误
axios.all(promises): 用于批量执行多个异步请求
axios.spread(): 用来指定接收所有成功数据的回调函数的方法

发ajax请求

<script>
//指定默认配置
axios.defaults.baseURL = 'http://localhost:3000'
/* 1. GET 请求: 从服务器端获取数据*/
function testGet() {
    axios({
        url:'/posts',
        params:{
            id:1
        }
    }).then(response=>{
        console.log(response.data);
    });
    }
/* 2. POST 请求: 向服务器端添加新数据*/
function testPost() {
    // axios.post('/posts', {'title': 'xxx', 'author':'yyyy'})//对象形式
    axios({
        url:'/posts',
        method:'post',
        data:{
            'title': 'lll',
             'author':'www'
            }
    })
    .then(response=>{
        console.log(response.data);
    }) // 保存数据
    }
    /* 3. PUT 请求: 更新服务器端以及数据 */
function testPut() {
    // axios.put('http://localhost:3000/comments/1', {body: 'yyy', postId: 2})
    axios({
        url:'/comments/1',
        method:'PUT',
        data:{
            'body': 'yyy',
            'postId': 2
        }
    })
    .then(response=>{
        console.log(response.data);
    })
    }
/* 4. DELETE 请求: 删除服务器端数据 */
function testDelete() {
    // axios.delete('http://localhost:3000/posts/18')
    axios({
        url:'/posts/18',
        method:'DELETE'
    })
    .then(response=>{
        console.log(response.data);
    })
    }
</script>

create方法

1、根据指定配置创建一个新的 axios, 也就就每个新 axios 都有自己的配置
2、新 axios 只是没有取消请求和批量发请求的方法, 其它所有语法都是一致的
3、axios.create()返回的对象与axios的区别：

  • 相同点:
    • 都是一个能发任意请求的函数: request(config)
    • 都有发特定请求的各种方法: get()/post()/put()/delete()
    • 都有默认配置和拦截器的属性: defaults/interceptors
  • 不同点:
    • 默认匹配的值不一样
    • instance没有axios后面添加的一引起方法: create()/CancelToken()/all()
      4、为什么要设计这个语法?
      (1) 需求: 项目中有部分接口需要的配置与另一部分接口需要的配置不太一样, 如何处理
      (2) 解决: 创建 2 个新 axios, 每个都有自己特有的配置, 分别应用到不同要求的接口请求中
        const instance = axios.create({
            baseURL:'http://localhost:3000',
        })
        //使用instance发请求
        instance({
            url:'/posts',
        })

拦截器

axios的请求/响应拦截器是什么?
（1）请求拦截器: 在真正发请求前, 可以对请求进行检查或配置进行特定处理的函数,成功的回调函数, 传递的默认是 config(也必须是),失败的回调函数, 传递的默认是 error

//添加请求连接器(回调函数)
axios.interceptors.request.use(config => {
return config;
},error => {
return Promise.reject(error);
});

（2） 响应拦截器: 在请求返回后, 可以对响应数据进行特定处理的函数,成功的回调函数, 传递的默认是 response,失败的回调函数, 传递的默认是 error

//添加响应拦截器
axios.interceptors.response.use(
    response => {
        return response
    },
    error => {
        return Promise.reject(error)
    }
)

axios的处理链流程：
说明: 调用 axios()并不是立即发送 ajax 请求, 而是需要经历一个较长的流程
流程: 请求拦截器2 => 请求拦截器 1 => 发ajax请求 => 响应拦截器1 => 响应拦截器 2 => 请求的回调
注意: 此流程是通过 promise 串连起来的, 请求拦截器传递的是 config, 响应拦截器传递的是 respons

取消请求

  1. 基本流程
    配置 cancelToken 对象
    缓存用于取消请求的 cancel 函数
    在后面特定时机调用 cancel 函数取消请求
    在错误回调中判断如果 error 是 cancel, 做相应处理

拦截器实现复用功能

点击前两个获取按钮，发送请求，点击第三个按钮取消请求，当发送一个请求之后，再发送第二个请求，会自动取消前一个请求，拦截器实现该功能的复用，即代码复用率变高。

<body>
    <button onclick="getProducts1()">获取商品列表1</button>
    <button onclick="getProducts2()">获取商品列表2</button>
    <button onclick="cancelReq()">取消请求</button>
    <script src="https://cdn.bootcss.com/axios/0.19.0/axios.js"></script>
    <script>
        //添加请求拦截器
        axios.interceptors.request.use(config => {
            //在准备发请求前，取消未完成的请求
            if (typeof cancel === 'function'){
            cancel("取消请求")
            }
            //给config添加一个cancelToken的配置
            config.cancelToken = new axios.CancelToken( c =>{  //保存取消函数，用于之后可能需要取消当前请求
                    cancel = c
                })
        return config;
        })
        //添加响应拦截器
        axios.interceptors.response.use(
            response => {
                cancel = null
                return response
            },
            error => {
                //判断如果是请求取消的错误，cancle不赋值为null
                if (axios.isCancel(error)){
                    console.log('请求取消的错误',error.message);
                    //中断promise连链接
                    return new Promise(() => {})
                }else{
                    cancel = null
                //将错误向下传递
                return Promise.reject(error)
                }
            }
        )
        let cancel //用于保存取消请求的函数
        function getProducts1() {
            axios({
                method:'get',
                url: 'http://localhost:4000/products1'
            }).then(
                response => {
                     console.log('请求1成功了',response.data);
                },
                error => {
                    console.log('请求1失败了',error.message);
                }
            )
        }
        function getProducts2() {
            axios({
                method:'get',
                url: 'http://localhost:4000/products2',
            }).then(
                response => {
                    console.log('请求2成功了');
                },
                error => {
                    //只用处理请求失败
                    console.log('请求2失败了',response.data);
                }
            )
        }
        function cancelReq() {
            //判断是否发送请求
            if (typeof cancel === 'function'){
            //执行取消请求的函数
            cancel("强制取消请求")
            }else{
                console.log("没有可以取消的请求");
            }
        }
    </script>
</body>

源码分析

源码目录结构

├── /dist/ # 项目输出目录
├── /lib/ # 项目源码目录
│ ├── /adapters/ # 定义请求的适配器 xhr、http
│ │ ├── http.js # 实现 http 适配器(包装 http 包)
│ │ └── xhr.js # 实现 xhr 适配器(包装 xhr 对象)
│ ├── /cancel/ # 定义取消功能
│ ├── /core/ # 一些核心功能
│ │ ├── Axios.js # axios 的核心主类
│ │ ├── dispatchRequest.js # 用来调用 http 请求适配器方法发送请求的函数
│ │ ├── InterceptorManager.js # 拦截器的管理器
│ │ └── settle.js # 根据 http 响应状态，改变 Promise 的状态
│ ├── /helpers/ # 一些辅助方法
│ ├── axios.js # 对外暴露接口
│ ├── defaults.js # axios 的默认配置
│ └── utils.js # 公用工具
├── package.json # 项目信息
├── index.d.ts # 配置 TypeScript 的声明文件
└── index.js # 入口文

axios 与 Axios 的关系

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

axios 运行的整体流程

整体流程:
request(config) ==> dispatchRequest(config) ==> xhrAdapter(config)
request(config):
将请求拦截器 / dispatchRequest() / 响应拦截器 通过 promise 链串连起来, 返回 promise
dispatchRequest(config):
转换请求数据 ===> 调用 xhrAdapter()发请求 ===> 请求返回后转换响应数
据. 返回 promise
xhrAdapter(config):
创建 XHR 对象, 根据 config 进行相应设置, 发送特定请求, 并接收响应数据, 返回 promise
图解：
在这里插入图片描述

如何取消未完成的请求

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

网站公告

今日签到

点亮在社区的每一天
去签到

热门文章

最新发布