Flutter可清空计时器插件emptyable_timer的使用

特性

• 可以定义为 EmptyableTimer timer = EmptyableTimer.empty 而不是 Timer? timer；
• 可以检查它是否已取消（在某些情况下，它可能是非活动状态但未被取消）。

动机

考虑以下示例：

class SomeClassWithRegularTimer {
  SomeClassWithRegularTimer() {
    _init();
  }
  Timer? _timer;

  Future<void> _init() async {
    await _someDelayedRequest();
    _timer = Timer(const Duration(seconds: 2), _someHeavyDelayedRequest);
  }

  Future<void> _someDelayedRequest() => Future.delayed(Duration.zero);
  Future<void> _someHeavyDelayedRequest() async {
    await Future.delayed(const Duration(seconds: 30));
    print('_someHeavyDelayedRequest finished');
  }

  void dispose() {
    _timer?.cancel();
  }
}

在这种情况下，尽管调用了方法 [dispose]，但方法 _someHeavyDelayedRequest() 仍然会运行：

void main() {
  final someClassWithRegularTimer = SomeClassWithRegularTimer();
  someClassWithRegularTimer.dispose();
}

解决方案

作为解决方案之一，我们可以使用 EmptyableTimer 及其 empty 构造函数。考虑以下示例：

class SomeClassWithEmptyableTimer {
  SomeClassWithEmptyableTimer() {
    _init();
  }
  // 定义一个非空定时器
  EmptyableTimer _timer = EmptyableTimer.empty();

  Future<void> _init() async {
    await _someDelayedRequest();
    // 检查是否已取消
    if (_timer.isCanceled) {
      return;
    }
    _timer =
        EmptyableTimer(const Duration(seconds: 2), _someHeavyDelayedRequest);
  }

  Future<void> _someDelayedRequest() => Future.delayed(Duration.zero);
  Future<void> _someHeavyDelayedRequest() async {
    await Future.delayed(const Duration(seconds: 30));
    print('_someHeavyDelayedRequest finished');
  }

  void dispose() {
    // 直接调用取消方法
    _timer.cancel();
  }
}

我们可以在取消空计时器后检查 isCanceled 属性：

void main() {
  final someClassWithEmptyableTimer = SomeClassWithEmptyableTimer();
  someClassWithEmptyableTimer.dispose();
}

在这种情况下，方法 _someHeavyDelayedRequest() 将永远不会被调用。

完整示例代码

import 'dart:async';

import 'package:emptyable_timer/emptyable_timer.dart';

void main() {
  // 使用普通计时器的解决方案
  //
  // 尽管调用了dispose方法，
  // 但是方法 _someHeavyDelayedRequest() 仍然会被执行
  final someClassWithRegularTimer = SomeClassWithRegularTimer();
  someClassWithRegularTimer.dispose();

  // 使用EmptyableTimer的解决方案
  //
  // 取消注释以下代码进行测试
  // final someClassWithEmptyableTimer = SomeClassWithEmptyableTimer();
  // someClassWithEmptyableTimer.dispose();
}

class SomeClassWithRegularTimer {
  SomeClassWithRegularTimer() {
    _init();
  }
  Timer? _timer;

  Future<void> _init() async {
    await _someDelayedRequest();
    _timer = Timer(const Duration(seconds: 2), _someHeavyDelayedRequest);
  }

  Future<void> _someDelayedRequest() => Future.delayed(Duration.zero);
  Future<void> _someHeavyDelayedRequest() async {
    await Future.delayed(const Duration(seconds: 30));
    print('_someHeavyDelayedRequest finished');
  }

  void dispose() {
    _timer?.cancel();
  }
}

class SomeClassWithEmptyableTimer {
  SomeClassWithEmptyableTimer() {
    _init();
  }
  // 定义一个非空定时器
  EmptyableTimer _timer = EmptyableTimer.empty();

  Future<void> _init() async {
    await _someDelayedRequest();
    // 检查是否已取消
    if (_timer.isCanceled) {
      return;
    }
    _timer =
        EmptyableTimer(const Duration(seconds: 2), _someHeavyDelayedRequest);
  }

  Future<void> _someDelayedRequest() => Future.delayed(Duration.zero);
  Future<void> _someHeavyDelayedRequest() async {
    await Future.delayed(const Duration(seconds: 30));
    print('_someHeavyDelayedRequest finished');
  }

  void dispose() {
    // 直接调用取消方法
    _timer.cancel();
  }
}