Flutter go_router路由配置：是否需声明所有页面及深层路由？

你完全不需要在GoRouter初始化时就声明所有关联的URL视图，包括那些深度层级的路由及其全部父路由——这既不是强制要求，也不是标准实践。针对你觉得根目录声明繁琐的问题，有几种更优的处理方式：

• 使用嵌套路由分层定义
  GoRouter支持路由嵌套，可以把深层路由挂载到对应父路由的routes字段下，不用在根节点一次性堆砌所有层级。这种方式能让路由结构和页面层级对应，代码更清晰。示例代码：

  final GoRouter router = GoRouter(
    routes: <RouteBase>[
      GoRoute(
        path: '/home',
        builder: (BuildContext context, GoRouterState state) {
          return const HomePage();
        },
        routes: <RouteBase>[
          // 第一层子路由
          GoRoute(
            path: 'level1',
            builder: (BuildContext context, GoRouterState state) {
              return const Level1Page();
            },
            routes: <RouteBase>[
              // 继续嵌套直至深层页面
              GoRoute(
                path: 'level2/level3/deep-page',
                builder: (BuildContext context, GoRouterState state) {
                  return const DeepPage();
                },
              ),
            ],
          ),
        ],
      ),
    ],
  );
  

• 利用动态参数与通配符简化声明
  如果路由包含动态路径段或者结构灵活，可以用:param定义动态参数，或者用*通配符匹配剩余路径，无需逐层级声明。示例：

  final GoRouter router = GoRouter(
    routes: <RouteBase>[
      GoRoute(
        path: '/home/:level1/:level2/deep-page',
        builder: (BuildContext context, GoRouterState state) {
          // 获取动态参数
          final level1 = state.pathParameters['level1'];
          final level2 = state.pathParameters['level2'];
          return DeepPage(level1: level1, level2: level2);
        },
      ),
      // 或者用通配符匹配任意深层路径
      GoRoute(
        path: '/home/*',
        builder: (BuildContext context, GoRouterState state) {
          final remainingPath = state.fullPath?.replaceFirst('/home/', '') ?? '';
          // 根据剩余路径判断要跳转的页面
          if (remainingPath == 'level1/level2/deep-page') {
            return const DeepPage();
          }
          return const NotFoundPage();
        },
      ),
    ],
  );
  

• 模块化拆分路由
  把不同模块的路由抽成单独的文件或函数，再在根路由中组合导入，避免根目录代码臃肿。示例：

  // home_routes.dart
  List<RouteBase> getHomeRoutes() => [
    GoRoute(
      path: '/home',
      builder: (context, state) => const HomePage(),
      routes: [getLevel1Routes()],
    ),
  ];
  
  // level1_routes.dart
  GoRoute getLevel1Routes() => GoRoute(
    path: 'level1',
    builder: (context, state) => const Level1Page(),
    routes: [getDeepPageRoute()],
  );
  
  // deep_page_route.dart
  GoRoute getDeepPageRoute() => GoRoute(
    path: 'level2/deep-page',
    builder: (context, state) => const DeepPage(),
  );
  
  // 根路由初始化
  final GoRouter router = GoRouter(
    routes: [
      ...getHomeRoutes(),
      // 其他模块路由
    ],
  );
  

总结来说，GoRouter的设计初衷就是支持灵活的路由管理，完全不用在根节点一次性声明所有路由。通过嵌套路由、动态参数、模块化拆分这些方式，既能满足业务的路由需求，又能保持代码的整洁和可维护性。

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