axios请求中断的几种方法

 更新时间:2024年10月15日 08:25:29   作者:小胖霞  
在实际应用场景中,假如有一个下载或者导出请求,数据量非常大的情况下,接口响应的会很慢,这时候我我们想中断请求,该怎么做呢?本文给大家介绍了axios请求中断的几种方法,需要的朋友可以参考下

背景

在实际应用场景中,假如有一个下载或者导出请求,数据量非常大的情况下,接口响应的会很慢,这时候我我们想中断请求,该怎么做呢?

我们先来看一下axios官方给出的请求中断的方法 AXios请求中断 axios中文网

方法一:传入cancelToken

传入cancelToken,在页面调用request.cancel('中断请求')

api请求代码: axios代码封装request.js

import axios from 'axios'
import { Message, MessageBox } from 'element-ui'
import store from '@/store'
import { getToken } from '@/utils/auth'

const service = axios.create({
  baseURL: process.env.VUE_APP_API, 
  timeout: 1800000 
})
    // 请求拦截
  service.interceptors.request.use(
  config => {
    if (store.getters.token) {
      config.headers['Authorization'] = getToken()
    }
    return config
  },
  error => {
    return Promise.reject(error)
  }
)
// 响应拦截
service.interceptors.response.use(
 
  response => {
    const res = response.data
  
    if (!res.status && response.status === 200) {
      return response
    }
    if (res.status !== '200') {
      Message({
        message: res.message || 'Error',
        type: 'error',
        duration: 5 * 1000,
        dangerouslyUseHTMLString: true
      })
      if (res.status === '401') {
      
        MessageBox.confirm('访问了未授权的资源或者登入状态已失效,你可以继续留在这个页面,或者重新登入', '是否重新登入', {
          confirmButtonText: '重新登入',
          cancelButtonText: '取消',
          type: 'warning'
        }).then(() => {
          // 清空Token,并且重新登入
          store.dispatch('user/resetToken').then(() => {
            location.reload()
          })
        })
      }
      return Promise.reject(new Error(res.message || 'Error'))
    } else {
      return res
    }
  },
  error => {
    if (error.response && error.response.status === 401) {
        MessageBox.confirm('提示', '是否重新登入', {
          confirmButtonText: '重新登入',
          cancelButtonText: '取消',
          type: 'warning'
        }).then(() => {
          // 清空Token,并且重新登入
          store.dispatch('user/resetToken').then(() => {
            location.reload()
          })
      }
      return true
    } else if (error.response && error.response.status === 502) {
      Message({
        message: '502 系统正在重新发布中,请稍后再试',
        type: 'error',
        duration: 5 * 1000
      })
    } else if (error.response && error.response.status === 404) {
      Message({
        message: '404 系统正在重新发布中或请求不存在,请稍后再试',
        type: 'error',
        duration: 5 * 1000
      })
    } else {
      Message({
        message: error.message,
        type: 'error',
        duration: 5 * 1000,
        dangerouslyUseHTMLString: true
      })
    }
    return Promise.reject(error)
  }
)

// api.js
import request from '@/utils/request'
// 这是一个导出接口
export function export(data, cancelToken) {
  return request({
    url: '/order/order-export',
    method: 'post',
    responseType: 'blob',
    data,
    cancelToken
  })

在页面中调用接口

<button @click='exportData'>导出</button>
<button @click='handleCancel'>取消</button>
import {export} from '@/api.js'
import axios from 'axios'
data() {
    return {
        request:null
    }
}

methods:{
// 导出
exportData() {
     const request = axios.CancelToken.source()
     this.request = request
     export({},request.token)
     .then(res => {})
     .catch((err) => {})
 },
 //取消
 handleCancel () {
  this.request.cancel('中断请求')
 }
}

方法二:AbortController

此方法必须要求axios的版本最低是V0.22.0,否则不生效 还是上面的代码,做以下修改:

// api.js
export function exportData(data) {
  return request({
    url: '/order/order-export',
    method: 'post',
    responseType: 'blob',
    data,
    signal: data.signal  // 新加的代码
  })
}
// 页面中使用
import {export} from '@/api.js'
import axios from 'axios'
let controller;

methods:{
// 导出
exportData() {
     controller = new AbortController()
      export({singal:controller.singal}).then(res => {
      
      console.log('下载成功')
      
      })
      .catch((err) => {
      if (axios.isCancel(err)) {
      console.log('下载被取消') 
      } else if (err.name === 'AbortError') {
      console.log('下载被中止') 
      } else {
          console.error(`下载错误:${err.message}`) 
         } 
      })
 },
 //取消
 handleCancel () {
  if (controller) { 
     controller.abort() // 使用 abort 方法中止下载 console.log('中止导出')
   }
 }
}

多个请求的取消

此方法利用 fetch API 方式—— AbortController 取消请求:

首先要对request.js的封装做出修改

// 取消请求
export const abortRequest = (controller) => {
  if (controller) {
    controller.abort()
  }
}

// 请求拦截
service.interceptors.request.use(
  (config) => {
    if (config.abortController) {
      config.signal = config.abortController.signal
    }
    ...其他代码跟上面一样
    return config
    })
// api.js
export function download(data, abortController) {
  return request({
    url: '/order/order-download',
    method: 'POST',
    responseType: 'blob',
    data,
    abortController // 新加的代码
  })
}

export function exportData(data,abortController) {
  return request({
    url: '/order/order-export',
    method: 'post',
    responseType: 'blob',
    data,
    abortController  // 新加的代码
  })
}

在页面中使用

<div>
    <button @click="fetchData1">发起请求 1</button>
    <button @click="abortDownload1">中止请求 1</button>
    <button @click="fetchData2">发起请求 2</button>
    <button @click="abortDownload2">中止请求 2</button>
  </div>
let controller1;
let controller2;
import {abortRequest} from '@/utils/request.js'
import {exportData,downLoad} from '@/api'
methods:{
   // 取消请求1
    abortDownload1() {
         abortRequest(controller1)
    }
    // 取消请求2
     abortDownload2() {
         abortRequest(controller2)
    }
    
    // 发起请求1
    fetchData1() {
        controller1 = new AbortController()
         const abortController = controller1
        exportData(data,abortController).then(res => {
            console.log('成功')
        })
        .catch(err => {
               if (axios.isCancel(err)) {
            console.log('下载被取消')
            common.showMessage(this, '到导出取消', 'warning')
          } else if (err.name === 'AbortError') {
            console.log('下载被中止')
          } else {
            console.error(`下载错误:${err.message}`)
          }
        })
    
    },
      fetchData2() {
        controller2 = new AbortController()
         const abortController = controller2
        download(data,abortController).then(res => {
            console.log('成功')
        })
        .catch(err => {
               if (axios.isCancel(err)) {
            console.log('下载被取消')
            common.showMessage(this, '到导出取消', 'warning')
          } else if (err.name === 'AbortError') {
            console.log('下载被中止')
          } else {
            console.error(`下载错误:${err.message}`)
          }
        })
    
    },
    
    
}

到此这篇关于axios请求中断的几种方法的文章就介绍到这了,更多相关axios请求中断内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • 浅析Vue.js 中的条件渲染指令

    浅析Vue.js 中的条件渲染指令

    这篇文章主要介绍了Vue.js 中的条件渲染指令,Vue.js 中的条件渲染指令可以根据表达式的值,来决定在 DOM 中是渲染还是销毁元素或组件。本文通过实例代码给大家介绍的非常详细,具有一定的参考借鉴价值,需要的朋友可以参考下
    2018-11-11
  • Vue中$emit调用父组件异步方法模拟.then实现方式

    Vue中$emit调用父组件异步方法模拟.then实现方式

    这篇文章主要介绍了Vue中$emit调用父组件异步方法模拟.then实现方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2024-09-09
  • vue在App.vue文件中监听路由变化刷新页面操作

    vue在App.vue文件中监听路由变化刷新页面操作

    这篇文章主要介绍了vue在App.vue文件中监听路由变化刷新页面操作,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2020-08-08
  • 解决element-ui中Popconfirm气泡确认框的事件不生效问题

    解决element-ui中Popconfirm气泡确认框的事件不生效问题

    这篇文章主要介绍了解决element-ui中Popconfirm气泡确认框的事件不生效问题,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-07-07
  • vue中使用scrollTo没有效果的完美解决方法

    vue中使用scrollTo没有效果的完美解决方法

    这篇文章主要介绍了在vue中使用scrollTo没有效果的解决方法,本文给大家分享具体操作步骤,在这里需要注意scrollTo要作用在可滚动的元素上,不然不生效,scrollTop就会一直为0,需要的朋友可以参考下
    2023-10-10
  • vue自定义组件search-box示例详解

    vue自定义组件search-box示例详解

    这篇文章主要介绍了vue自定义组件search-box,本文通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2023-05-05
  • Vue中使用的EventBus有生命周期

    Vue中使用的EventBus有生命周期

    这篇文章主要介绍了Vue中使用的EventBus有生命周期的相关知识,非常不错,具有一定的参考借鉴价值,需要的朋友可以参考下
    2018-07-07
  • vue中英文切换实例代码

    vue中英文切换实例代码

    在本篇文章里小编给大家整理了关于vue中英文切换实例代码,需要的朋友们学习参考下。
    2020-01-01
  • Vue之Axios的异步请求问题详解

    Vue之Axios的异步请求问题详解

    总的来说这并不是一道难题,那为什么要拿出这道题介绍?拿出这道题真正想要传达的是解题的思路,以及不断优化探寻最优解的过程。希望通过这道题能给你带来一种解题优化的思路,Axios是一个开源的可以用在浏览器端和Node JS的异步通信框架,主要作用就是实现AJAX异步通信
    2023-02-02
  • elementui导出数据为xlsx、excel表格

    elementui导出数据为xlsx、excel表格

    本文主要介绍了elementui导出数据为xlsx、excel表格,文中通过示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2021-09-09

最新评论