Flutter引用管理插件simple_ref的使用

Simple Ref

一个简单、轻量且自动释放的Flutter服务定位器引用库，支持覆盖。

安装

flutter pub add simple_ref

使用

导入包

import 'package:simple_ref/simple_ref.dart';

单例引用

final repositoryRef = Ref(() => Repository());

// 或者使用tear-off方式
final repositoryRef = Ref(Repository.new);

// 访问实例
final repository = repositoryRef();

// 覆盖
repositoryRef.overrideWith(() => MockRepository());

自动释放，将应用包裹在RefScope中

runApp(
    const RefScope(
        child: MyApp(),
    ),
);

实现、扩展或混入Disposable并重写dispose方法

class Controller implements Disposable {
  final counter = ValueNotifier(0);

  [@override](/user/override)
  void dispose() {
    counter.dispose();
  }
}

创建自动释放引用

final controllerRef = Ref.autoDispose((_) => Controller());

访问实例

这可以通过Widget或引用通过controllerRef.of(context)或controllerRef(context)来完成。

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

    [@override](/user/override)
    Widget build(BuildContext context) {
        final controller = controllerRef.of(context);
        return Text('${controller.counter.value}');
    }
}

覆盖它

你可以通过使用overrideWith来覆盖实例。这对于测试或初始化异步实例非常有用。在下面的例子中，所有对controllerRef.of(context)的调用都将返回MockController。

controllerRef.overrideWith((context) => MockController());

示例代码

以下是一个完整的示例，包括一个计数器应用程序，展示了如何使用simple_ref插件。

import 'package:flutter/foundation.dart';
import 'package:flutter/material.dart';
import 'package:simple_ref/simple_ref.dart';

class Controller implements Disposable {
  late final _count = ValueNotifier(0);

  // 我们将其暴露为可读的监听值，以便从外部无法更改。
  ValueListenable<int> get count => _count;

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

  [@override](/user/override)
  void dispose() {
    _count.dispose();
  }
}

final countControllerRef = Ref.autoDispose((_) => Controller());

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

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

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('Simple Ref 计数器'),
          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](/user/override)
  Widget build(BuildContext context) {
    final controller = countControllerRef.of(context);
    final theme = Theme.of(context);

    return ListenableBuilder(
      listenable: controller.count,
      builder: (_, __) {
        final count = controller.count.value;
        return Text('$count', style: theme.textTheme.displayLarge);
      },
    );
  }
}

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

  [@override](/user/override)
  Widget build(BuildContext context) {
    final controller = countControllerRef(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),
        ),
      ],
    );
  }
}