Flutter插件功能介绍插件published的使用

动机

published 是受 Swift 中的 Published 属性包装器启发而创建的。

有许多方法如使用 BloC 需要依赖于流，这会引入大量样板代码。published 的目标是减少这些样板代码并引入简单的状态管理。

如何使用

安装

要在您的项目中使用 package:published，请在 pubspec.yaml 文件中添加以下依赖项：

dependencies:
  published:

dev_dependencies:
  build_runner:
  published_gen:

使用

首先，确保您已经安装了上述依赖项。然后，您可以按照以下步骤使用 published 插件：

import 'package:published/published.dart';

part 'counter_view_model.published.dart';

[@published](/user/published)
abstract class CounterViewModel extends _$CounterViewModel {
  @Publisher()
  abstract int count;

  void increment() => count++;

  [@override](/user/override)
  bool get enableLogging => true;
}

• 您需要创建一个抽象类，并用 [@published](/user/published) 注解它，并扩展 _$ClassName。
• 使用 @Publisher() 注解抽象字段以暴露流。

注意：必须使用抽象字段和类来复制 Swift 结构。

接下来，运行以下命令生成文件到源目录中：

> flutter packages pub run build_runner build
[INFO] ensureBuildScript: Generating build script completed, took 368ms
[INFO] BuildDefinition: Reading cached asset graph completed, took 54ms
[INFO] BuildDefinition: Checking for updates since last build completed, took 663ms
[INFO] Build: Running build completed, took 10ms
[INFO] Build: Caching finalized dependency graph completed, took 44ms
[INFO] Build: Succeeded after 4687ms with 1 outputs

为了使用该模型，请执行以下操作：

// 初始化
final model = CounterViewModelBuilder.build(count: 0);

// 在构建函数中使用
Widget build(BuildContext context) {
  return Scaffold(
    body: Center(
      child: Column(
        mainAxisAlignment: MainAxisAlignment.center,
        children: <Widget>[
          Text(
            'You have pushed the button this many times:',
          ),
          StreamBuilder<int>(
            stream: model.$count,
            builder: (context, snapshot) => Text("${snapshot.data ?? 0}"),
          ),
        ],
      ),
    ),
    floatingActionButton: FloatingActionButton(
      onPressed: () => model.count++,
      tooltip: 'Increment',
      child: Icon(Icons.add),
    ),
  );
}

$classNameBuilder.build() 需要用于创建对象实例。如果您不想在 build() 方法中传递默认值，可以使用 Publisher 上的 defaultValue 属性，如下所示：

@Publisher(defaultValue: "John")
abstract String name;

要观察任何带有 Publisher 注解的属性是否已更改，您可以使用 didChange：

model.didChange.listen(() => doSomething());

如果您想启用日志记录，可以覆盖 enableLogging 获取器：

[@published](/user/published)
abstract class CounterViewModel extends _$CounterViewModel {
  ...
  [@override](/user/override)
  bool get enableLogging => true;
}

最后，如果您想在对象创建时执行某些操作，可以重写 onBind 方法并将逻辑放置在那里：

[@published](/user/published)
abstract class CounterViewModel extends _$CounterViewModel {
  ...
  [@override](/user/override)
  void onBind() {
    super.onBind();
    fetchSomeData();
  }
}