预加载

TanStack Router 中的预加载是一种在用户实际导航到某个路由之前就加载该路由的方式。这对于用户可能接下来会访问的路由非常有用。例如，如果您有一个帖子列表，用户很可能会点击其中一个帖子，您可以预加载该帖子的路由，以便在用户点击时立即加载。

支持的预加载策略

意图
- 通过“意图”进行预加载，是通过监听 <Link> 组件上的悬停和触摸开始事件来预加载目标路由的依赖项。
- 此策略对于预加载用户可能接下来会访问的路由很有用。
视口可见性
- 通过“视口”进行预加载，是通过使用 Intersection Observer API 来在 <Link> 组件进入视口时预加载目标路由的依赖项。
- 此策略对于预加载折叠下方或屏幕外的路由很有用。
渲染
- 通过“渲染”进行预加载，是在 <Link> 组件渲染到 DOM 后立即预加载目标路由的依赖项。
- 此策略对于预加载始终需要的路由很有用。

预加载的数据在内存中保留多久？

预加载的路由匹配项会临时缓存在内存中，但有几个重要的注意事项。

默认情况下，未使用的预加载数据将在 30 秒后被移除。可以通过在路由器上设置 defaultPreloadMaxAge 选项来配置此行为。
显然，当一个路由被加载时，它的预加载版本会被提升到路由的正常待定匹配状态。

如果您需要更多地控制预加载、缓存和/或预加载数据的垃圾回收，您应该使用像 TanStack Query 这样的外部缓存库。

为您的应用程序预加载路由的最简单方法是为整个路由器设置 defaultPreload 选项为 intent。

tsx

import { createRouter } from '@tanstack/solid-router'

const router = createRouter({
  // ...
  defaultPreload: 'intent',
})

import { createRouter } from '@tanstack/solid-router'

const router = createRouter({
  // ...
  defaultPreload: 'intent',
})

这将为应用程序中所有 <Link> 组件默认启用 intent 预加载。您也可以在单个 <Link> 组件上设置 preload prop 来覆盖默认行为。

预加载延迟

默认情况下，预加载将在用户悬停或触摸 <Link> 组件后 **50 毫秒** 开始。您可以通过在路由器上设置 defaultPreloadDelay 选项来更改此延迟。

tsx

import { createRouter } from '@tanstack/solid-router'

const router = createRouter({
  // ...
  defaultPreloadDelay: 100,
})

import { createRouter } from '@tanstack/solid-router'

const router = createRouter({
  // ...
  defaultPreloadDelay: 100,
})

您也可以在单个 <Link> 组件上设置 preloadDelay prop，以逐个链接的方式覆盖默认行为。

内置预加载与 preloadStaleTime

如果您使用内置加载器，可以通过将 routerOptions.defaultPreloadStaleTime 或 routeOptions.preloadStaleTime 设置为毫秒数来控制预加载数据在触发下一次预加载之前被视为有效的时间。默认情况下，预加载数据被视为有效 30 秒。。

要更改此设置，您可以在路由器上设置 defaultPreloadStaleTime 选项。

tsx

import { createRouter } from '@tanstack/solid-router'

const router = createRouter({
  // ...
  defaultPreloadStaleTime: 10_000,
})

import { createRouter } from '@tanstack/solid-router'

const router = createRouter({
  // ...
  defaultPreloadStaleTime: 10_000,
})

或者，您可以在单个路由上使用 routeOptions.preloadStaleTime 选项。

tsx

// src/routes/posts.$postId.tsx
export const Route = createFileRoute('/posts/$postId')({
  loader: async ({ params }) => fetchPost(params.postId),
  // Preload the route again if the preload cache is older than 10 seconds
  preloadStaleTime: 10_000,
})

// src/routes/posts.$postId.tsx
export const Route = createFileRoute('/posts/$postId')({
  loader: async ({ params }) => fetchPost(params.postId),
  // Preload the route again if the preload cache is older than 10 seconds
  preloadStaleTime: 10_000,
})

使用外部库进行预加载

当集成 React Query 等外部缓存库时，这些库有自己的判断数据是否过时的方法，您可能希望覆盖 TanStack Router 的默认预加载和 stale-while-revalidate（旧数据校验）逻辑。这些库通常使用 staleTime 等选项来控制数据的有效性。

为了自定义 TanStack Router 中的预加载行为并充分利用外部库的缓存策略，您可以将 routerOptions.defaultPreloadStaleTime 或 routeOptions.preloadStaleTime 设置为 0 来绕过内置缓存。这将确保所有预加载在内部都被标记为 stale（过时），并且加载器始终会被调用，从而允许您的外部库（如 React Query）来管理数据加载和缓存。

例如

tsx

import { createRouter } from '@tanstack/solid-router'

const router = createRouter({
  // ...
  defaultPreloadStaleTime: 0,
})

import { createRouter } from '@tanstack/solid-router'

const router = createRouter({
  // ...
  defaultPreloadStaleTime: 0,
})

这样，您就可以使用 React Query 的 staleTime 选项来控制预加载数据的有效性。

手动预加载

如果您需要手动预加载路由，可以使用路由器的 preloadRoute 方法。它接受一个标准的 TanStack NavigateOptions 对象，并返回一个在路由预加载完成后解析的 Promise。

tsx

function Component() {
  const router = useRouter()

  useEffect(() => {
    async function preload() {
      try {
        const matches = await router.preloadRoute({
          to: postRoute,
          params: { id: 1 },
        })
      } catch (err) {
        // Failed to preload route
      }
    }

    preload()
  }, [router])

  return <div />
}

function Component() {
  const router = useRouter()

  useEffect(() => {
    async function preload() {
      try {
        const matches = await router.preloadRoute({
          to: postRoute,
          params: { id: 1 },
        })
      } catch (err) {
        // Failed to preload route
      }
    }

    preload()
  }, [router])

  return <div />
}

如果您只需要预加载路由的 JS 块，可以使用路由器的 loadRouteChunk 方法。它接受一个路由对象，并返回一个在路由块加载完成后解析的 Promise。

tsx

function Component() {
  const router = useRouter()

  useEffect(() => {
    async function preloadRouteChunks() {
      try {
        const postsRoute = router.routesByPath['/posts']
        await Promise.all([
          router.loadRouteChunk(router.routesByPath['/']),
          router.loadRouteChunk(postsRoute),
          router.loadRouteChunk(postsRoute.parentRoute),
        ])
      } catch (err) {
        // Failed to preload route chunk
      }
    }

    preloadRouteChunks()
  }, [router])

  return <div />
}

function Component() {
  const router = useRouter()

  useEffect(() => {
    async function preloadRouteChunks() {
      try {
        const postsRoute = router.routesByPath['/posts']
        await Promise.all([
          router.loadRouteChunk(router.routesByPath['/']),
          router.loadRouteChunk(postsRoute),
          router.loadRouteChunk(postsRoute.parentRoute),
        ])
      } catch (err) {
        // Failed to preload route chunk
      }
    }

    preloadRouteChunks()
  }, [router])

  return <div />
}