TanStackStart v0
自动
框架
版本
菜单
入门
示例
教程

学习基础知识

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

依赖项

TanStack Start 由 Vite 和 TanStack Router 提供支持。

  • TanStack Router：用于构建 Web 应用程序的路由器。
  • Vite：用于打包应用程序的构建工具。

一切都从路由器"开始"

这是决定 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）时生成。此文件包含生成的路由树和一些使 TanStack Start 完全类型安全的 TS 实用程序。

服务器入口点（可选）

Note

服务器入口点在开箱即用时是可选的。如果未提供，TanStack Start 将使用以下默认设置自动为您处理服务器入口点。

这通过 src/server.ts 文件完成：

tsx
// src/server.ts
import {
  createStartHandler,
  defaultStreamHandler,
} from '@tanstack/react-start/server'
import { createRouter } from './router'

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

// src/server.ts
import {
  createStartHandler,
  defaultStreamHandler,
} from '@tanstack/react-start/server'
import { createRouter } from './router'

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

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

  • 重要的是为每个请求创建一个新的路由器。这确保路由器处理的任何数据对请求都是唯一的。
  • defaultStreamHandler 函数用于将我们的应用程序渲染为流，允许我们利用向客户端流式传输 HTML 的优势。（这是默认处理程序，但您也可以使用其他处理程序，如 defaultRenderHandler，甚至构建自己的处理程序）

客户端入口点（可选）

Note

客户端入口点在开箱即用时是可选的。如果未提供，TanStack Start 将使用以下默认设置自动为您处理客户端入口点。

将 HTML 传递给客户端只是成功的一半。一旦到达那里，我们需要在路由解析到客户端后水合我们的客户端 JavaScript。我们通过使用 StartClient 组件水合应用程序的根来实现这一点：

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

const router = createRouter()

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

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

const router = createRouter()

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

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

应用程序的根

除了客户端入口点（默认情况下是可选的）之外，应用程序的 __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 钩子进行命令式导航。
  • 在应用程序的任何地方使用 useRouter 钩子来访问路由器实例并执行失效操作。
  • 每个返回状态的路由器钩子都是响应式的，这意味着当适当的状态发生变化时它会自动重新运行。

以下是如何使用 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'
import { z } from 'zod'
import { dbUpdateUser } from '...'

const UserSchema = z.object({
  id: z.string(),
  name: z.string(),
})
export type User = z.infer<typeof UserSchema>

export const updateUser = createServerFn({ method: 'POST' })
  .validator(UserSchema)
  .handler(({ data }) => dbUpdateUser(data))

// Somewhere else in your application
import { useQueryClient } from '@tanstack/react-query'
import { useRouter } from '@tanstack/react-router'
import { useServerFn } from '@tanstack/react-start'
import { updateUser, type User } from '...'

export function useUpdateUser() {
  const router = useRouter()
  const queryClient = useQueryClient()
  const _updateUser = useServerFn(updateUser)

  return useCallback(
    async (user: User) => {
      const result = await _updateUser({ data: user })

      router.invalidate()
      queryClient.invalidateQueries({
        queryKey: ['users', 'updateUser', user.id],
      })

      return result
    },
    [router, queryClient, _updateUser],
  )
}

// Somewhere else in your application
import { useUpdateUser } from '...'

function MyComponent() {
  const updateUser = useUpdateUser()
  const onClick = useCallback(async () => {
    await updateUser({ id: '1', name: 'John' })
    console.log('Updated user')
  }, [updateUser])

  return <button onClick={onClick}>Click Me</button>
}

import { createServerFn } from '@tanstack/react-start'
import { z } from 'zod'
import { dbUpdateUser } from '...'

const UserSchema = z.object({
  id: z.string(),
  name: z.string(),
})
export type User = z.infer<typeof UserSchema>

export const updateUser = createServerFn({ method: 'POST' })
  .validator(UserSchema)
  .handler(({ data }) => dbUpdateUser(data))

// Somewhere else in your application
import { useQueryClient } from '@tanstack/react-query'
import { useRouter } from '@tanstack/react-router'
import { useServerFn } from '@tanstack/react-start'
import { updateUser, type User } from '...'

export function useUpdateUser() {
  const router = useRouter()
  const queryClient = useQueryClient()
  const _updateUser = useServerFn(updateUser)

  return useCallback(
    async (user: User) => {
      const result = await _updateUser({ data: user })

      router.invalidate()
      queryClient.invalidateQueries({
        queryKey: ['users', 'updateUser', user.id],
      })

      return result
    },
    [router, queryClient, _updateUser],
  )
}

// Somewhere else in your application
import { useUpdateUser } from '...'

function MyComponent() {
  const updateUser = useUpdateUser()
  const onClick = useCallback(async () => {
    await updateUser({ id: '1', name: 'John' })
    console.log('Updated user')
  }, [updateUser])

  return <button onClick={onClick}>Click Me</button>
}

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

数据加载

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

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

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

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

在 GitHub 上编辑
从头开始构建
服务器函数