Flutter事件防抖插件easy_debouncer的使用

debouncer

easy_debouncer 是一个用于Dart/Flutter的简单方法调用防抖包。

防抖（Debouncing）是指在短时间内多次调用某个方法时，只执行最后一次调用的方法。每次调用会启动一个计时器，如果在计时器执行之前又有新的调用，则重置计时器并重新等待指定的时间。当计时器最终超时时，目标方法将被调用。

使用

防抖

通过调用 debounce 来使用防抖功能：

Debouncer.debounce(
    'my-debouncer',                 // -- 该防抖器的ID
    Duration(milliseconds: 500),    // -- 防抖持续时间
    () => myMethod()                // -- 目标方法
);

上述调用将在500毫秒后调用 myMethod()，除非在500毫秒内再次调用具有相同 tag 的 debounce()。标签（tag）用于标识特定的防抖器，这意味着你可以同时运行多个不同的独立防抖器。

取消防抖

可以通过调用 cancel() 并传入防抖器的 tag 来取消尚未执行其目标函数的防抖器：

Debouncer.cancel('my-debouncer');

要取消所有活动的防抖器，可以调用 cancelAll()：

Debouncer.cancelAll();

计算活动的防抖器数量

可以通过调用 count() 获取活动防抖器的数量（即尚未执行其目标方法的防抖器）：

print('Active debouncers: ${Debouncer.count()}'); 

手动触发防抖器的目标函数

如果你需要在计时器执行前手动触发防抖器的目标函数，可以调用 fire()：

Debouncer.fire('my-debouncer');

这将执行防抖器的目标函数，但防抖计时器将继续运行，除非你也调用了 cancel()。

完整示例

以下是一个完整的示例，演示如何在Flutter应用中使用 easy_debouncer：

import 'package:flutter/material.dart';
import 'package:easy_debounce/easy_debounce.dart';

void main() {
  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: MyHomePage(),
    );
  }
}

class MyHomePage extends StatefulWidget {
  [@override](/user/override)
  _MyHomePageState createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  int _counter = 0;

  void incrementCounter() {
    setState(() {
      _counter++;
    });
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('Flutter Debouncer Example'),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: <Widget>[
            Text(
              'You have pushed the button this many times:',
            ),
            Text(
              '$_counter',
              style: Theme.of(context).textTheme.headline4,
            ),
            ElevatedButton(
              onPressed: () {
                // 使用防抖
                Debouncer.debounce(
                  'my-debouncer',
                  Duration(milliseconds: 500),
                  incrementCounter,
                );
              },
              child: Text('Increment with Debounce'),
            ),
            ElevatedButton(
              onPressed: () {
                // 手动触发防抖器的目标函数
                Debouncer.fire('my-debouncer');
              },
              child: Text('Fire Debouncer Manually'),
            ),
            ElevatedButton(
              onPressed: () {
                // 取消防抖
                Debouncer.cancel('my-debouncer');
              },
              child: Text('Cancel Debouncer'),
            ),
            ElevatedButton(
              onPressed: () {
                // 取消所有防抖
                Debouncer.cancelAll();
              },
              child: Text('Cancel All Debouncers'),
            ),
            ElevatedButton(
              onPressed: () {
                // 输出活动的防抖器数量
                print('Active debouncers: ${Debouncer.count()}');
              },
              child: Text('Count Active Debouncers'),
            ),
          ],
        ),
      ),
    );
  }
}