TanStack Router 中嵌套子路由与布局组件的正确使用方式

在基于文件的路由系统中，嵌套路由与布局组件的组合使用是一个常见需求。TanStack Router 作为 React 生态中强大的路由解决方案，提供了灵活的文件路由配置方式，但开发者在使用过程中可能会遇到一些困惑。

典型场景分析

在实际项目中，我们经常需要实现这样的页面结构：

• 一个案例详情页（如 /cases/123）
• 详情页顶部显示案例的通用信息（如案例名称、状态等）
• 下方通过标签页切换显示不同内容（如概览、文档等子页面）

常见误区

许多开发者会尝试通过以下结构实现：

cases/
  _authenticated.tsx (布局组件)
  $caseId/
    index.tsx
    overview.tsx
    documents.tsx

期望_authenticated作为全局布局，$caseId/index作为案例详情页的布局，子页面如overview嵌套在其中。但实际上，这种结构会导致子路由直接继承最外层的_authenticated布局，而跳过中间层的$caseId布局。

正确实现方式

TanStack Router 提供了更合理的解决方案：

1. 文件结构优化：

cases/
  $caseId/
    route.tsx (案例详情布局)
    index.tsx (默认子页面)
    overview.tsx (概览子页面)
    documents.tsx (文档子页面)

2. 布局组件实现： 在route.tsx中定义共享的UI结构和数据加载逻辑：

import { createFileRoute, Outlet } from '@tanstack/react-router'

export const Route = createFileRoute("/cases/$caseId")({
   loader: ({ params: { caseId } }) => fetchCaseData(caseId),
   component: CaseLayout
})

function CaseLayout() {
  const caseData = Route.useLoaderData()
  
  return (
    <div>
      <h1>{caseData.name}</h1>
      <div className="tabs">
        {/* 标签导航 */}
      </div>
      <Outlet />  {/* 子路由内容将在这里渲染 */}
    </div>
  )
}

3. 子页面实现： 子页面如overview.tsx只需关注自身内容，无需重复案例信息部分：

import { createFileRoute } from '@tanstack/react-router'

export const Route = createFileRoute("/cases/$caseId/overview")({
  component: Overview
})

function Overview() {
  return <div>概览内容...</div>
}

关键设计原则

1. 单一职责：每个路由文件只关注自身层级的UI和逻辑
2. 明确嵌套关系：通过Outlet组件显式声明子路由的插入点
3. 数据共享：父路由的loader数据会自动传递给所有子路由
4. 代码复用：公共UI只需在父路由中定义一次

进阶技巧

对于需要多层嵌套的场景，可以继续扩展这种模式：

project/
  $projectId/
    route.tsx (项目布局)
    settings/
      route.tsx (设置布局)
      general.tsx
      members.tsx

这种结构清晰表达了UI的层级关系，同时保持了代码的可维护性。

通过理解TanStack Router的这种设计模式，开发者可以构建出结构清晰、易于维护的复杂路由结构，满足各种业务场景的需求。