Axios 中文文档 取消请求

2024-02-25 开发教程 Axios 中文文档 匿名 6

使用 cancel token取消请求。

Axios 的 cancel tokenAPI 基于 cancelable promises proposal,它还处于第一阶段。

可以使用 CancelToken.source工厂方法创建 cancel token像这样:

const CancelToken = axios.CancelToken;
const source = CancelToken.source();
axios.get('/user/12345', {
    cancelToken: source.token
}).catch(function (thrown) {
    if (axios.isCancel(thrown)) {
        console.log('Request canceled', thrown.message);
    } else { /* 处理错误 */ }
});
axios.post('/user/12345', {
    name: 'new name'
}, {
    cancelToken: source.token
});
// 取消请求 (message 参数是可选的)
source.cancel('Operation canceled by the user.');

还可以通过传递一个 executor 函数到 CancelToken 的构造函数来创建 cancel token

const CancelToken = axios.CancelToken;
let cancel;
axios.get('/user/12345', {
    cancelToken: new CancelToken(function executor(c) {
        // executor 函数接收一个 cancel 函数作为参数
        cancel = c;
    })
});
// 取消请求
cancel();

注意:可以使用同一个 cancel token 取消多个请求。