Flutter RouteObserver 监听

关于Flutter Widget 生命周期之前写过一篇文章:Flutter关于StatefulWidget生命周期的理解。今天说说页面变化的另一个知识点RouteObserver监听,算是对StatefulWidget生命周期的补充。

RouteObserver 是一个专门用来观察导航栈中路由变化的对象。通过 RouteObserver 可以监听页面(或更确切地说,路由)的生命周期变化。具体来说,RouteObserver 可以监听页面的推入、弹出、替换等导航行为,并触发相应的回调函数,开发者可以利用它来做一些页面切换时的处理工作,比如统计页面访问时长、暂停和恢复动画、管理资源等。

使用场景

  1. 页面状态监控:监控页面切换、显示与隐藏,执行对应的逻辑操作。

  2. 导航栈管理:监控当前路由堆栈的状态变化,比如页面的入栈、出栈等操作。

  3. 统计和分析:在应用中记录用户页面停留时长,监控页面流转顺序。

  4. 动画暂停与恢复:当页面离开时暂停动画,返回时恢复动画。

基本结构

RouteObserverNavigatorObserver 的子类,Flutter 中的 NavigatorObserver 用于监听 Navigator 的路由事件。通过 RouteObserver,你可以监控路由(页面)进栈、出栈等变化事件。

RouteObserver 的主要方法

  • didPush:当新的路由被推入到导航堆栈时触发,类似于页面的“打开”事件。

  • didPop:当路由从导航堆栈中弹出时触发,类似于页面的“关闭”事件。

  • didRemove:当某个路由被从导航堆栈中移除时触发。

  • didReplace:当某个路由被替换时触发。

RouteAware 接口

RouteAware 是一个接口,页面的 State 类可以实现这个接口,以便与 RouteObserver 进行交互。具体实现时,你可以在页面的 State 类中实现 didPush, didPop, didPushNext 等回调方法。

RouteAware 接口提供的主要回调方法:

  • didPopNext:当前页面是目标页面,当另一个页面弹出时,触发这个回调。

  • didPushNext:当前页面被新页面覆盖时,触发这个回调。

  • didPop:当前页面被弹出时,触发这个回调。

  • didPush:当前页面被推入导航栈时,触发这个回调。

使用步骤

第一步:创建一个 RouteObserver

首先,你需要在应用中创建一个 RouteObserver 实例。通常会在 MaterialAppCupertinoAppnavigatorObservers 参数中进行配置。

import 'package:flutter/material.dart';
// 创建 RouteObserver 实例
final RouteObserver<PageRoute> routeObserver = RouteObserver<PageRoute>();

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

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      navigatorObservers: [routeObserver], // 配置 RouteObserver
      home: VmTestPage1(),
    );
  }
}

第二步:创建一个 RouteAware 的 StatefulWidget

接下来,你需要在希望监听的页面(或 Widget)中实现 RouteAwareRouteAware 是一个接口,允许对象感知其路由的变化。然后,将这个对象注册到 RouteObserver 中。

import 'package:flutter/material.dart';
import 'package:your_app_name/route_observer.dart';

class VmTestPage2 extends StatefulWidget {
  @override
  _VmTestPage2State createState() => _VmTestPage2State();
}

class _VmTestPage2State extends State<VmTestPage2> with RouteAware {
  @override
  void initState() {
    super.initState();
  }

  @override
  void didChangeDependencies() {
    super.didChangeDependencies();
    // 注册到 RouteObserver 中
    routeObserver.subscribe(this, ModalRoute.of(context)!);
  }

  @override
  void dispose() {
    // 注销 RouteObserver
    routeObserver.unsubscribe(this);
    super.dispose();
  }

  // 页面可见时调用
  @override
  void didPush() {
    super.didPush();
    print('VmTestPage2 is visible');
  }

  // 页面从别的页面返回时调用
  @override
  void didPopNext() {
    super.didPopNext();
    print('VmTestPage2 has returned from another page');
  }

  // 页面被覆盖时调用
  @override
  void didPop() {
    super.didPop();
    print('VmTestPage2 is being popped');
  }

  // 页面被重新显示时调用
  @override
  void didPushNext() {
    super.didPushNext();
    print('Another page was pushed on top of VmTestPage2');
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('VmTestPage2'),
      ),
      body: Center(
        child: Text('This is VmTestPage2'),
      ),
    );
  }
}
关键方法解释:
  • didPush():当页面被推到导航栈时(即页面可见时)调用。

  • didPopNext():当页面从下一个页面返回时调用(即该页面重新可见时)。

  • didPop():当页面从导航栈中弹出时调用。

  • didPushNext():当下一个页面推到该页面之上时调用(即该页面被覆盖时)。

第三步:在需要监听的地方使用 RouteObserver

通过以上步骤,你已经实现了对 VmTestPage2 的路由事件监听。这种方式在需要了解页面的进入、离开、重新进入等生命周期时非常有用。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 211,743评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,296评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,285评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,485评论 1 283
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,581评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,821评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,960评论 3 408
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,719评论 0 266
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,186评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,516评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,650评论 1 340
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,329评论 4 330
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,936评论 3 313
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,757评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,991评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,370评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,527评论 2 349

推荐阅读更多精彩内容