自定义路由监听Widget,实现类似iOS中的willAppear和disAppear

我们知道flutter框架中有StatefulWidget的存在,而它对应的State有自己的一套生命周期。具体可查阅State生命周期。它并不能完全满足类似iOS中UIViewController生命周期的需求。庆幸的是RouteObserver这个类可以帮我们实现。

RouteObserver详解本篇文章就不说了,网上资料一大把。但是RouteObserver使用起来比较繁琐,每一个需要监听路由变化的Widget都需要去实现接口RouteAware。并重写didChangeDependencies方法(在其中添加订阅消息的代码)和dispose方法(在其中取消订阅)。

所以我将这个功能封装成了一个WidgetCWRouteListenWidget,使用起来非常方便,只需在build方法中,将你需要监听的Widget作为CWRouteListenWidget的子Widget即可。

示例代码如下:

  • 首先在创建MaterialApp的地方注册navigatorObservers

  • 在需要监听的widget中使用:

class TempPage extends StatelessWidget {

  const TempPage({Key? key}) : super(key: key);

  void _appear(CWRouteChangeType type) {
    switch (type) {
      case CWRouteChangeType.push:
        debugPrint("从其他页面push到当前页面");
        break;
      case CWRouteChangeType.pop:
        debugPrint("从其他页面返回到当前页面");
        break;
    }
  }

  void _disappear(CWRouteChangeType type) {
    switch (type) {
      case CWRouteChangeType.push:
        debugPrint("从当前页面push到其他页面");
        break;
      case CWRouteChangeType.pop:
        debugPrint("从当前页面返回到其他页面");
        break;
    }
  }

  @override
  Widget build(BuildContext context) {
    return CWRouteListenWidget(
      appearHandler: _appear,
      disappearHandler: _disappear,
      child: Scaffold(
        appBar: AppBar(
          title: const Text("test"),
        ),
        body: const Center(
          child: Text("content"),
        ),
      ),
    );
  }
}
  • 其中appearHandler类似iOS中的viewWillAppear||viewDidAppear
  • 其中disappearHandler类似iOS中的viewWillDisappear||viewDidDisappear

CWRouteListenWidget源码如下:

import 'package:flutter/material.dart';

// 路由操作枚举
enum CWRouteChangeType {
  push,
  pop
}

// 路由监听widget
class CWRouteListenWidget extends StatefulWidget {

  static RouteObserver<PageRoute> routeObserver = RouteObserver<PageRoute>();

  final Widget child;

  // 当前页面展示时的回调
  final Function(CWRouteChangeType)? appearHandler;

  // 当前页面消失时的回调
  final Function(CWRouteChangeType)? disappearHandler;

  // 构造方法
  const CWRouteListenWidget({Key? key, required this.child, this.appearHandler, this.disappearHandler}) : super(key: key);

  @override
  _CWRouteListenWidgetState createState() => _CWRouteListenWidgetState();
}

class _CWRouteListenWidgetState extends State<CWRouteListenWidget> with RouteAware {

  @override
  void didChangeDependencies() {
    ModalRoute? route = ModalRoute.of(context);
    if (route != null) {
      CWRouteListenWidget.routeObserver.unsubscribe(this);
      // 注册监听
      CWRouteListenWidget.routeObserver.subscribe(this, route as PageRoute);
    }
    super.didChangeDependencies();
  }

  @override
  void dispose() {
    // 移除监听
    CWRouteListenWidget.routeObserver.unsubscribe(this);
    super.dispose();
  }

  @override
  void didPush() {
    if (widget.appearHandler != null) {
      widget.appearHandler!(CWRouteChangeType.push);
    }
    super.didPush();
  }

  @override
  void didPop() {
    if (widget.disappearHandler != null) {
      widget.disappearHandler!(CWRouteChangeType.pop);
    }
    super.didPop();
  }

  @override
  void didPushNext() {
    if (widget.disappearHandler != null) {
      widget.disappearHandler!(CWRouteChangeType.push);
    }
    super.didPushNext();
  }

  @override
  void didPopNext() {
    if (widget.appearHandler != null) {
      widget.appearHandler!(CWRouteChangeType.pop);
    }
    super.didPopNext();
  }

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

推荐阅读更多精彩内容