Flutter节流控制插件 just_throttle_it 的使用

just_throttle_it 是一个简单的节流库，支持函数节流和流节流。本文将介绍如何在 Flutter 项目中使用该插件，并提供完整的示例代码。

安装

首先，在 pubspec.yaml 文件中添加依赖：

dependencies:
  just_throttle_it: ^1.0.0

然后运行 flutter pub get 来安装依赖。

静态方法

just_throttle_it 提供了三种静态方法来实现节流，分别用于指定不同的超时值格式。这些方法返回一个布尔值，表示调用是否成功（true）或被阻塞（false）。

方法签名

秒级节流

Throttle.seconds(int timeoutSeconds, 
    Function target,
    [List<dynamic> positionalArguments, 
    Map<Symbol, dynamic> namedArguments])

毫秒级节流

Throttle.milliseconds(int timeoutMs, 
    Function target,
    [List<dynamic> positionalArguments, 
    Map<Symbol, dynamic> namedArguments])

持续时间节流

Throttle.duration(Duration timeout, 
    Function target,
    [List<dynamic> positionalArguments, 
    Map<Symbol, dynamic> namedArguments])

清除节流

要清除某个节流的 target，以便允许下一个节流调用立即执行，可以使用以下方法：

Throttle.clear(Function target)

流节流

just_throttle_it 还支持对任何流进行节流处理。你可以使用 ThrottleStreamTransfomer 类来实现这一点。

使用示例

Stream throttleStream(Stream input) => input.transform(ThrottleStreamTransformer.seconds(1));

示例代码

以下是一个完整的示例，展示了如何使用 just_throttle_it 插件进行函数和流的节流控制。

import 'dart:async';
import 'package:just_throttle_it/just_throttle_it.dart';

void main() async {
  // 函数节流：每秒最多打印一次 "Hello World"
  void printSeconds() => print("Hello World (Throttle.seconds)");
  Throttle.seconds(1, printSeconds); // 立即打印
  Throttle.seconds(1, printSeconds); // 不会打印，因为还在节流时间内

  // 毫秒级节流：每500毫秒最多打印一次 "Hello World"
  void printMs() => print("Hello World (Throttle.milliseconds)");
  Throttle.milliseconds(500, printMs); // 立即打印
  Throttle.clear(printMs); // 清除节流状态
  Throttle.milliseconds(500, printMs); // 再次立即打印

  // 持续时间节流：每2秒最多打印一次 "Hello World"
  final duration = const Duration(milliseconds: 2000);
  Throttle.duration(duration, print, ["Hello World 1 (Throttle.duration)"]); // 立即打印
  Throttle.duration(duration, print, ["Hello World 2 (Throttle.duration)"]); // 不会打印
  Throttle.duration(duration, print, ["Hello World 3 (Throttle.duration)"]); // 不会打印
  Throttle.duration(duration, print, ["Hello World 4 (Throttle.duration)"]); // 不会打印
  Throttle.duration(duration, print, ["Hello World 5 (Throttle.duration)"]); // 不会打印

  // 等待2秒后再次尝试打印
  await Future.delayed(duration);
  Throttle.duration(duration, print, ["Hello World 6 (Throttle.duration)"]); // 立即打印

  // 流节流：每隔5秒打印一次事件
  final streamController = StreamController<int>();
  streamController.addStream(thirtySecondsStream());
  streamController.stream
      .transform(ThrottleStreamTransformer.seconds(5))
      .listen((event) {
    print("Hello Word $event seconds (ThrottleStreamTransformer)");
  });
}

// 创建一个从0到29的整数流，每秒产生一个新的整数值
Stream<int> thirtySecondsStream() async* {
  int seconds = 0;
  while (seconds < 30) {
    yield seconds;
    await Future.delayed(Duration(seconds: 1));
    seconds++;
  }
}