跨平台开发 / 系统课时

用 CancelToken 取消旧请求

用 CancelToken 取消旧请求

本篇解决 Flutter 页面中无效网络请求持续执行的问题,通过 Dio 的 CancelToken 在搜索条件变化、页面销毁等场景主动终止旧请求,减少资源浪费和无意义的数据更新。

学习目标

  • 理解 CancelToken 取消请求的作用和适用场景
  • 掌握 Dio 中创建、绑定和触发取消的方法
  • 能在搜索页面中实现输入变化时取消旧请求

为什么需要取消请求

移动端页面经常会出现请求已经没有意义的情况。例如用户连续修改搜索关键词,第一次输入产生的请求可能还在网络中,但用户已经需要第二次输入的结果。如果旧请求继续执行,会浪费网络资源,也可能带来错误的数据处理。

Dio 提供的 CancelToken 可以给请求绑定取消信号。当调用取消方法后,Dio 会终止对应请求,并抛出取消异常,页面可以忽略这类结果。

使用 CancelToken 管理请求生命周期

一个请求对应一个 CancelToken,通常由发起请求的页面或业务对象保存。当下一次请求开始前,先取消上一次请求,再创建新的 Token。

下面示例使用 Dio 实现一个简单搜索方法。示例假设已经添加 Dio 依赖,并且当前类负责维护搜索请求状态。

dart
import 'package:dio/dio.dart';

class SearchRepository {
  final Dio dio;
  CancelToken? _cancelToken;

  SearchRepository(this.dio);

  Future<List<String>> search(String keyword) async {
    // 新请求开始前取消已经失效的旧请求
    _cancelToken?.cancel('new keyword arrived');
    _cancelToken = CancelToken();

    final response = await dio.get(
      '/search',
      queryParameters: {'keyword': keyword},
      cancelToken: _cancelToken,
    );

    return List<String>.from(response.data['items']);
  }
}

预期结果

text
用户输入 flutter 后快速输入 dart:
1. flutter 请求收到取消信号
2. dart 请求继续执行
3. 页面只处理 dart 对应的搜索结果

处理取消异常

取消请求属于主动控制流程,不应该被当成普通网络错误提示给用户。实际开发中需要区分 DioException 的类型。

dart
try {
  final items = await repository.search('flutter');
  print(items);
} on DioException catch (e) {
  if (CancelToken.isCancel(e)) {
    print('request cancelled');
    return;
  }
  rethrow;
}

预期结果

text
request cancelled

页面退出时取消请求

除了搜索场景,页面销毁也是常见取消时机。例如详情页离开后,请求结果已经无法更新 UI,此时应在 State 的 dispose 方法中取消。

实际项目中,CancelToken 适合处理用户交互导致的短生命周期请求。对于必须完成的后台任务,应使用队列、状态管理或服务端任务机制处理,而不是简单取消。

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

目录与阅读设置

阅读设置

17

记录一个想法

用 CancelToken 取消旧请求

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

登录哪都通