Flutter注解支持插件tracker_annotations的使用

如何使用

安装

要使用tracker_generators，你需要典型的build_runner/代码生成器设置。首先，在你的pubspec.yaml文件中添加以下依赖：

对于一个Flutter项目：

flutter pub add tracker_annotations
flutter pub add dev:build_runner
flutter pub add dev:tracker_generators

这将安装三个包：

• build_runner，用于运行代码生成器的工具。
• tracker_generators，代码生成器。
• tracker_annotations，包含tracker_generators所需注解的包。

运行生成器

要运行代码生成器，请执行以下命令：

dart run build_runner build

请注意，像大多数代码生成器一样，tracker_generators需要你导入注解（tracker_annotations）并在文件顶部使用part关键字。

因此，一个想要使用tracker_generators的文件将以以下方式开始：

import 'package:tracker_annotations/tracker_annotations.dart';

part 'my_file.trackable.dart';

创建一个可跟踪的页面

一个典型的可跟踪类如下所示：

part 'sign_in_page.trackable.dart';

@trackable
class SignInPage extends StatefulWidget {
  const SignInPage({Key? key}) : super(key: key);

  @override
  State<SignInPage> createState() => _SignInPageState();
}

class _SignInPageState extends State<SignInPage> with _$SignInPageMixin {
}

• 使用@trackable注解来生成part 'sign_in_page.trackable.dart';文件。
• part 'sign_in_page.trackable.dart';文件由tracker_flutter_generator.dart文件生成，可以用来跟踪屏幕。

定义一个Trackable类来跟踪屏幕：

class Trackable {
  final String? contentType;
  final String? referrer;

  const Trackable({this.contentType, this.referrer});
}

• 使用Trackable类来跟踪屏幕。
• Trackable类有两个属性：contentType和referrer。

在main()函数中设置Trackable.observer：

void main() {
  runApp(const MyApp());

  Trackable.observer = const MyObserver();
}

• 设置Trackable.observer为MyObserver类。

实现TrackableObserver类以观察屏幕：

class MyObserver extends TrackableObserver {
  @override
  void onEnter(TrackerEventData event) {
    // 当进入屏幕时做某些事情
  }

  @override
  void onExit(TrackerEventData event) {
    // 当退出屏幕时做某些事情
  }
}

• 实现TrackableObserver类来观察屏幕。
• 实现onEnter方法来当进入屏幕时做某些事情。
• 实现onExit方法来当退出屏幕时做某些事情。