学习基础知识

本指南将帮助您了解 TanStack Start 工作原理的基础知识，无论您如何设置项目。

依赖

TanStack Start 目前 (*) 由 Vinxi、Nitro 和 TanStack Router 驱动。

TanStack Router：用于构建 Web 应用程序的路由器。
Nitro：用于构建服务器应用程序的框架。
Vinxi：用于构建 Web 应用程序的服务器框架。

注意

Vinxi 将在 1.0.0 版本发布之前移除，TanStack 将仅依赖 Vite 和 Nitro。使用 Vinxi 的命令和 API 可能会被 Vite 插件取代。

一切始于“Router”（路由器）

此文件将决定 Start 中使用的 TanStack Router 的行为。在这里，您可以配置从默认预加载功能到缓存过期时间的一切。

tsx

// app/router.tsx
import { createRouter as createTanStackRouter } from '@tanstack/react-router'
import { routeTree } from './routeTree.gen'

export function createRouter() {
  const router = createTanStackRouter({
    routeTree,
    scrollRestoration: true,
  })

  return router
}

declare module '@tanstack/react-router' {
  interface Register {
    router: ReturnType<typeof createRouter>
  }
}

// app/router.tsx
import { createRouter as createTanStackRouter } from '@tanstack/react-router'
import { routeTree } from './routeTree.gen'

export function createRouter() {
  const router = createTanStackRouter({
    routeTree,
    scrollRestoration: true,
  })

  return router
}

declare module '@tanstack/react-router' {
  interface Register {
    router: ReturnType<typeof createRouter>
  }
}

请注意 scrollRestoration 属性。它用于在路由之间导航时恢复页面的滚动位置。

路由生成

routeTree.gen.ts 文件在您首次运行 TanStack Start（通过 npm run dev 或 npm run start）时生成。此文件包含生成的路由树和一些 TS 实用程序，使 TanStack Start 完全类型安全。

服务器入口点

尽管 TanStack Start 在设计上采用了客户端优先的 API，但从本质上讲，它是一个全栈框架。这意味着所有用例，包括动态和静态，都依赖于服务器或构建时入口来渲染应用程序的初始 HTML 有效负载。

这通过 app/ssr.tsx 文件完成

tsx

// app/ssr.tsx
import {
  createStartHandler,
  defaultStreamHandler,
} from '@tanstack/react-start/server'
import { getRouterManifest } from '@tanstack/react-start/router-manifest'

import { createRouter } from './router'

export default createStartHandler({
  createRouter,
  getRouterManifest,
})(defaultStreamHandler)

// app/ssr.tsx
import {
  createStartHandler,
  defaultStreamHandler,
} from '@tanstack/react-start/server'
import { getRouterManifest } from '@tanstack/react-start/router-manifest'

import { createRouter } from './router'

export default createStartHandler({
  createRouter,
  getRouterManifest,
})(defaultStreamHandler)

无论我们是静态生成应用程序还是动态提供服务，ssr.tsx 文件都是执行所有 SSR 相关工作的入口点。

重要的是，每个请求都应创建一个新的路由器。这确保了路由器处理的任何数据对于该请求都是唯一的。
getRouterManifest 函数用于生成路由器清单，该清单用于确定应用程序的资源管理和预加载的许多方面。
defaultStreamHandler 函数用于将应用程序渲染到流，从而使我们能够利用流式 HTML 到客户端。（这是默认处理程序，但您也可以使用其他处理程序，例如 defaultRenderHandler，甚至构建自己的处理程序）

客户端入口点

将 HTML 发送到客户端只是成功了一半。到达客户端后，我们需要在路由解析到客户端后，激活客户端 JavaScript。我们通过使用 StartClient 组件激活应用程序的根目录来完成此操作

tsx

// app/client.tsx
import { hydrateRoot } from 'react-dom/client'
import { StartClient } from '@tanstack/react-start'
import { createRouter } from './router'

const router = createRouter()

hydrateRoot(document, <StartClient router={router} />)

// app/client.tsx
import { hydrateRoot } from 'react-dom/client'
import { StartClient } from '@tanstack/react-start'
import { createRouter } from './router'

const router = createRouter()

hydrateRoot(document, <StartClient router={router} />)

这使我们能够在用户的初始服务器请求完成后启动客户端路由。

应用的根目录

除了客户端入口点之外，应用程序的 __root 路由也是应用程序的入口点。此文件中的代码将包装应用程序中的所有其他路由，包括您的主页。它的行为类似于整个应用程序的无路径布局路由。

因为它始终会被渲染，所以它是构建应用程序外壳和处理任何全局逻辑的理想场所。

tsx

// app/routes/__root.tsx
import {
  Outlet,
  createRootRoute,
  HeadContent,
  Scripts,
} from '@tanstack/react-router'
import type { ReactNode } from 'react'

export const Route = createRootRoute({
  head: () => ({
    meta: [
      {
        charSet: 'utf-8',
      },
      {
        name: 'viewport',
        content: 'width=device-width, initial-scale=1',
      },
      {
        title: 'TanStack Start Starter',
      },
    ],
  }),
  component: RootComponent,
})

function RootComponent() {
  return (
    <RootDocument>
      <Outlet />
    </RootDocument>
  )
}

function RootDocument({ children }: Readonly<{ children: ReactNode }>) {
  return (
    <html>
      <head>
        <HeadContent />
      </head>
      <body>
        {children}
        <Scripts />
      </body>
    </html>
  )
}

// app/routes/__root.tsx
import {
  Outlet,
  createRootRoute,
  HeadContent,
  Scripts,
} from '@tanstack/react-router'
import type { ReactNode } from 'react'

export const Route = createRootRoute({
  head: () => ({
    meta: [
      {
        charSet: 'utf-8',
      },
      {
        name: 'viewport',
        content: 'width=device-width, initial-scale=1',
      },
      {
        title: 'TanStack Start Starter',
      },
    ],
  }),
  component: RootComponent,
})

function RootComponent() {
  return (
    <RootDocument>
      <Outlet />
    </RootDocument>
  )
}

function RootDocument({ children }: Readonly<{ children: ReactNode }>) {
  return (
    <html>
      <head>
        <HeadContent />
      </head>
      <body>
        {children}
        <Scripts />
      </body>
    </html>
  )
}

随着我们推出 SPA 模式，此布局将来可能会发生变化，SPA 模式允许根路由渲染 SPA 外壳，而无需任何特定于页面的内容。
请注意 Scripts 组件。它用于加载应用程序的所有客户端 JavaScript。

路由

路由是 TanStack Router 的一项广泛功能，在路由指南中进行了详尽的介绍。作为总结

路由使用 createFileRoute 函数定义。
路由自动进行代码拆分和延迟加载。
关键数据获取从路由的加载器协调
还有更多！

tsx

// app/routes/index.tsx
import * as fs from 'node:fs'
import { createFileRoute, useRouter } from '@tanstack/react-router'
import { createServerFn } from '@tanstack/react-start'

const filePath = 'count.txt'

async function readCount() {
  return parseInt(
    await fs.promises.readFile(filePath, 'utf-8').catch(() => '0'),
  )
}

const getCount = createServerFn({
  method: 'GET',
}).handler(() => {
  return readCount()
})

const updateCount = createServerFn({ method: 'POST' })
  .validator((d: number) => d)
  .handler(async ({ data }) => {
    const count = await readCount()
    await fs.promises.writeFile(filePath, `${count + data}`)
  })

export const Route = createFileRoute('/')({
  component: Home,
  loader: async () => await getCount(),
})

function Home() {
  const router = useRouter()
  const state = Route.useLoaderData()

  return (
    <button
      type="button"
      onClick={() => {
        updateCount({ data: 1 }).then(() => {
          router.invalidate()
        })
      }}
    >
      Add 1 to {state}?
    </button>
  )
}

// app/routes/index.tsx
import * as fs from 'node:fs'
import { createFileRoute, useRouter } from '@tanstack/react-router'
import { createServerFn } from '@tanstack/react-start'

const filePath = 'count.txt'

async function readCount() {
  return parseInt(
    await fs.promises.readFile(filePath, 'utf-8').catch(() => '0'),
  )
}

const getCount = createServerFn({
  method: 'GET',
}).handler(() => {
  return readCount()
})

const updateCount = createServerFn({ method: 'POST' })
  .validator((d: number) => d)
  .handler(async ({ data }) => {
    const count = await readCount()
    await fs.promises.writeFile(filePath, `${count + data}`)
  })

export const Route = createFileRoute('/')({
  component: Home,
  loader: async () => await getCount(),
})

function Home() {
  const router = useRouter()
  const state = Route.useLoaderData()

  return (
    <button
      type="button"
      onClick={() => {
        updateCount({ data: 1 }).then(() => {
          router.invalidate()
        })
      }}
    >
      Add 1 to {state}?
    </button>
  )
}

TanStack Start 100% 构建在 TanStack Router 之上，因此 TanStack Router 的所有导航功能都可供您使用。总结一下

使用 Link 组件导航到新路由。
使用 useNavigate hook 命令式地导航。
在应用程序中的任何位置使用 useRouter hook 来访问路由器实例并执行失效。
每个返回状态的路由器 hook 都是响应式的，这意味着它会在适当的状态更改时自动重新运行。

这是一个关于如何使用 Link 组件导航到新路由的快速示例

tsx

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

function Home() {
  return <Link to="/about">About</Link>
}

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

function Home() {
  return <Link to="/about">About</Link>
}

有关导航的更多深入信息，请查看导航指南。

服务器函数 (RPC)

您可能已经注意到我们上面使用 createServerFn 创建的服务器函数。这是 TanStack 最强大的功能之一，允许您创建可以从 SSR 期间的服务器和客户端调用的服务器端函数！

以下是服务器函数工作原理的快速概述

服务器函数使用 createServerFn 函数创建。
它们可以从 SSR 期间的服务器和客户端调用。
它们可以用于从服务器获取数据，或执行其他服务器端操作。

这是一个关于如何使用服务器函数从服务器获取和返回数据的快速示例

tsx

import { createServerFn } from '@tanstack/react-start'
import * as fs from 'node:fs'
import { z } from 'zod'

const getUserById = createServerFn({ method: 'GET' })
  // Always validate data sent to the function, here we use Zod
  .validator(z.string())
  // The handler function is where you perform the server-side logic
  .handler(async ({ data }) => {
    return db.query.users.findFirst({ where: eq(users.id, data) })
  })

// Somewhere else in your application
const user = await getUserById({ data: '1' })

import { createServerFn } from '@tanstack/react-start'
import * as fs from 'node:fs'
import { z } from 'zod'

const getUserById = createServerFn({ method: 'GET' })
  // Always validate data sent to the function, here we use Zod
  .validator(z.string())
  // The handler function is where you perform the server-side logic
  .handler(async ({ data }) => {
    return db.query.users.findFirst({ where: eq(users.id, data) })
  })

// Somewhere else in your application
const user = await getUserById({ data: '1' })

要了解有关服务器函数的更多信息，请查看服务器函数指南。

突变

服务器函数也可以用于在服务器上执行突变。这也是使用相同的 createServerFn 函数完成的，但附加要求是您需要使客户端上受突变影响的任何数据失效。

如果您仅使用 TanStack Router，则可以使用 router.invalidate() 方法使所有路由器数据失效并重新获取它。
如果您使用 TanStack Query，则可以使用 queryClient.invalidateQueries() 方法使数据失效，以及其他更具体的方法来定位特定查询。

这是一个关于如何使用服务器函数在服务器上执行突变并使客户端上的数据失效的快速示例

tsx

import { createServerFn } from '@tanstack/react-start'

const UserSchema = z.object({
  id: z.string(),
  name: z.string(),
})

const updateUser = createServerFn({ method: 'POST' })
  .validator(UserSchema)
  .handler(async ({ data }) => {
    return db
      .update(users)
      .set({ name: data.name })
      .where(eq(users.id, data.id))
  })

// Somewhere else in your application
await updateUser({ data: { id: '1', name: 'John' } })

import { createServerFn } from '@tanstack/react-start'

const UserSchema = z.object({
  id: z.string(),
  name: z.string(),
})

const updateUser = createServerFn({ method: 'POST' })
  .validator(UserSchema)
  .handler(async ({ data }) => {
    return db
      .update(users)
      .set({ name: data.name })
      .where(eq(users.id, data.id))
  })

// Somewhere else in your application
await updateUser({ data: { id: '1', name: 'John' } })

要了解有关突变的更多信息，请查看突变指南。

数据加载

TanStack Router 的另一个强大功能是数据加载。这允许您为 SSR 获取数据并在渲染之前预加载路由数据。这是通过使用路由的 loader 函数完成的。

以下是数据加载工作原理的快速概述

数据加载通过使用路由的 loader 函数完成。
数据加载器是同构的，这意味着它们在服务器和客户端上都执行。
对于执行仅限服务器的逻辑，请从加载器中调用服务器函数。
与 TanStack Query 类似，数据加载器缓存在客户端，并在数据过期时重新使用甚至在后台重新获取。

要了解有关数据加载的更多信息，请查看数据加载指南。

依赖