Flutter未知功能插件lite_ref的潜在用途探索

概述

Lite Ref 是一个为 Dart 和 Flutter 设计的轻量级依赖注入库。它通过不使用哈希表来存储实例，从而实现了比其他 DI 库更快的速度，并且由于使用了顶级变量，因此不可能出现 NOT_FOUND 错误。此外，它没有任何依赖项，API 简单易学。

安装

dart pub add lite_ref

为什么选择 Lite Ref？

• 快速：不使用哈希表存储实例，速度优于所有其他 DI 库。
• 安全：使用顶级变量，不可能出现 NOT_FOUND 错误。
• 轻量：没有依赖项。
• 简单：易于学习，API 表面小。

Scoped Refs

使用场景

ScopedRef 是一种需要构建上下文才能访问其实例的引用。它是 Provider 的替代方案，适用于不会重建小部件的类（例如控制器、仓库、服务等）。

示例代码

1. 包裹应用程序或子树

   runApp(
     LiteRefScope(
       child: MyApp(),
     ),
   );
   

2. 创建 ScopedRef

   final settingsServiceRef = Ref.scoped((ctx) => SettingsService());
   

3. 在当前作用域中访问实例

   class SettingsPage extends StatelessWidget {
     const SettingsPage({super.key});
   
     @override
     Widget build(BuildContext context) {
       final settingsService = settingsServiceRef.of(context);
       return Text(settingsService.getThemeMode());
     }
   }
   

4. 为子树覆盖实例

   LiteRefScope(
     overrides: {
       settingsServiceRef.overrideWith((ctx) => MockSettingsService()),
     },
     child: MyApp(),
   ),
   

ScopedFamilyRef

当需要为不同的键创建唯一实例时，可以使用 ScopedFamilyRef。这在需要创建具有不同配置的多个相同类实例时非常有用。

final postControllerRef = Ref.scopedFamily((ctx, String key) {
  return PostController(key)..fetch();
});

class PostsPage extends StatelessWidget {
  const PostsPage({required this.keys, super.key});

  final List<String> keys;

  @override
  Widget build(BuildContext context) {
    return ListView.builder(
      itemBuilder: (context, index) {
        final post = postControllerRef.of(context, keys[index]);
        return Text(post?.title ?? 'Loading...');
      },
    );
  }
}

自动释放

当 ScopedRef 提供 ChangeNotifier、ValueNotifier 或实现 Disposable 的类时，它会在所有具有访问权限的小部件卸载时自动释放实例。

class CounterController extends ChangeNotifier {
  var _count = 0;
  int get count => _count;

  void increment() {
    _count++;
    notifyListeners();
  }

  void decrement() {
    _count--;
    notifyListeners();
  }
}

final countControllerRef = Ref.scoped((ctx) => CounterController());

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

  @override
  Widget build(BuildContext context) {
    final controller = countControllerRef.of(context);
    return ListenableBuilder(
      listenable: controller,
      builder: (context, snapshot) {
        return Text('${controller.count}');
      },
    );
  }
}

全局单例和瞬态

创建单例

final dbRef = Ref.singleton(() => Database());

assert(dbRef.instance == dbRef.instance);

使用单例

final db = dbRef.instance; // 或者 dbRef()

覆盖单例（用于测试）

dbRef.overrideWith(() => MockDatabase());

冻结单例（禁用覆盖）

dbRef.freeze();

创建瞬态实例（始终返回新实例）

final dbRef = Ref.transient(() => Database());

assert(dbRef.instance != dbRef.instance);

异步创建单例

final dbRef = Ref.asyncSingleton(() async => await Database.init());

使用异步单例

final db = await dbRef.instance;

同步使用异步单例

// 仅在确认实例已创建的情况下使用
final db = dbRef.assertInstance;

示例应用

以下是一个完整的示例应用，展示了如何使用 Lite Ref 和 State Beacon 实现计数器功能。

import 'package:flutter/material.dart';
import 'package:lite_ref/lite_ref.dart';
import 'package:state_beacon/state_beacon.dart';

class Controller {
  late final _count = Beacon.writable(0);

  // 我们将其暴露为只读信标
  // 以便无法从外部更改控制器。
  ReadableBeacon<int> get count => _count;

  void increment() => _count.value++;
  void decrement() => _count.value--;
}

final countControllerRef = Ref.scoped((ctx) => Controller());

void main() {
  runApp(LiteRefScope(child: const MyApp()));
}

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

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('Lite Ref and State Beacon Counter'),
          centerTitle: true,
          backgroundColor: Theme.of(context).colorScheme.inversePrimary,
        ),
        body: const Center(child: CounterText()),
        floatingActionButton: const Buttons(),
      ),
    );
  }
}

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

  @override
  Widget build(BuildContext context) {
    final controller = countControllerRef.of(context);
    final count = controller.count.watch(context);
    final theme = Theme.of(context);
    return Text('$count', style: theme.textTheme.displayLarge);
  }
}

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

  @override
  Widget build(BuildContext context) {
    final controller = countControllerRef.of(context);
    return Column(
      mainAxisAlignment: MainAxisAlignment.end,
      crossAxisAlignment: CrossAxisAlignment.end,
      children: [
        FloatingActionButton(
          onPressed: controller.increment,
          child: const Icon(Icons.add),
        ),
        const SizedBox(height: 8),
        FloatingActionButton(
          onPressed: controller.decrement,
          child: const Icon(Icons.remove),
        ),
      ],
    );
  }
}

这个示例展示了如何使用 Lite Ref 进行依赖注入，并结合 State Beacon 实现状态管理。通过这种方式，您可以轻松管理和共享应用程序中的状态，同时保持代码的简洁性和可维护性。