占位符

什么是占位符数据？

占位符数据允许查询表现得好像它已经有数据一样，类似于 initialData 选项，但这些数据不会被持久化到缓存中。这在你拥有足够的部分（或模拟）数据来成功渲染查询时非常有用，而实际数据则在后台获取。

示例：单个博客文章查询可以从父级博客文章列表中提取“预览”数据，该数据仅包含标题和文章正文的一小段摘要。你可能不希望将此部分数据持久化到单个查询的结果缓存中，但它对于尽快显示内容布局非常有用，同时实际查询完成以获取整个对象。

有几种方法可以在需要之前为查询提供占位符数据：

• 声明式：

  • 提供 placeholderData 给查询，以在缓存为空时预填充

• 命令式：

  • 使用 queryClient 和 placeholderData 选项预取或获取数据

当我们使用 placeholderData 时，我们的查询将不会处于 pending 状态——它会从 success 状态开始，因为我们有可显示的 data——即使这些数据只是“占位符”数据。为了将其与“真实”数据区分开来，查询结果上的 isPlaceholderData 标志也会被设置为 true。

将占位符数据作为值使用

function Todos() {
  const result = useQuery({
    queryKey: ['todos'],
    queryFn: () => fetch('/todos'),
    placeholderData: placeholderTodos,
  })
}

占位符数据的备忘（Memoization）

如果访问查询占位符数据的过程很耗资源，或者你不想在每次渲染时都执行，可以对值进行备忘处理：

function Todos() {
  const placeholderData = useMemo(() => generateFakeTodos(), [])
  const result = useQuery({
    queryKey: ['todos'],
    queryFn: () => fetch('/todos'),
    placeholderData,
  })
}

将占位符数据作为函数使用

placeholderData 也可以是一个函数，在其中你可以访问“前一个”成功查询的数据和查询元信息。当你想将一个查询的数据用作另一个查询的占位符数据时，这非常有用。当查询键（QueryKey）发生变化时，例如从 ['todos', 1] 变为 ['todos', 2]，我们可以继续显示“旧”数据，而不是在数据从一个查询过渡到下一个查询时不得不显示加载指示器。有关更多信息，请参阅 分页查询。

const result = useQuery({
  queryKey: ['todos', id],
  queryFn: () => fetch(`/todos/${id}`),
  placeholderData: (previousData, previousQuery) => previousData,
})

来自缓存的占位符数据

在某些情况下，你可能能够从另一个查询的缓存结果中提供查询的占位符数据。一个很好的例子是，从博客文章列表查询的缓存数据中搜索单个文章的预览版本，然后将其用作单个文章查询的占位符数据：

function Todo({ blogPostId }) {
  const queryClient = useQueryClient()
  const result = useQuery({
    queryKey: ['blogPost', blogPostId],
    queryFn: () => fetch(`/blogPosts/${blogPostId}`),
    placeholderData: () => {
      // 使用来自 'blogPosts' 查询的较小/预览版本的博客文章
      // 作为此博客文章查询的占位符数据
      return queryClient
        .getQueryData(['blogPosts'])
        ?.find((d) => d.id === blogPostId)
    },
  })
}

进一步阅读

要比较 占位符数据 和 初始数据，请查看 社区资源。