Vue / 系统课时

取消重复请求

取消重复请求

搜索框连续输入、标签页快速切换或组件离开时,旧请求可能比新请求更晚返回,并覆盖当前页面数据。本课使用 AbortController 和 Axios 的 signal 实现“只保留最新请求”,同时区分正常取消与真正的网络错误。

学习目标

  • 使用 AbortController 取消仍在进行的 Axios 请求
  • 在重复查询时保证最新请求拥有数据更新权
  • 在组件卸载时释放请求并正确处理取消异常

识别过期响应问题

假设用户先搜索“a”,随后立即搜索“admin”。第二个请求可能先完成,页面已经展示“admin”的结果;若第一个请求稍后返回并直接写入状态,界面就会退回旧数据。

解决思路是让同一查询场景始终只有一个活动控制器:新请求开始前取消旧控制器,响应写入前再确认当前请求仍是最新请求,组件卸载时取消剩余请求。

未取消请求与只保留最新请求的时序对比

为接口传入取消信号

Axios 请求配置支持 signal。业务接口只接收可选的 AbortSignal,不负责创建或保存控制器,因为“哪个请求需要被替换”属于页面或组合式函数的状态。

ts
// src/api/http.ts
import axios from 'axios'

export const http = axios.create({
  baseURL: '/api',
  timeout: 10_000
})

// src/api/user.ts
import { http } from './http'

export interface User {
  id: string
  username: string
}

interface ApiResponse<T> {
  code: number
  message: string
  data: T
}

interface UserPage {
  list: User[]
  total: number
}

export function getUserPage(keyword: string, signal?: AbortSignal) {
  return http.get<ApiResponse<UserPage>>('/users', {
    params: { page: 1, pageSize: 20, keyword },
    signal
  })
}

这是项目文件片段。signal 未传入时请求正常执行;传入后,调用对应控制器的 abort() 会使仍在进行的请求以取消错误结束。

在组件中只保留最新请求

下面的单文件组件在每次输入后发起查询。开始新查询前先取消旧请求,并通过控制器身份判断避免旧请求修改 loading 或列表状态。

vue
<script setup lang="ts">
import axios from 'axios'
import { onBeforeUnmount, ref } from 'vue'
import { getUserPage, type User } from '@/api/user'

const keyword = ref('')
const users = ref<User[]>([])
const loading = ref(false)
const errorMessage = ref('')

let activeController: AbortController | null = null

async function loadUsers() {
  activeController?.abort()

  const controller = new AbortController()
  activeController = controller
  loading.value = true
  errorMessage.value = ''

  try {
    const response = await getUserPage(keyword.value, controller.signal)

    // 只有当前仍有效的请求可以更新页面数据
    if (controller !== activeController) return
    users.value = response.data.data.list
  } catch (error) {
    // 主动取消属于正常流程,不显示“加载失败”
    if (!axios.isCancel(error)) {
      errorMessage.value = '用户列表加载失败'
    }
  } finally {
    if (controller === activeController) {
      loading.value = false
    }
  }
}

onBeforeUnmount(() => {
  activeController?.abort()
  activeController = null
})
</script>

<template>
  <section>
    <input
      v-model="keyword"
      type="search"
      placeholder="输入用户名"
      @input="loadUsers"
    >
    <p v-if="loading">加载中...</p>
    <p v-else-if="errorMessage">{{ errorMessage }}</p>
    <ul v-else>
      <li v-for="user in users" :key="user.id">
        {{ user.username }}
      </li>
    </ul>
  </section>
</template>

预期结果

text
连续输入多个关键字时,前一个未完成请求会被取消。
只有最后一次查询结果会更新用户列表。
离开组件时仍在进行的请求被取消,取消行为不会显示为加载失败。

处理边界与误区

请求取消只是停止客户端继续等待和处理响应,不等于撤销服务端已经执行的操作。因此它适合搜索、筛选、详情切换等读请求;对新增、支付、审批等写操作,不能把 abort() 当成事务回滚或幂等控制。

不要复用一个已经取消的控制器。每次新请求都应创建新的 AbortController。也不要把所有请求绑定到同一个全局控制器,否则取消一个页面请求可能误伤无关业务。

若查询频率很高,可在取消旧请求之外增加防抖:防抖减少请求数量,取消机制防止已发出的旧请求覆盖新数据,两者解决的是不同问题。

验证取消行为

打开浏览器开发者工具的 Network 面板,连续输入不同关键字。较早请求应显示为已取消,最后一个请求正常完成;随后在请求未结束时切换路由,页面不应再更新旧组件状态。

bash
npx vue-tsc --noEmit

预期输出

text
命令退出码为 0,AbortSignal、组件状态和接口返回类型均无类型错误。

若取消后仍出现错误提示,检查 catch 中是否先识别取消错误;若旧数据仍能覆盖新数据,检查是否遗漏了“控制器身份判断”或某条查询路径没有传入 signal。

按自己的节奏,确认真正理解。

目录与阅读设置

阅读设置

17

记录一个想法

取消重复请求

0 / 10000 · 笔记保存到账号。未提交的修改会在关闭、离开或刷新后丢失。

登录哪都通