Flutter全局变量管理插件flutter_globals的使用

Flutter全局变量管理插件flutter_globals的使用

Global 是一个基于单例的动态状态管理器，允许以全局方式管理变量，并且与 flutter_secure_storage 集成良好。这使得您的应用程序的数据持久化变得非常方便，例如缓存、令牌等常用信息可以轻松访问。

特性

• refresh(dynamic dependency): 通知特定监听器更新其状态。
• refreshAll(): 通知所有监听器更新其状态。
• statusOf(String key): 返回一个工作者的状态。
• setStatus(String key, dynamic status): 设置一个工作者的状态。
• set(String key, dynamic value): 在全局中设置与键关联的值并返回该键的引用。
• make(String key, Function(dynamic) maker): 使用 maker 函数创建一个值并返回该键的引用。
• get(String key): 获取全局中与键关联的值。
• store(String key, dynamic value): 使用 flutter_secure_storage 将值存储在设备上。
• free(String key): 移除全局中的键及其值。
• ref(String key): 返回全局中键的引用。
• clear(): 移除全局中的所有值。
• lock(String key): 锁定特定键以避免更改。
• unlock(String key): 解锁先前锁定的键。
• on(String key, Function(dynamic params, Function(dynamic) setStatus) work): 为全局中的键定义要执行的工作。
• off(String key): 移除与键关联的工作。
• call(String key, {dynamic params}): 执行与键关联的工作并更新状态。
• caller(String key, {dynamic params}): 返回一个函数，可用于执行与键关联的工作。
• bind(dynamic obj): 返回对象的单例实例。
• dispose(dynamic obj): 移除对象的单例实例。

开始使用

Global 不需要任何设置，只需安装包并在需要的地方使用即可！

使用示例

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

// 定义枚举类型
enum MyGlobals { token, userName, userId }

// 定义动作枚举类型
enum MyAction {
  absent,
  loading,
  sucess,
  fail,
}

// 定义控制器类
class MyController {
  List<String> myExamples = [];
  int counter = 0;

  // 登录方法
  Future<void> login() async {
    final token = await Restify.get<String>("/login");
    Global.set(MyGlobals.token, token).store(); // 将令牌保存到本地存储并全局可用
  }

  // 自定义函数
  Future<void> myFunction() async {
    Global.setStatus(MyAction.loading);
    try {
      final examples = await Restify.get<List<String>>("/examples", bearerToken: Global.get(MyGlobals.token));
      myExamples = examples;
      Global.setStatus(MyAction.sucess); // 更新请求状态为成功并更新反应式组件
    } catch (err) {
      Global.setStatus(MyAction.fail); // 更新请求状态为失败并更新反应式组件
    }
  }

  // 计数方法
  void count() {
    counter++;
    Global.refresh(); // 更新反应式组件
  }
}

// 主页面类
class MyHomePage extends StatefulWidget {
  const MyHomePage({super.key, required this.title});
  final String title;

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

class _MyHomePageState extends State<MyHomePage> {
  // 绑定控制器
  late final MyController myController = Global.bind(MyController());

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

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Reactive(() => Text("Counter: ${myController.counter}")), // 使文本具有反应性
      ),
      body: ReactiveStatus<MyAction>(
        // 允许屏幕根据状态更改其组件
        {
          MyAction.sucess: () => ListView(
            children: myController.myExamples.map((e) => Text(e)).toList(),
          ),
          MyAction.fail: () => const Text(" fail :( "),
          MyAction.loading: () => const CircularProgressIndicator(),
        },
      ),
      floatingActionButton: FloatingActionButton(
        onPressed: myController.count,
        child: const Icon(Icons.add),
      ),
    );
  }
}