refactor: migrate WidgetsBindingObserver to AppLifecycleListener

flutter · Dec 5, 2023 · 1f2fceb · 1f2fceb
1 parent 8b31ff0
commit 1f2fceb
Show file tree

Hide file tree

Showing 5 changed files with 31 additions and 59 deletions.
diff --git a/samples/ads/lib/app_lifecycle/app_lifecycle.dart b/samples/ads/lib/app_lifecycle/app_lifecycle.dart
@@ -8,8 +8,6 @@ import 'package:provider/provider.dart';
 
 typedef AppLifecycleStateNotifier = ValueNotifier<AppLifecycleState>;
 
-// TODO(filiph): use the new AppLifecycleListener class, e.g.
-//               https://kazlauskas.dev/flutter-app-lifecycle-listener-overview/
 class AppLifecycleObserver extends StatefulWidget {
   final Widget child;
 
@@ -19,9 +17,9 @@ class AppLifecycleObserver extends StatefulWidget {
   State<AppLifecycleObserver> createState() => _AppLifecycleObserverState();
 }
 
-class _AppLifecycleObserverState extends State<AppLifecycleObserver>
-    with WidgetsBindingObserver {
+class _AppLifecycleObserverState extends State<AppLifecycleObserver> {
   static final _log = Logger('AppLifecycleObserver');
+  late final AppLifecycleListener _appLifecycleListener;
 
   final ValueNotifier<AppLifecycleState> lifecycleListenable =
       ValueNotifier(AppLifecycleState.inactive);
@@ -46,22 +44,18 @@ class _AppLifecycleObserverState extends State<AppLifecycleObserver>
     );
   }
 
-  @override
-  void didChangeAppLifecycleState(AppLifecycleState state) {
-    _log.info(() => 'didChangeAppLifecycleState: $state');
-    lifecycleListenable.value = state;
-  }
-
   @override
   void dispose() {
-    WidgetsBinding.instance.removeObserver(this);
+    _appLifecycleListener.dispose();
     super.dispose();
   }
 
   @override
   void initState() {
     super.initState();
-    WidgetsBinding.instance.addObserver(this);
+    _appLifecycleListener = AppLifecycleListener(
+      onStateChange: (s) => lifecycleListenable.value = s,
+    );
     _log.info('Subscribed to app lifecycle updates');
   }
 }
diff --git a/samples/multiplayer/lib/app_lifecycle/app_lifecycle.dart b/samples/multiplayer/lib/app_lifecycle/app_lifecycle.dart
@@ -8,8 +8,6 @@ import 'package:provider/provider.dart';
 
 typedef AppLifecycleStateNotifier = ValueNotifier<AppLifecycleState>;
 
-// TODO(filiph): use the new AppLifecycleListener class, e.g.
-//               https://kazlauskas.dev/flutter-app-lifecycle-listener-overview/
 class AppLifecycleObserver extends StatefulWidget {
   final Widget child;
 
@@ -19,9 +17,9 @@ class AppLifecycleObserver extends StatefulWidget {
   State<AppLifecycleObserver> createState() => _AppLifecycleObserverState();
 }
 
-class _AppLifecycleObserverState extends State<AppLifecycleObserver>
-    with WidgetsBindingObserver {
+class _AppLifecycleObserverState extends State<AppLifecycleObserver> {
   static final _log = Logger('AppLifecycleObserver');
+  late final AppLifecycleListener _appLifecycleListener;
 
   final ValueNotifier<AppLifecycleState> lifecycleListenable =
       ValueNotifier(AppLifecycleState.inactive);
@@ -46,22 +44,18 @@ class _AppLifecycleObserverState extends State<AppLifecycleObserver>
     );
   }
 
-  @override
-  void didChangeAppLifecycleState(AppLifecycleState state) {
-    _log.info(() => 'didChangeAppLifecycleState: $state');
-    lifecycleListenable.value = state;
-  }
-
   @override
   void dispose() {
-    WidgetsBinding.instance.removeObserver(this);
+    _appLifecycleListener.dispose();
     super.dispose();
   }
 
   @override
   void initState() {
     super.initState();
-    WidgetsBinding.instance.addObserver(this);
+    _appLifecycleListener = AppLifecycleListener(
+      onStateChange: (s) => lifecycleListenable.value = s,
+    );
     _log.info('Subscribed to app lifecycle updates');
   }
 }
diff --git a/templates/basic/lib/app_lifecycle/app_lifecycle.dart b/templates/basic/lib/app_lifecycle/app_lifecycle.dart
@@ -8,8 +8,6 @@ import 'package:provider/provider.dart';
 
 typedef AppLifecycleStateNotifier = ValueNotifier<AppLifecycleState>;
 
-// TODO(filiph): use the new AppLifecycleListener class, e.g.
-//               https://kazlauskas.dev/flutter-app-lifecycle-listener-overview/
 class AppLifecycleObserver extends StatefulWidget {
   final Widget child;
 
@@ -19,9 +17,9 @@ class AppLifecycleObserver extends StatefulWidget {
   State<AppLifecycleObserver> createState() => _AppLifecycleObserverState();
 }
 
-class _AppLifecycleObserverState extends State<AppLifecycleObserver>
-    with WidgetsBindingObserver {
+class _AppLifecycleObserverState extends State<AppLifecycleObserver> {
   static final _log = Logger('AppLifecycleObserver');
+  late final AppLifecycleListener _appLifecycleListener;
 
   final ValueNotifier<AppLifecycleState> lifecycleListenable =
       ValueNotifier(AppLifecycleState.inactive);
@@ -46,22 +44,18 @@ class _AppLifecycleObserverState extends State<AppLifecycleObserver>
     );
   }
 
-  @override
-  void didChangeAppLifecycleState(AppLifecycleState state) {
-    _log.info(() => 'didChangeAppLifecycleState: $state');
-    lifecycleListenable.value = state;
-  }
-
   @override
   void dispose() {
-    WidgetsBinding.instance.removeObserver(this);
+    _appLifecycleListener.dispose();
     super.dispose();
   }
 
   @override
   void initState() {
     super.initState();
-    WidgetsBinding.instance.addObserver(this);
+    _appLifecycleListener = AppLifecycleListener(
+      onStateChange: (s) => lifecycleListenable.value = s,
+    );
     _log.info('Subscribed to app lifecycle updates');
   }
 }
diff --git a/templates/card/lib/app_lifecycle/app_lifecycle.dart b/templates/card/lib/app_lifecycle/app_lifecycle.dart
@@ -8,8 +8,6 @@ import 'package:provider/provider.dart';
 
 typedef AppLifecycleStateNotifier = ValueNotifier<AppLifecycleState>;
 
-// TODO(filiph): use the new AppLifecycleListener class, e.g.
-//               https://kazlauskas.dev/flutter-app-lifecycle-listener-overview/
 class AppLifecycleObserver extends StatefulWidget {
   final Widget child;
 
@@ -19,9 +17,9 @@ class AppLifecycleObserver extends StatefulWidget {
   State<AppLifecycleObserver> createState() => _AppLifecycleObserverState();
 }
 
-class _AppLifecycleObserverState extends State<AppLifecycleObserver>
-    with WidgetsBindingObserver {
+class _AppLifecycleObserverState extends State<AppLifecycleObserver> {
   static final _log = Logger('AppLifecycleObserver');
+  late final AppLifecycleListener _appLifecycleListener;
 
   final ValueNotifier<AppLifecycleState> lifecycleListenable =
       ValueNotifier(AppLifecycleState.inactive);
@@ -46,22 +44,18 @@ class _AppLifecycleObserverState extends State<AppLifecycleObserver>
     );
   }
 
-  @override
-  void didChangeAppLifecycleState(AppLifecycleState state) {
-    _log.info(() => 'didChangeAppLifecycleState: $state');
-    lifecycleListenable.value = state;
-  }
-
   @override
   void dispose() {
-    WidgetsBinding.instance.removeObserver(this);
+    _appLifecycleListener.dispose();
     super.dispose();
   }
 
   @override
   void initState() {
     super.initState();
-    WidgetsBinding.instance.addObserver(this);
+    _appLifecycleListener = AppLifecycleListener(
+      onStateChange: (s) => lifecycleListenable.value = s,
+    );
     _log.info('Subscribed to app lifecycle updates');
   }
 }
diff --git a/templates/endless_runner/lib/app_lifecycle/app_lifecycle.dart b/templates/endless_runner/lib/app_lifecycle/app_lifecycle.dart
@@ -3,8 +3,6 @@ import 'package:provider/provider.dart';
 
 typedef AppLifecycleStateNotifier = ValueNotifier<AppLifecycleState>;
 
-// TODO(filiph): use the new AppLifecycleListener class, e.g.
-//               https://kazlauskas.dev/flutter-app-lifecycle-listener-overview/
 class AppLifecycleObserver extends StatefulWidget {
   final Widget child;
 
@@ -14,8 +12,9 @@ class AppLifecycleObserver extends StatefulWidget {
   State<AppLifecycleObserver> createState() => _AppLifecycleObserverState();
 }
 
-class _AppLifecycleObserverState extends State<AppLifecycleObserver>
-    with WidgetsBindingObserver {
+class _AppLifecycleObserverState extends State<AppLifecycleObserver> {
+  late final AppLifecycleListener _appLifecycleListener;
+
   final ValueNotifier<AppLifecycleState> lifecycleListenable =
       ValueNotifier(AppLifecycleState.inactive);
 
@@ -39,20 +38,17 @@ class _AppLifecycleObserverState extends State<AppLifecycleObserver>
     );
   }
 
-  @override
-  void didChangeAppLifecycleState(AppLifecycleState state) {
-    lifecycleListenable.value = state;
-  }
-
   @override
   void dispose() {
-    WidgetsBinding.instance.removeObserver(this);
+    _appLifecycleListener.dispose();
     super.dispose();
   }
 
   @override
   void initState() {
     super.initState();
-    WidgetsBinding.instance.addObserver(this);
+    _appLifecycleListener = AppLifecycleListener(
+      onStateChange: (s) => lifecycleListenable.value = s,
+    );
   }
 }