深入剖析Dio的CancelToken：灵活掌控网络请求，说停就停

Android

2023-10-06 11:52:56

纵览CancelToken的取消之道

在Flutter的网络请求库Dio中，CancelToken是一个非常重要的工具，它能够帮助你随时取消网络请求。这在某些场景下非常有用，例如：

当用户在列表中快速滚动时，取消之前发起的网络请求，以防止加载不必要的数据。
当用户点击“取消”按钮时，取消当前正在进行的网络请求，以避免浪费资源。
当网络连接中断时，取消所有正在进行的网络请求，以防止应用程序崩溃。

CancelToken的工作原理是通过在一个HTTP请求中设置一个令牌，当调用cancel()方法时，该令牌就会被取消，从而导致HTTP请求被中止。

三种方式，随心掌控请求取消

CancelToken提供了三种不同的方法来取消请求：

事前拦截 ：在发出HTTP请求之前，你可以调用cancel()方法来取消该请求。
事中中止 ：在HTTP请求正在进行时，你可以调用cancel()方法来中止该请求。
事后拦截 ：在HTTP请求已经完成之后，你可以调用isCancelled方法来检查该请求是否被取消。

灵活运用，适才善用

对于不同的场景，你可以选择最适合的方式来取消请求：

如果在发出HTTP请求之前就确定不需要该请求，可以使用事前拦截的方式来取消请求。
如果HTTP请求正在进行中，并且你突然改变了主意，可以使用事中中止的方式来取消请求。
如果HTTP请求已经完成，但你发现该请求的结果不符合你的预期，可以使用事后拦截的方式来取消请求。

实战案例，亲身体验CancelToken的强大

为了帮助你更好地理解CancelToken的用法，我们来看一个实战案例：

import 'package:dio/dio.dart';

void main() async {
  // 创建一个Dio实例
  var dio = Dio();

  // 创建一个CancelToken
  var cancelToken = CancelToken();

  // 设置一个取消令牌
  dio.options.cancelToken = cancelToken;

  // 发出一个HTTP请求
  try {
    var response = await dio.get('https://example.com');
    print(response.data);
  } on DioError catch (e) {
    if (e.error is CancelToken) {
      print('请求已取消');
    } else {
      print('其他错误：${e.message}');
    }
  }

  // 取消请求
  cancelToken.cancel();
}