Abort Controller 被严重低估了

前言

今天我们来聊聊 Abort Controller。你可能在取消网络请求时使用过它，但其实它的功能远不止于此。这个被严重低估的 API 有很多其他的巧妙用法。

什么是 AbortController

AbortController 是 JavaScript 中的一个全局类，可以用来中止任何事情。

使用方法如下：

const controller = new AbortController();
controller.signal
controller.abort()

可以看到，在创建完 AbortController 实例后，有两个重要的部分：

signal 属性: 一个 AbortSignal 的实例，可以提供给各种 API （比如 fetch ）来响应中止事件
abort() 方法：触发 signal 上的中止事件

常见使用场景

事件监听管理

传统的事件监听器移除方式：

window.addEventListener('resize', handleResize)
window.addEventListener('storage', handleStorage)
// 清理时需要记住所有的事件和处理函数
window.removeEventListener('resize', handleResize)
window.removeEventListener('storage', handleStorage)

我们为了能将函数更好的传递给 removeEventListener ，一般需要抽象成一个函数。如果使用的是 TypeScript ，还需要定义一下函数里面的类型。但是使用 AbortController ，我们可以这样做：

const controller = new AbortController()
const signal = controller.signal

window.addEventListener('resize',
  () => {
    // 处理 resize 事件
  },
  { signal }
)

window.addEventListener('storage',
  () => {
    // 处理 storage 事件
  },
  { signal }
)

// 清理时只需要调用 abort 方法
controller.abort()

在这个示例中，即使存在多个事件监听器，在移除的时候，我们也只需要一个 AbortController 实例就能统一清理。

更重要的是，这种方式让我们不再需要为每个事件处理函数单独命名和维护，使代码更加简洁优雅。

取消网络请求

这是我们最常见的使用场景，使用 fetch 函数，在取消网络请求时，我们通常会使用 AbortController 来实现。

function uploadFile(file: File) {
  const controller = new AbortController()

  const response = fetch('/upload', {
    method: 'POST',
    body: file,
    signal: controller.signal,
  })

  return { response, abort: controller.abort }
}

在上面这个例子中，用户上传文件的过程中，如果想要取消上传，只需要调用 abort 方法即可。

此外，AbortSignal 类还附带了一些静态方法来简化请求处理。

AbortSignal.timeout

在使用 fetch 时，如果想要设置超时后取消请求，甚至都无需创建 AbortController 实例，直接使用 AbortSignal.timeout 即可。

fetch(url, {
  signal: AbortSignal.timeout(3000),
})

AbortSignal.any

和 Promise.race 类似，AbortSignal.any 可以监听多个信号，只要其中一个信号触发，就会触发 AbortSignal.any 的回调。

const publicController = new AbortController()
const internalController = new AbortController()

channel.addEventListener('message', handleMessage, {
  signal: AbortSignal.any([publicController.signal, internalController.signal]),
})

在上面这个示例中，我们有两个 AbortController 实例，分别用于处理公共事件和内部事件。publicController 可以直接暴露给外部使用，我们也有自己的 internalController，用于处理内部逻辑。只要任何一个 AbortController 实例触发中止事件，message 事件监听器就会被删除。

错误处理

controller.abort() 方法有一个可选参数，可以传递一个错误信息，这个错误信息会作为 AbortSignal.reason 属性返回。

const controller = new AbortController()

controller.signal.addEventListener('abort', () => {
  console.log(controller.signal.reason) // "user cancellation"
})

// 提供一个错误信息
controller.abort('user cancellation')

const controller = new AbortController()
controller.signal.reason

Node.js 中的 http 模块发出的请求也支持 signal 属性 !

stream

在 Next.js 中，当我们使用服务端渲染页面，如果等整体页面渲染完成再进行传输，可能会导致页面长时间白屏。

所以，Next.js 会使用 stream 流式传输，把页面分解成更小的块，完成后逐步从服务器流式传输到客户端

通过流式传输，我们可以避免缓慢的数据请求阻塞整个页面的渲染。这使得用户在所有数据加载完成前，就能看到并交互页面的部分内容，大大提升了用户体验。

所以，当流式传输传输还未完成，如果用户取消了请求，那么我们就可以使用 AbortController 来取消这个流失传输的请求。

const stream = new WritableStream({
  write(chunk, controller) {
    controller.signal.addEventListener('abort', () => {
      // 处理流式传输中止事件
    })
  },
})

const writer = stream.getWriter()
await writer.abort()

任何事务都可以终止

AbortController API 最强大的地方在于你可以为任何操作添加中止功能。如果有一些第三方库不支持中止或者取消功能，我们可以使用 AbortController 来实现。

比如，我们在使用 Drizzle ORM 时，如果想要取消多个事务，我们可以这样做：

import { TransactionRollbackError } from 'drizzle-orm'

function makeCancelableTransaction(db) {
  return (callback, options = {}) => {
    return db.transaction((tx) => {
      return new Promise((resolve, reject) => {
        // 如果事务被中止，则回滚事务
        options.signal?.addEventListener('abort', async () => {
          reject(new TransactionRollbackError())
        })

        return Promise.resolve(callback.call(this, tx)).then(resolve, reject)
      })
    })
  }
}

上面的例子中，我们在 signal 上添加了 abort 事件监听器，当调用 controller.abort() 时，就会触发触发我们的事件监听器回调，使用 TransactionRollbackError 来回滚整个事务。

使用方法如下：

const db = drizzle(options)

const controller = new AbortController()
const transaction = makeCancelableTransaction(db)

await transaction(
  async (tx) => {
    await tx
      .update(accounts)
      .set({ balance: sql`${accounts.balance} - 100.00` })
      .where(eq(users.name, 'Dan'))
    await tx
      .update(accounts)
      .set({ balance: sql`${accounts.balance} + 100.00` })
      .where(eq(users.name, 'Andrew'))
  },
  { signal: controller.signal }
)

总结

AbortController 是一个非常强大的 API，可以用来中止任何操作。如果只用来取消网络请求的话，那它就太浪费了。

当你想要删除事件监听器，取消流式传输，取消事务、或者进行任何中止逻辑时都可以使用 AbortController 来实现。

优雅地取消请求

WeakMap+AbortController——优雅地取消请求

AbortController

AbortController可以用来取消fetch请求，MDN给出了简单的案例，就不在此处赘述了。

AbortController 接口表示一个控制器对象，允许你根据需要中止一个或多个 Web 请求。
你可以使用 AbortController() 构造函数创建一个新的 AbortController 对象。使用 AbortSignal 对象可以完成与异步操作的通信。

AbortController取消XHR

AbortController 的缺点是无法直接取消 XHR，但XHR对象本身就提供了 abort api，我们可以通过监听 signal 的 abort 事件，变相实现 AbortController 取消 XHR。

const xhr = new XMLHttpRequest();
xhr.open('GET', '/api/data');
xhr.send();

// 监听 signal
signal.addEventListener('abort', () => {
  xhr.abort(); // 使用 xhr 原生取消
});

axios的请求取消也是基于该思路实现的。

// 创建控制器
const controller = new AbortController();
const signal = controller.signal;

// 发起请求，传入 signal
axios.get('/api/data', { signal })
  .then(response => {
   ...
  })
  .catch(error => {
    ...
  });

// 2 秒后取消请求
setTimeout(() => {
  controller.abort(); // 会触发上方的 catch 分支
}, 2000);

然而项目中请求取消与请求发送往往不在同一个文件中，因此需要缓存请求 Promise实例 和对应的 AbortController 实例，这也意味着开发不仅需要关注请求取消，还需要关注这两个实例的清理，以防止内存泄漏，这引入了额外的心智负担。

使用WeakMap缓存请求Promise和AbortController

为了减轻这部分心智负担，我倾向于在项目中使用 WeakMap 来缓存请求 Promise 和 AbortController。一般来说，项目中不会额外缓存（引用）请求 promise，请求完成后，只要该promise"不可达"，GC便会回收该实例，对应的 abortController 也会因为"不可达"而被回收掉。

参考代码如下：

javascript

// api.ts
const abortMap = new WeakMap();
window.abortMap = abortMap; //测试gc

const putSth = () => {
  const controller = new AbortController();
  const req = request({ url: "/api/clear", signal: controller.signal }).catch(
    (e) => console.error(e)
  );
  req.t = 1; //测试gc
  abortMap.set(req, controller);
  return req;
};
// component.ts
export function ClearTest() {
  const [visible, setVisible] = useState(true);
  return (
    <div>
      <button
        onClick={() => {
          setVisible((v) => !v);
        }}
      >
        toggle
      </button>
      {visible && <Test></Test>}
    </div>
  );
}
function Test() {
  useEffect(() => {
    const req = putSth();
    return () => {
    //取消请求
      abortMap.get(req)?.abort("cancel");
    };
  }, []);
  return <div>test</div>;
}

内存观察

上面的 demo 中增加了一些调试代码。对组件进行多次挂载卸载测试，观察控制台可以看到每次请求取消后会打印 cancel error。观察abortMap，可以明显看到部分请求 promise 被回收了，程序符合预期。

但也有可能观察到 abortMap 中存在大量未被回收的 promise。

我们可以手动清理垃圾后再观察。

手动清理虽然会触发 GC，但不一定会清理掉所有垃圾对象（分代垃圾回收）。

通过快照可以看到这些 Promise 实例的距离都是-，这意味着它们“不可达”，如果不在闭包内，将来会被 GC 清理掉。

经过一段时间后，再次观察可以看到 weakMap 中所有请求 Promise 都被回收了：

如果有朋友发现 weakMap 中的 Promise 始终无法被回收掉，可能和控制台打印有关系，清理控制台关掉后再打开控制台，支持垃圾回收，来回几次，可能就会看到 weakMap 被清空了。

Abort Controller 被严重低估了 ​

前言 ​

什么是 AbortController ​

常见使用场景 ​

事件监听管理 ​

取消网络请求 ​

错误处理 ​

任何事务都可以终止 ​

总结 ​

优雅地取消请求 ​

AbortController ​

AbortController取消XHR ​

使用WeakMap缓存请求Promise和AbortController ​

内存观察 ​