axios请求中断cancelToken

前端页面,有的筛选条件是radio单选框,用户便能快速并且多次点击。这样就会导致存在多个接口同时在请求,响应成功的顺序不确定(响应的时间不确定),就会导致最后一次点击响就回来的数据,可能会被之前点击响应回来的数据替换掉,或者会重复添加。所以在请求前,要先将之前的请求中断掉。

axios的config中提供了一个 AbortController(新)与cancelToken(旧)的属性来取消请求。下面有两种方式取消请求。

AbortController:从 v0.22.0 开始,Axios 支持以 fetch API 方式—— AbortController 取消请求。

CancelToken:此 API 从 v0.22.0 开始已被弃用,不应在新项目中使用。

AbortController方式:(推荐使用该方式)

注意:利用拦截器的config配置取消请求,请参数下面的CancelToken的示例。

const controller = new AbortController();
axios.get('/foo/bar', {
   signal: controller.signal
}).then(function(response) {
   //...
});
// 取消请求
controller.abort();

在过渡期间,您可以使用这两种取消 API,即使是针对同一个请求:

const controller = new AbortController();

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

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

axios.post('/user/12345', {
  name: 'new name'
}, {
  cancelToken: source.token
})

// 取消请求 (message 参数是可选的)
source.cancel('Operation canceled by the user.');
// 或
controller.abort(); // 不支持 message 参数

=====================================================================================================================================

CancelToken方式一:利用拦截器的config配置取消请求cancelToken。

注:为了简单演示,所以用全局变量window.API_URL_REQUEST_LIST缓存取消请求函数,建议开发人员配置到Vuex、pinia等状态管理库中。

import axios from 'axios';

//声明全局变量,缓存(中断)函数
if(window.API_URL_REQUEST_LIST === undefined){
    window.API_URL_REQUEST_LIST = [];
}

const service = axios.create({
    //baseURL: '/jeecg-boot',
    timeout: 9E3, // 请求超时时间9秒
});
//请求前,拦截器
service.interceptors.request.use(config => {
    if(!config.cancelToken){//添加判断,允许用户使用方式二,否则方式二的cancelToken只会被替换
        config.cancelToken = new axios.CancelToken(cancel => {
            let obj = {
                cancel:cancel,//cancel是个函数function
                url:config.url,
                cancelUuid:config.cancelUuid,
            };
            window.API_URL_REQUEST_LIST.push(obj);
        });
    }
    return config;
}, (error) => {
    return Promise.reject(error);
});

//响应后,拦截器
service.interceptors.response.use((response) => {
    let {url,cancelUuid} = response.config.url;
    window.API_URL_REQUEST_LIST.forEach((element,index) => {
        if(element.url === url && element.cancelUuid === cancelUuid){
            window.API_URL_REQUEST_LIST.splice(index, 1);//删除cancel函数
        }
    });
    return response.data;
}, err);


//import { axios } from '**/**';//导出
export {
    service as axios
}

Vue组件:按钮快速且多次点击,每次请求前都会中断之前的请求。

<template>
    <button @click="getDataList">请频繁点击</button>
</template>
<script>
import { axios } from '**/**';//导出
export default {
  name: 'Vue2',
  data() {
    return {
      params: {
        id: 888,
      },
    }
  },
  mounted() {
  },
  methods: {
    getDataList(){
        let url = '/apis/**/getById';
        let cancelUuid = `uuid_${Date.now()}_${parseInt(Math.random() * 1E12)}`;//唯一标识
        //中断请求
        if(window.API_URL_REQUEST_LIST){
            window.API_URL_REQUEST_LIST.forEach((element,index) => {
                if(element.url === url && element.cancelUuid === cancelUuid){
                    let cancel = obj[url];
                    cancel();//中断函数执行
                    window.API_URL_REQUEST_LIST.splice(index, 1);//删除cancel函数
                }
            });
        }
        return axios({
            url: url,
            method: 'get',
            params: this.params,
            cancelUuid,
        }).then(()=>{
            //请求成功,这里执行
        }).catch(()=>{
            //中断请求,这里执行
        });
    }
  },
}
</script>

====================================================================================================================================================

CancelToken方式二:将cancelToken直接写在axios({})参数内。

Vue组件:按钮快速且多次点击,每次请求前都会中断之前的请求。

<template>
    <button @click="getDataList">请频繁点击</button>
</template>
<script>
import _Axios_ from 'axios';
import { axios } from '**/**';//导出
export default {
  name: 'Vue2',
  data() {
    return {
      params: {
        id: 888,
      },
    }
  },
  mounted() {
  },
  methods: {
    //写法1:
    getDataList(){
        //中断请求,写法1
        if(this.sourceList === undefined){
            this.sourceList = [];
        }else{
            this.sourceList.forEach(element => element.cancel('发起新请求了,中断之前的请求!'));// 取消请求(message 参数是可选的)
            this.sourceList = [];
        }
        let source = _Axios_.CancelToken.source();
        this.sourceList.push(source);

        return axios({
            url: '/apis/**/getById',
            method: 'get',
            params: this.params,
            cancelToken:source.token,
        }).then(()=>{
            //请求成功,这里执行
        }).catch(()=>{
            //中断请求,这里执行
        }).finally(()=>{
            
        });
    },
    //写法2:
    getDataList2(){
        //中断请求,写法2
        if(this.cancelList === undefined){
            this.cancelList = [];
        }else{
            this.cancelList.forEach(element => element('发起新请求了,中断之前的请求!'));// 取消请求(message 参数是可选的)
            this.cancelList = [];
        }
        return axios({
            url: '/apis/**/getById',
            method: 'get',
            params: this.params,
            cancelToken: new _Axios_.CancelToken(cancel=>{
                this.cancelList.push(cancel);
            }),
        }).then(()=>{
            //请求成功,这里执行
        }).catch(()=>{
            //中断请求,这里执行
        }).finally(()=>{
            
        });
    },
  },
}
</script>

参考链接:

https://www.npmjs.com/package/axios

https://www.axios-http.cn/docs/cancellation

http://axios-js.com/zh-cn/docs/index.html

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,193评论 6 498
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,306评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 162,130评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,110评论 1 292
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,118评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,085评论 1 295
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,007评论 3 417
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,844评论 0 273
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,283评论 1 310
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,508评论 2 332
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,667评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,395评论 5 343
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,985评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,630评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,797评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,653评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,553评论 2 352

推荐阅读更多精彩内容