这个确切的用例在 Track Screenviews 部分下的 Firebase Analytics 文档中。
如果您的应用不为您可能希望跟踪的每个屏幕(例如在游戏中)使用单独的 UIViewController 或 Activity,则手动跟踪屏幕很有用。
这正是 Flutter 的情况,因为 Flutter 负责屏幕更新:大多数简单的 Flutter 应用程序运行一个 FlutterActivity/FlutterAppDelegate,它负责自己渲染不同的屏幕,因此让 Firebase Analytics 自动跟踪屏幕不会带来预期的效果。
就我过去的经验而言,FirebaseAnalyticsObserver 并不是很有帮助,但是,我也向您推荐check their docs again,它们确实暗示事情应该“正常工作”。我最好的猜测是它对我来说效果不佳,因为我没有在我的任何路线上使用RouteSettings*。
如果FirebaseAnalyticsObserver 无法工作或无法申请您的应用,那么在过去几个月的开发过程中,下一个方法对我来说效果很好。
您可以在任何时候使用FirebaseAnalytics 设置当前屏幕,如果您使用屏幕名称调用setCurrentScreen 方法:
import 'package:firebase_analytics/firebase_analytics.dart';
// Somewhere in your widgets...
FirebaseAnalytics().setCurrentScreen(screenName: 'Example1');
作为第一次尝试,我在小部件构造函数中这样做了,但这不会很好地工作并且错误地计算了事件:如果你弹出或推送路由,堆栈中的所有小部件构造函数都将被调用,即使实际上只有顶部路由符合“当前屏幕”的条件。
为了解决这个问题,我们需要使用RouteAware 类,并且只设置当前屏幕以防它是顶部路由:要么我们的路由被添加到堆栈中,要么之前的顶部路由被弹出并且我们到达了路由.
RouteAware 带有样板代码,我们不想在所有屏幕上重复该样板代码。即使对于小型应用程序,您也有几十个不同的屏幕,所以我创建了RouteAwareAnalytics mixin:
import 'package:firebase_analytics/firebase_analytics.dart';
import 'package:flutter/widgets.dart';
// A Navigator observer that notifies RouteAwares of changes to state of their Route
final routeObserver = RouteObserver<PageRoute>();
mixin RouteAwareAnalytics<T extends StatefulWidget> on State<T>
implements RouteAware {
AnalyticsRoute get route;
@override
void didChangeDependencies() {
routeObserver.subscribe(this, ModalRoute.of(context));
super.didChangeDependencies();
}
@override
void dispose() {
routeObserver.unsubscribe(this);
super.dispose();
}
@override
void didPop() {}
@override
void didPopNext() {
// Called when the top route has been popped off,
// and the current route shows up.
_setCurrentScreen(route);
}
@override
void didPush() {
// Called when the current route has been pushed.
_setCurrentScreen(route);
}
@override
void didPushNext() {}
Future<void> _setCurrentScreen(AnalyticsRoute analyticsRoute) {
print('Setting current screen to $analyticsRoute');
return FirebaseAnalytics().setCurrentScreen(
screenName: screenName(analyticsRoute),
screenClassOverride: screenClass(analyticsRoute),
);
}
}
我创建了一个enum 来跟踪屏幕(以及将枚举转换为屏幕名称的函数)。我使用枚举能够轻松跟踪所有路由,重构路由名称。使用这些枚举和函数,我可以对所有可能的值进行单元测试并强制执行一致的命名:没有意外空格或特殊字符,没有不一致的大小写。可能还有其他更好的方法来确定屏幕类值,但我采用了这种方法。
enum AnalyticsRoute { example }
String screenClass(AnalyticsRoute route) {
switch (route) {
case AnalyticsRoute.example:
return 'ExampleRoute';
}
throw ArgumentError.notNull('route');
}
String screenName(AnalyticsRoute route) {
switch (route) {
case AnalyticsRoute.example:
return '/example';
}
throw ArgumentError.notNull('route');
}
初始设置的下一步是将routeObserver 注册为navigatorObserver 的navigatorObserver:
MaterialApp(
// ...
navigatorObservers: [
routeObserver,
// FirebaseAnalyticsObserver(analytics: FirebaseAnalytics()),
],
);
最后,我们可以添加我们第一个跟踪的示例路线。将with RouteAwareAnalytics 添加到您的状态并覆盖get route。
class ExampleRoute extends StatefulWidget {
@override
_ExampleRouteState createState() => _ExampleRouteState();
}
class _ExampleRouteState extends State<ExampleRoute> with RouteAwareAnalytics{
@override
Widget build(BuildContext context) => Text('Example');
@override
AnalyticsRoute get route => AnalyticsRoute.example;
}
每次添加新路由时,您都可以毫不费力地完成:首先,添加一个新的枚举值,然后 Dart 编译器会指导您接下来添加什么:添加屏幕名称和类覆盖它们各自switch-case 中的值。然后,找到正在构建路由的州,添加 with RouteAwareAnalytics,并添加 route getter。
* 我不使用RouteSettings 的原因是我更喜欢带有类型参数的Simon Lightfoot's approach,而不是设置提供的Object 参数:
class ExampleRoute extends StatefulWidget {
const ExampleRoute._({@required this.integer, Key key}) : super(key: key);
// All types of members are supported, but I used int as example
final int integer;
static Route<void> route({@required int integer}) =>
MaterialPageRoute(
// I could add the settings here, though, it wouldn't enforce good types
builder: (_) => ExampleRoute._(integer: integer),
);
// ...
}