Flutter中如何实现安全的Navigator.popUntil函数以避免回退黑屏？

问题根因 #

调用popUntil时如果传入不存在的路由名称，对应的RoutePredicate会一直返回false，Navigator会持续执行pop直到把根路由也弹出，最终出现黑屏。

最简实现方案 #

我们可以在原有popUntil的判断逻辑上增加根路由兜底判断，就算目标路由不存在，也不会把根路由弹出：

import 'package:flutter/material.dart';

static void safePopUntil(BuildContext context, RoutePredicate predicate) {
  Navigator.of(context).popUntil((route) {
    // 已到根路由直接停止pop，兜底避免黑屏
    if (route.isFirst) {
      return true;
    }
    // 执行原有判断逻辑
    return predicate(route);
  });
}

调用方式和原生popUntil完全兼容，无需修改原有业务代码：

// 原有写法，有黑屏风险
// Navigator.popUntil(context, ModalRoute.withName('/targetPage'));

// 替换为安全写法，即使路由不存在也不会黑屏
safePopUntil(context, ModalRoute.withName('/targetPage'));

可选增强：路由存在性校验 #

如果需要提前判断目标路由是否存在，可新增如下工具方法：

static bool isRouteExists(BuildContext context, String routeName) {
  bool exists = false;
  Navigator.of(context).popUntil((route) {
    if (route.settings.name == routeName) {
      exists = true;
    }
    // 始终返回true，仅遍历路由栈不执行pop操作
    return true;
  });
  return exists;
}

可以基于这个方法做自定义异常处理，比如路由不存在时直接回退到首页，或者上报错误日志。

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