Flutter状态管理工具插件use_state_utils的使用

Flutter状态管理工具插件use_state_utils的使用

UseStateMixin 简化了在 StatefulWidget 中管理 Flutter 资源（如 AnimationController、StreamSubscription、Timer 和 ValueNotifier）的过程。它通过自动管理这些资源的生命周期来减少样板代码。

特性

• 生命周期管理：确保资源的正确创建和销毁。
• 减少样板代码：减少管理动画、流、计时器和值通知器的代码量。
• 易于使用：将常见任务简化为单个方法调用。
• 可定制：轻松集成自定义可处置组件以混合生命周期。
• 减少代码：编写更少的代码，提高效率。让我们为您处理资源的销毁。

可视示例

useNotifier

usePeriodicTimer

useStreamSubscription

useAnimationController

开始使用

要将此混入应用于您的 Flutter 应用程序，请遵循以下步骤：

安装

在您的 Flutter 项目中添加 use_state_utils，请将以下行添加到您的 pubspec.yaml 文件中：

dependencies:  
  use_state_utils: 

然后运行 flutter pub get 来安装该包。

使用示例

以下是一个使用 UseStateMixin 和 AnimationController 的快速示例：

class _MyAnimatedWidgetState extends State<MyAnimatedWidget> with TickerProviderStateMixin, UseStateMixin<MyAnimatedWidget> {  
  late AnimationController _controller;  
  
  [@override](/user/override) 
  void initState() { 
    super.initState(); 
    _controller = useAnimationController(key: 'anim1', duration: const Duration(seconds: 2), vsync: this); 
    _controller.forward(); 
  }  
  
  [@override](/user/override) 
  Widget build(BuildContext context) { 
    return FadeTransition( 
      opacity: _controller, 
      child: const Center(child: Text('Hello, World!')), 
    ); 
  } 
}

API

useNotifier<V>

• 描述：创建一个带有指定 duration 和 vsync 的 AnimationController。
• 参数：
  • key: String 键。
  • initialValue: V 动画的初始值。

useAnimationController

• 描述：创建一个带有指定 duration 和 vsync 的 AnimationController。
• 参数：
  • key: String 键。
  • duration: Duration 动画的持续时间。
  • vsync: TickerProvider 控制器的同步器。

useStreamSubscription

• 描述：管理一个 StreamSubscription。
• 参数：
  • key: String 键。
  • stream: 订阅的流。
  • onData: 数据事件回调。

useTextEditingController

• 描述：管理一个 StreamSubscription。
• 参数：
  • key: String 键。
  • text: String? 初始值。

useTimer 和 usePeriodicTimer

• 描述：管理单次或周期性定时器。
• 参数：
  • key: String 键。
  • duration: Duration 定时器每次触发的时间间隔或直到定时器触发的时间。
  • callback: 定时器触发时执行的函数。

useCustomScene<R>

• 描述：管理一个自定义可处置组件。
• 参数：
  • key: String 键。
  • createHandler: 创建 R 对象的函数。
  • disposeHandler: 在 UseStateScene 内部处置对象的回调。

完整示例

以下是一个完整的示例，展示了如何使用 UseStateMixin 来管理动画控制器、周期性定时器、流订阅等。

import 'package:flutter/material.dart';
import 'package/flutter/services.dart';
import 'dart:async';
import 'package:use_state_utils/use_state_utils.dart';
import 'package:rxdart/rxdart.dart';

void main() {
  UseStateConfig.debugPrintOnFailedDispose = true;
  UseStateConfig.debugPrintOnSuccessDispose = true;
  runApp(const MyApp());
}

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

  [@override](/user/override)
  Widget build(BuildContext context) {
    return const MaterialApp(
      localizationsDelegates: [
        DefaultMaterialLocalizations.delegate,
        DefaultWidgetsLocalizations.delegate,
      ],
      home: HomePage(), // Use DemoPage as the home widget
    );
  }
}

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

  [@override](/user/override)
  State<HomePage> createState() => _HomePageState();
}

class _HomePageState extends State<HomePage> {
  [@override](/user/override)
  void initState() {
    SystemChrome.setSystemUIOverlayStyle(SystemUiOverlayStyle(
        systemNavigationBarColor: Colors.transparent,
        statusBarColor: Colors.blue.withOpacity(0.5)));
    SystemChrome.setEnabledSystemUIMode(SystemUiMode.edgeToEdge);
    super.initState();
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
        body: Center(
            child: ElevatedButton(
                onPressed: () {
                  Navigator.of(context).push(MaterialPageRoute(
                      builder: (context) => const DemoPage()));
                },
                child: const Text('Demo Page'))));
  }
}

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

  [@override](/user/override)
  State createState() => DemoPageState();
}

class DemoPageState extends State<DemoPage> with UseStateMixin<DemoPage>, TickerProviderStateMixin {
  late AnimationController _animationController;
  late Animation<Color?> _colorTween;
  late BehaviorSubject<int?> _streamController;
  int _counter = 0;

  [@override](/user/override)
  void initState() {
    super.initState();
    _animationController = useAnimationController(key: 'anim1', vsync: this);
    _colorTween = ColorTween(begin: Colors.cyan, end: Colors.deepOrange).animate(_animationController);

    usePeriodicTimer(
        key: 'timer1',
        callback: _handleTimer,
        duration: const Duration(seconds: 1));

    _streamController = BehaviorSubject.seeded(null);

    useStreamSubscription(
      key: 'stream1',
      stream: _streamController,
      onData: _handleStreamData,
    );
  }

  void _handleTimer(Timer timer) {
    setState(() {
      _counter++;
    });
  }

  void _handleStreamData(int? data) {
    if (data == null) return;
    showDialog(
      context: context,
      builder: (context) => AlertDialog(
        title: const Text('Stream Alert'),
        content: Text('Stream sent: $data'),
        actions: [
          TextButton(
            child: const Text('OK'),
            onPressed: () => Navigator.of(context).pop(),
          ),
        ],
      ),
    );
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: const Text('UseStateMixin Demo'),
      ),
      body: AnimatedBuilder(
          animation: _colorTween,
          builder: (context, _) {
            return Material(
              color: _colorTween.value,
              key: const Key('background'),
              child: Column(
                mainAxisAlignment: MainAxisAlignment.center,
                children: <Widget>[
                  const Center(child: Text('Fade Transition')),
                  ElevatedButton(
                    onPressed: () {
                      if (_animationController.isCompleted) {
                        _animationController.reverse();
                      } else {
                        _animationController.forward();
                      }
                    },
                    child: const Text('Toggle Animation'),
                  ),
                  const SizedBox(height: 20),
                  Text('Timer count: $_counter'),
                  ElevatedButton(
                    onPressed: () => _streamController.add(99),
                    child: const Text('Send Stream Data'),
                  ),
                ],
              ),
            );
          }),
    );
  }
}