Flutter生命周期感知状态管理插件lifecycle_aware_state的使用

Flutter生命周期感知状态管理插件lifecycle_aware_state的使用

简介

lifecycle_aware_state 是一个Flutter插件，它允许你在Flutter项目中监听路由导航和状态生命周期的不同事件。通过使用这个插件，你可以更好地管理应用的状态，并在特定的生命周期事件发生时执行相应的逻辑。

使用步骤

1. 添加依赖 在你的 pubspec.yaml 文件中添加 lifecycle_aware_state 作为依赖项：

   dependencies:
     lifecycle_aware_state: ^latest_version
   

2. 注册路由观察者 在 MaterialApp 中添加 navigatorObservers，并注册 LifecycleAwareState.routeObserver：

   class MyApp extends StatelessWidget {
     [@override](/user/override)
     Widget build(BuildContext context) {
       return MaterialApp(
         // 其他配置...
         navigatorObservers: [LifecycleAwareState.routeObserver], // 注册路由观察者
         // 其他配置...
       );
     }
   }
   

3. 配置日志选项（可选） 在应用启动之前，你可以配置一些日志选项，以便更好地调试：

   void main() {
     LifecycleAwareState.logClassSuffixes = ['Page']; // 只记录类名以 'Page' 结尾的日志
     LifecycleAwareState.logSuffixedClassesOnly = true; // 仅对上述类启用日志记录
     runApp(const MyApp());
   }
   

4. 扩展 LifecycleAwareState 在你需要监听生命周期事件的 State 类中，继承 LifecycleAwareState 而不是 State：

   class _MyHomePageState extends LifecycleAwareState<MyHomePage> {
     [@override](/user/override)
     Widget build(BuildContext context) {
       super.build(context);
       return Scaffold(
         appBar: AppBar(title: const Text('LifecycleAwareState Demo')),
         body: const Center(
           child: Text('Hello Lifecycle'),
         ),
       );
     }
   
     [@override](/user/override)
     void onPause() {
       // 当小部件不可见时调用
       super.onPause();
     }
   
     [@override](/user/override)
     void onResume() {
       // 当小部件重新可见时调用
       super.onResume();
     }
   
     [@override](/user/override)
     void onReady() {
       // 当小部件构建完成并可见时调用
       super.onReady();
     }
   
     [@override](/user/override)
     void didPop() {
       // 当当前路由从导航器中弹出时调用
       super.didPop();
     }
   
     [@override](/user/override)
     void didPopNext() {
       // 当顶部路由被弹出，当前路由显示时调用
       super.didPopNext();
     }
   
     [@override](/user/override)
     void didPush() {
       // 当当前路由被推送时调用
       super.didPush();
     }
   
     [@override](/user/override)
     void didPushNext() {
       // 当新路由被推送，当前路由不再可见时调用
       super.didPushNext();
     }
   }
   

完整示例

以下是一个完整的示例代码，展示了如何使用 lifecycle_aware_state 插件来监听和响应Flutter应用的生命周期事件：

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

void main() {
  // 配置日志选项
  LifecycleAwareState.logClassSuffixes = ['Page'];
  LifecycleAwareState.logSuffixedClassesOnly = true;

  runApp(const MyApp());
}

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

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'LifecycleAwareState Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      navigatorObservers: [LifecycleAwareState.routeObserver], // 注册路由观察者
      home: const MyHomePage(),
    );
  }
}

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

  [@override](/user/override)
  State<MyHomePage> createState() => _MyHomePageState();
}

class _MyHomePageState extends LifecycleAwareState<MyHomePage> {
  [@override](/user/override)
  Widget build(BuildContext context) {
    super.build(context);
    return Scaffold(
      appBar: AppBar(title: const Text('LifecycleAwareState Demo')),
      body: const Center(
        child: Text('Hello Lifecycle'),
      ),
    );
  }

  [@override](/user/override)
  void onPause() {
    // 当小部件不可见时调用
    super.onPause();
    print('onPause: 小部件不可见');
  }

  [@override](/user/override)
  void onResume() {
    // 当小部件重新可见时调用
    super.onResume();
    print('onResume: 小部件重新可见');
  }

  [@override](/user/override)
  void onReady() {
    // 当小部件构建完成并可见时调用
    super.onReady();
    print('onReady: 小部件已构建并可见');
  }

  [@override](/user/override)
  void didPop() {
    // 当当前路由从导航器中弹出时调用
    super.didPop();
    print('didPop: 当前路由被弹出');
  }

  [@override](/user/override)
  void didPopNext() {
    // 当顶部路由被弹出，当前路由显示时调用
    super.didPopNext();
    print('didPopNext: 顶部路由被弹出，当前路由显示');
  }

  [@override](/user/override)
  void didPush() {
    // 当当前路由被推送时调用
    super.didPush();
    print('didPush: 当前路由被推送');
  }

  [@override](/user/override)
  void didPushNext() {
    // 当新路由被推送，当前路由不再可见时调用
    super.didPushNext();
    print('didPushNext: 新路由被推送，当前路由不再可见');
  }
}