TanStack Router 文件式路由嵌套匹配问题解析

文件式路由的嵌套匹配机制

在使用 TanStack Router 的文件式路由功能时，开发者可能会遇到一个常见问题：嵌套路由的匹配层级不符合预期，Outlet 组件无法正常工作。这种现象通常表现为所有路由都被直接挂载到根路由(rootRoute)下，而失去了应有的层级关系。

问题现象分析

当开发者按照文件系统结构创建嵌套路由时，比如以下目录结构：

routes/
├── __root.tsx
├── about.tsx
├── index.tsx
└── lines/
    ├── index.tsx
    └── $lineId/
        ├── index.tsx
        └── spans/
            └── $spanId/
                └── index.tsx

期望的匹配路径如 /lines/30/spans/979 应该包含多个层级的匹配，但实际上可能只匹配到最终的路由组件，中间层级的匹配丢失了。

问题根源

这个问题的根本原因在于文件式路由的配置方式。仅仅创建文件夹和 index 路由文件是不够的，TanStack Router 需要明确的 route 定义文件来建立路由层级关系。

正确配置方法

要实现正确的嵌套路由匹配，需要在每个中间层级目录中创建 route.tsx 文件，而不仅仅是 index.tsx。这些 route 文件将作为中间路由节点，建立完整的路由层级树。

例如，正确的文件结构应该是：

routes/
├── __root.tsx
├── about.tsx
├── index.tsx
└── lines/
    ├── route.tsx      // 新增
    ├── index.tsx
    └── $lineId/
        ├── route.tsx  // 新增
        ├── index.tsx
        └── spans/
            ├── route.tsx  // 新增
            └── $spanId/
                ├── route.tsx  // 新增
                └── index.tsx

路由匹配机制解析

当配置了正确的 route 文件后，TanStack Router 会：

1. 识别每个目录中的 route 文件作为中间路由节点
2. 建立完整的父子路由关系链
3. 在匹配深层路由时保留所有中间层级的匹配信息
4. 确保 Outlet 组件能够正确渲染子路由内容

最佳实践建议

1. 对于每个需要作为路由节点的目录，都应该包含一个 route.tsx 文件
2. 使用 index.tsx 作为该路由路径的默认渲染组件
3. 在 route.tsx 中可以使用 Outlet 来渲染子路由内容
4. 参数化路由(如 $lineId)同样需要遵循这一规则

总结

理解 TanStack Router 文件式路由的匹配机制对于构建复杂的嵌套路由至关重要。通过正确配置 route 文件，开发者可以确保路由层级关系清晰，匹配信息完整，Outlet 组件正常工作。这种显式的路由节点定义方式虽然增加了少量配置工作，但带来了更清晰的路由结构和更可靠的渲染行为。