Flutter属性监听与构建插件simple_property_observer_builder的使用

Flutter属性监听与构建插件simple_property_observer_builder的使用

Dart包用于自动生成一个属性可观察类。 此包仅适用于开发环境。 请参阅simple_property_observer包。

如何使用

此存储库包含两个包，simple_property_observer 和 simple_property_observer_builder。这些包可以在纯 Dart 项目以及 Flutter 中使用。example 是使用这些包的一个简单示例。

依赖设置

在您的pubspec.yaml文件中，添加以下依赖项：

dependencies:
  simple_property_observer: any

dev_dependencies:
  build_runner: any
  simple_property_observer_builder: any

• simple_property_observer 包含属性可观察模式的定义和自动生成的注解。
• simple_property_observer_builder 包含命令行工具用于自动生成功能。

定义您的类

例如，编写以下带注解的类：

import 'package:simple_property_observer/simple_property_observer.dart';

part 'example.g.dart';

@propertyObservable
class Example {
  @observable
  String? get observableProperty => null;
}

Dart 分析会指出错误，但忽略它并继续下一步。

注意点

• 使用@propertyObservable注解您的类以自动生成属性可观察模式。
• 创建一个GETTER并用@observable注解。
• 添加part语句以生成自动文件。

然后，在终端中运行生成命令：

$ flutter packages pub run build_runner build

如果您创建的是一个纯 Dart 项目，则运行以下命令：

$ dart run build_runner build

完成命令后，您可以看到example.g.dart文件：

// 自动生成的代码 - 不要手动修改

part of 'example.dart';

// **************************************************************************
// PropertyObservableGenerator
// **************************************************************************

mixin _ObservableMembers on PropertyObservable {
  String? __observableProperty;
  set observableProperty(String? value) {
    if (__observableProperty == value) {
      return;
    }
    final oldValue = __observableProperty;
    __observableProperty = value;
    notifyPropertyChanged(PropertyChangedInfo(
        'observableProperty', oldValue, __observableProperty));
  }
}

注意点

然后，您必须将example.dart修改为如下所示：

import 'package:simple_property_observer/simple_property_observer.dart';

part 'example.g.dart';

@propertyObservable
class Example with PropertyObservable, _ObservableMembers {
  @observable
  String? get observableProperty => __observableProperty;
}

添加with PropertyObservable, _ObservableMembers并将getter从null更改为__observableProperty。

监听实例

您可以使用registerObserver方法来监听属性变化：

import 'example.dart';

void main() {
  final example = Example();

  // 监听属性变化
  example.registerObserver((info) {
    print('${info.name} changed: from ${info.oldValue} to ${info.newValue}');
  });

  print('设置为 Apple');
  example.observableProperty = 'Apple';

  print('设置为 Banana');
  example.observableProperty = 'Banana';

  // 显示输出如下：
  // 设置为 Apple
  // observableProperty changed: from null to Apple
  // 设置为 Banana
  // observableProperty changed: from Apple to Banana
}