Skip to content

中止请求

useRequest 返回了 signal 参数和 abort 方法,用于中止尚未完成的接口请求

这样可以省去开发者自己定义 new AbortController()和手动定义 abort 方法的繁琐

ts
const controller = new AbortController(); 
const signal = controller.signal; 
const abort = () => controller.abort(); 
axios.post(url, { signal }); 

const { signal, abort } = useRequest(service); 
axios.post(url, { signal: signal.value }); 

使用的是 xhrfetch 请求,并添加了 signal 配置项 (必须),那么 useRequest 会在以下时机自动调用 abort 方法:

  • 组件卸载时,还未返回结果的请求
  • 前置请求中止,发起新请求时自动中止前一个未完成的请求并忽略 promise 的响应,但是如果设置了 options.abortPrevious = false 则默认不会中止,但是依旧会竞态取消

TIP

  1. 手动点击中止请求按钮请把Network网速设置为 4G 或 3G (网速快接口返回的很快,还没来得及中止就成功了,接口慢可以忽略这条)
  2. Network中观察被中止的过期请求

基本使用

注意事项

TypeScript 循环引用警告

如果在 service 函数中使用 signal,必须为 service 函数添加返回类型注解,否则会导致 TypeScript 循环引用错误。

ts
interface UserInfo {
  name: string;
  age: number;
}

// ❌ “signal”隐式具有类型 "any",因为它不具有类型批注,且在其自身的初始化表达式中得到直接或间接引用
// ❌ 由于“service'”不具有返回类型批注并且在它的一个返回表达式中得到直接或间接引用,因此它隐式具有返回类型 "any"。
const { signal } = useRequest(service);
// service函数缺少返回类型
function service() {
  return axios.get("/api/getUserInfo", { signal: signal.value });
}

// ✅ 正确:添加返回类型注解
const { signal } = useRequest(service);
// 明确service返回类型, 实际开发项目中都会写,不然也不会用TS了
function service(): Promise<UserInfo> { 
  return axios.get("/api/getUserInfo", { signal: signal.value });
}

原因: TypeScript 底层机制 在推断 useRequest 的返回类型时需要分析 service 函数的返回类型,而 service 函数内部又引用了 signal,形成循环依赖。添加返回类型注解可以打破这个循环。

Result

参数说明类型
signalAbortController 的信号对象,用于传递给 xhrfetchRef<AbortSignal>
abort中止当前请求() => void

贡献者 ☘️

Flame-00

Flame-00

Creator