Vue 3 中请求取消怎么在 TypeScript 中编写泛型取消钩子

夏浩吖_7556

夏浩吖_7556

2026-09-26

454人浏览

原创

useabortcontroller钩子专注信号管理与自动清理,不泛型化abort方法,而是通过getsignal()提供类型安全的abortsignal,配合泛型请求函数(如get())实现全程类型推导和请求取消。

vue 3 中请求取消怎么在 typescript 中编写泛型取消钩子

在 Vue 3 + TypeScript 项目中,编写一个类型安全、可复用的请求取消钩子(如 useAbortController),关键不是“泛型取消”,而是让 AbortController 的创建、绑定、清理和类型提示都与请求函数自然协同。真正的泛型体现在请求返回值类型(比如 T)和信号监听逻辑的复用上,而不是给 abort() 做泛型。

核心思路:信号与请求分离,类型随请求走

不要试图给 abort 方法加泛型,而是把 AbortSignal 注入到具体请求函数中,并确保该请求函数本身是泛型的(如 get<t>()</t>)。钩子只负责生命周期管理 + 类型友好的 signal 提供。

  • 钩子不执行请求,只提供 signal 和 abort 方法
  • 请求函数(如 get<userlistresult>()</userlistresult>)自带泛型,返回类型自动推导
  • 钩子返回的 abort 是无参函数,无需泛型 —— 它只是触发标准中止

实现一个类型安全的 useAbortController

下面是一个生产可用的 TypeScript 钩子,支持组件卸载自动清理,并导出可手动调用的 abort:

import { ref, onBeforeUnmount } from 'vue'

export function useAbortController() {
  const controller = ref<abortcontroller null>(null)

  const abort = () => {
    if (controller.value) {
      controller.value.abort()
      controller.value = null
    }
  }

  // 创建新控制器并返回 signal
  const getSignal = (): AbortSignal => {
    if (controller.value) abort()
    controller.value = new AbortController()
    return controller.value.signal
  }

  // 组件卸载时自动清理
  onBeforeUnmount(abort)

  return {
    abort,
    getSignal,
    // 可选:暴露 controller 实例用于高级控制(如 reason)
    controller: controller as Readonly<ref null>>
  }
}</ref></abortcontroller>

注意:getSignal() 每次调用都会新建控制器并自动取消旧的,天然避免重复请求残留。

check-vue-style
check-vue-style

检查 .vue 单文件组件的 CSS 规范问题并给出提示,适用于样式检查、CSS审查和 Vue 页面质量巡检。

下载

在组件中配合泛型请求函数使用

结合你已有的泛型 get<t>()</t>(来自 request.ts),这样用即可获得完整类型推导和取消能力:

<script setup lang="ts">
import { useAbortController } from '@/hooks/useAbortController'
import { get } from '@/utils/request'
import type { UserListResult } from '@/types/user'

const { getSignal } = useAbortController()

const fetchUsers = async () => {
  try {
    // ✅ 类型自动为 Promise<ApiResponse<UserListResult>>
    const res = await get<UserListResult>('/api/users', {
      params: { page: 1, size: 10 }
    }, {
      signal: getSignal() // ✅ signal 类型为 AbortSignal,TS 严格校验
    })
    console.log(res.data.list) // ✅ list 自动补全,类型精准
  } catch (err) {
    if (err.name === 'AbortError') {
      console.log('请求已被取消')
    }
  }
}
</script>

这里没有额外泛型参数传给钩子,但整个链路——从 getSignal() 到 get<t>()</t> 再到 res.data ——全程类型不丢失。

进阶:封装带取消能力的 useRequest(可选)

如果想进一步封装成类似 React Query 的 useRequest<t>()</t>,可以这样设计返回值类型:

interface UseRequestReturn<t> {
  data: Ref<t null>
  error: Ref<error null>
  isLoading: Ref<boolean>
  execute: (options?: { signal?: AbortSignal }) => Promise<void>
  abort: () => void
}

export function useRequest<t>(fn: (config: { signal?: AbortSignal }) => Promise<t>): UseRequestReturn<t> {
  // 内部用 useAbortController 管理 signal
  const { getSignal, abort } = useAbortController()
  const data = ref<t null>(null)
  const error = ref<error null>(null)
  const isLoading = ref(false)

  const execute = async (options: { signal?: AbortSignal } = {}) => {
    isLoading.value = true
    error.value = null
    try {
      const signal = options.signal ?? getSignal()
      data.value = await fn({ signal })
    } catch (e) {
      if (e instanceof Error && e.name === 'AbortError') return
      error.value = e as Error
    } finally {
      isLoading.value = false
    }
  }

  return { data, error, isLoading, execute, abort }
}</error></t></t></t></t></void></boolean></error></t></t>

调用时直接传入泛型 useRequest<userlistresult>(() => get('/api/users'))</userlistresult>,返回值中 data 类型即为 Ref<userlistresult null></userlistresult>,零配置类型安全。

前端入门到VUE实战笔记:立即使用
在学习笔记中,你将探索 前端 的入门与实战技巧!

相关专题

更多
python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

2123

5

前端如何实现即时通讯
前端如何实现即时通讯

实现即时通讯的方法有WebSocket、Long Polling、Server-Sent Events、WebRTC等等。详细介绍:1、WebSocket,它可以在客户端和服务器之间建立持久连接,实现实时的双向通信,前端可以使用 WebSocket API来创建WebSocket连接,并通过发送和接收消息来实现即时通讯;2、Long Polling,是一种模拟实时通信的技术等等。

2023.10.09

4523

6

前端和后端的区别
前端和后端的区别

前端关注的是用户界面的设计和交互,而后端则注重数据处理和逻辑控制。想了解更多前端后端的相关内容,可以阅读本专题下面的文章。

2024.03.19

5670

13

php和前端的关联介绍
php和前端的关联介绍

php既可以作为前端语言,也可以作为后端语言。想了解更多php和前端的相关内容,可以阅读本专题下面的文章。

2024.03.22

5118

10

前端外包工作内容有哪些
前端外包工作内容有哪些

前端外包工作内容包括:1. 网站和应用程序开发;2. 用户界面和交互设计;3. 用户体验优化;4. 设计和视觉开发;5. 跨浏览器兼容性;6. 性能优化;7. 维护和更新;8. 项目管理和沟通。想了解更多前端的相关内容,可以阅读本专题下面的文章。

2024.05.22

723

5

TypeScript工程化开发与Vite构建优化实践
TypeScript工程化开发与Vite构建优化实践

本专题面向前端开发者,深入讲解 TypeScript 类型系统与大型项目结构设计方法,并结合 Vite 构建工具优化前端工程化流程。内容包括模块化设计、类型声明管理、代码分割、热更新原理以及构建性能调优。通过完整项目示例,帮助开发者提升代码可维护性与开发效率。

2026.02.13

252

17

TypeScript全栈项目架构与接口规范设计
TypeScript全栈项目架构与接口规范设计

本专题面向全栈开发者,系统讲解基于 TypeScript 构建前后端统一技术栈的工程化实践。内容涵盖项目分层设计、接口协议规范、类型共享机制、错误码体系设计、接口自动化生成与文档维护方案。通过完整项目示例,帮助开发者构建结构清晰、类型安全、易维护的现代全栈应用架构。

2026.02.25

480

17

TypeScript类型系统进阶与大型前端项目实践
TypeScript类型系统进阶与大型前端项目实践

本专题围绕 TypeScript 在大型前端项目中的应用展开,深入讲解类型系统设计与工程化开发方法。内容包括泛型与高级类型、类型推断机制、声明文件编写、模块化结构设计以及代码规范管理。通过真实项目案例分析,帮助开发者构建类型安全、结构清晰、易维护的前端工程体系,提高团队协作效率与代码质量。

2026.03.13

311

19

TypeScript 全栈开发进阶指南
TypeScript 全栈开发进阶指南

面向有 JavaScript 基础的开发者,深入讲解 TypeScript 的类型系统与全栈开发实践。

2026.06.03

246

29

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Vue 教程
Vue 教程

共42课时 | 16.8万人学习

国外Web开发全栈课程全集
国外Web开发全栈课程全集

共12课时 | 1.4万人学习

Vue.js 微实战--十天技能课堂
Vue.js 微实战--十天技能课堂

共18课时 | 1.7万人学习