Flutter一次性容器管理插件disposable_container的使用

特性

该插件提供了有用的类/混合和扩展来处理不同的Flutter资源的清理，例如：

1. 同步或异步回调
2. StreamControllers
3. StreamSubscriptions
4. TextEditingController
5. FocusNode

开始使用

在项目的pubspec.yaml文件中添加依赖项：

dependencies:
  disposable_container: ^0.0.1

使用示例

基础示例

以下是一个基础示例，展示了如何使用DisposableContainer来管理一次性资源。

import 'package:disposable_container/disposable_container.dart';

void main() {
  final DisposableContainer disposableContainer = DisposableContainer();

  disposableContainer.addDisposable(() => print('I will be disposed'));

  await disposableContainer.dispose();
}

完整示例

下面是一个更完整的示例，展示了如何在实际应用中使用DisposableContainer。该示例包含了一个简单的Flutter应用，其中包含一个按钮，点击后会导航到一个使用DisposableContainer管理资源的屏幕。

主文件

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

void main() {
  runApp(const App());
}

class App extends StatelessWidget {
  const App({super.key});

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        body: Center(
          child: Builder(
            builder: (context) {
              return ElevatedButton(
                onPressed: () {
                  Navigator.push(
                    context,
                    MaterialPageRoute(
                        builder: (_) => const DisposableContainerScreen()),
                  );
                },
                child: const Text('Push screen with disposable container'),
              );
            },
          ),
        ),
      ),
    );
  }
}

管理资源的屏幕

class DisposableContainerScreen extends StatefulWidget {
  const DisposableContainerScreen({super.key});

  [@override](/user/override)
  State<DisposableContainerScreen> createState() => _DisposableContainerScreenState();
}

class _DisposableContainerScreenState extends State<DisposableContainerScreen>
    with
        // 使用[WidgetDisposableContainerMixin]，该混入类提供了一个`disposableContainer`属性
        WidgetDisposableContainerMixin {
  final TextEditingController _textEditingController = TextEditingController(text: 'Initial text');

  // 使用[autoDisposeWith]扩展来与`disposableContainer`一起自动清理
  late final FocusNode focusNode = FocusNode().autoDisposeWith(disposableContainer);

  int _counter = 0;

  [@override](/user/override)
  void initState() {
    super.initState();

    // 将`_textEditingController`添加到`disposableContainer`中，以便在dispose时自动调用其dispose方法
    disposableContainer.addDisposable(_textEditingController.dispose);

    // 创建一个每秒更新一次的计数器流，并将其订阅添加到`disposableContainer`
    Stream.periodic(const Duration(seconds: 1))
        .listen((event) => _incrementCounter())
        // 或者使用`disposableContainer.addSubscription(Stream.listen(...))`
        .autoCancelWith(disposableContainer);

    // 添加一个自定义的dispose回调
    disposableContainer.addDisposable(() => debugPrint('I am being disposed.. bye!'));
  }

  void _incrementCounter() {
    debugPrint('Incrementing counter to ${_counter + 1}');
    setState(() {
      _counter += 1;
    });
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(),
      body: Column(
        mainAxisSize: MainAxisSize.min,
        children: [
          TextField(
            controller: _textEditingController,
          ),
          const SizedBox(height: 12),
          Text('$_counter'),
        ],
      ),
    );
  }
}