Flutter中MaterialApp下如何获取有效Context初始化全局监听器

注意：不要直接使用MaterialApp父级的context，此时MaterialApp的InheritedWidget（包含Navigator、Theme、Localizations等全局资源）还未挂载到组件树中，会触发资源找不到的运行时异常。

通用全局上下文获取方案 #

优先使用MaterialApp自带的builder参数，该回调返回的上下文是MaterialApp子树的根上下文，已经可以正常访问所有顶层全局资源，且不会随路由跳转销毁，全应用生命周期内有效。

MaterialApp(
  // 其他配置项：theme、localizationsDelegates等
  builder: (context, child) {
    // 在此处执行所有需要全局上下文的初始化逻辑
    SessionCheck.instance.run(context); // 会话检查
    StoreHydration.instance.init(context); // 状态持久化恢复
    UserSessionListener.instance.bind(context); // 用户会话监听
    return child ?? const SizedBox.shrink();
  },
  home: const HomePage(),
)

路由持续监听场景的专属实现 #

路由变更监听不需要手动绑定上下文，直接使用Flutter原生提供的NavigatorObserver即可：

1. 自定义NavigatorObserver子类，重写路由变更回调

class AppRouteObserver extends NavigatorObserver {
  @override
  void didPush(Route route, Route? previousRoute) {
    super.didPush(route, previousRoute);
    // 可通过navigator?.context获取全局导航上下文
    debugPrint('路由入栈：${previousRoute?.settings.name} -> ${route.settings.name}');
    // 示例：埋点上报页面浏览事件
    Analytics.instance.logPageView(
      pageName: route.settings.name,
      context: navigator!.context,
    );
  }

  @override
  void didPop(Route route, Route? previousRoute) {
    super.didPop(route, previousRoute);
    // 处理路由出栈逻辑
  }

  @override
  void didReplace({Route? newRoute, Route? oldRoute}) {
    super.didReplace(newRoute: newRoute, oldRoute: oldRoute);
    // 处理路由替换逻辑
  }
}

2. 将自定义实例传入MaterialApp的navigatorObservers配置项

MaterialApp(
  navigatorObservers: [AppRouteObserver()],
  // 其他配置项
)

额外注意事项 #

• 不要在单个页面的initState等生命周期中注册全局监听器，页面销毁后会导致监听器失效或触发内存泄漏
• 若使用GoRouter、GetX等第三方路由框架，框架本身会提供全局路由监听回调和全局上下文获取入口，原理和上述原生方案一致，直接使用框架提供的接口即可

内容的提问来源于stack exchange，提问作者Romeo Mihalcea