TanStackQuery v5
自动
框架
版本
菜单
入门指南
指南和概念
API 参考
ESLint
社区资源
示例
插件

无限查询

渲染可以累加“加载更多”数据到现有数据集或“无限滚动”的列表也是一种非常常见的 UI 模式。TanStack Query 支持一个有用的 useQuery 版本，称为 useInfiniteQuery，用于查询这些类型的列表。

当使用 useInfiniteQuery 时，您会注意到一些事情发生了变化：

  • data 现在是一个包含无限查询数据的对象：
  • data.pages 数组，包含获取的页面
  • data.pageParams 数组，包含用于获取页面的页面参数
  • 现在可以使用 fetchNextPage 和 fetchPreviousPage 函数（fetchNextPage 是必需的）
  • 现在可以使用 initialPageParam 选项（并且是必需的）来指定初始页面参数
  • getNextPageParam 和 getPreviousPageParam 选项可用于确定是否有更多数据要加载以及获取它的信息。此信息作为查询函数中的附加参数提供
  • 现在可以使用 hasNextPage 布尔值，如果 getNextPageParam 返回除 null 或 undefined 之外的值，则为 true
  • 现在可以使用 hasPreviousPage 布尔值，如果 getPreviousPageParam 返回除 null 或 undefined 之外的值，则为 true
  • 现在可以使用 isFetchingNextPage 和 isFetchingPreviousPage 布尔值来区分后台刷新状态和加载更多状态

注意：选项 initialData 或 placeholderData 需要符合与具有 data.pages 和 data.pageParams 属性的对象相同的结构。

示例

假设我们有一个 API，它根据 cursor 索引一次返回 3 个 projects 页面，以及一个可用于获取下一组项目的游标：

tsx
fetch('/api/projects?cursor=0')
// { data: [...], nextCursor: 3}
fetch('/api/projects?cursor=3')
// { data: [...], nextCursor: 6}
fetch('/api/projects?cursor=6')
// { data: [...], nextCursor: 9}
fetch('/api/projects?cursor=9')
// { data: [...] }

fetch('/api/projects?cursor=0')
// { data: [...], nextCursor: 3}
fetch('/api/projects?cursor=3')
// { data: [...], nextCursor: 6}
fetch('/api/projects?cursor=6')
// { data: [...], nextCursor: 9}
fetch('/api/projects?cursor=9')
// { data: [...] }

有了这些信息，我们可以通过以下方式创建一个“加载更多”UI：

  • 等待 useInfiniteQuery 默认请求第一组数据
  • 在 getNextPageParam 中返回下一个查询的信息
  • 调用 fetchNextPage 函数
tsx
import { useInfiniteQuery } from '@tanstack/react-query'

function Projects() {
  const fetchProjects = async ({ pageParam }) => {
    const res = await fetch('/api/projects?cursor=' + pageParam)
    return res.json()
  }

  const {
    data,
    error,
    fetchNextPage,
    hasNextPage,
    isFetching,
    isFetchingNextPage,
    status,
  } = useInfiniteQuery({
    queryKey: ['projects'],
    queryFn: fetchProjects,
    initialPageParam: 0,
    getNextPageParam: (lastPage, pages) => lastPage.nextCursor,
  })

  return status === 'pending' ? (
    <p>加载中...</p>
  ) : status === 'error' ? (
    <p>错误：{error.message}</p>
  ) : (
    <>
      {data.pages.map((group, i) => (
        <React.Fragment key={i}>
          {group.data.map((project) => (
            <p key={project.id}>{project.name}</p>
          ))}
        </React.Fragment>
      ))}
      <div>
        <button
          onClick={() => fetchNextPage()}
          disabled={!hasNextPage || isFetching}
        >
          {isFetchingNextPage
            ? '正在加载更多...'
            : hasNextPage
              ? '加载更多'
              : '没有更多内容可加载'}
        </button>
      </div>
      <div>{isFetching && !isFetchingNextPage ? '正在获取...' : null}</div>
    </>
  )
}

import { useInfiniteQuery } from '@tanstack/react-query'

function Projects() {
  const fetchProjects = async ({ pageParam }) => {
    const res = await fetch('/api/projects?cursor=' + pageParam)
    return res.json()
  }

  const {
    data,
    error,
    fetchNextPage,
    hasNextPage,
    isFetching,
    isFetchingNextPage,
    status,
  } = useInfiniteQuery({
    queryKey: ['projects'],
    queryFn: fetchProjects,
    initialPageParam: 0,
    getNextPageParam: (lastPage, pages) => lastPage.nextCursor,
  })

  return status === 'pending' ? (
    <p>加载中...</p>
  ) : status === 'error' ? (
    <p>错误：{error.message}</p>
  ) : (
    <>
      {data.pages.map((group, i) => (
        <React.Fragment key={i}>
          {group.data.map((project) => (
            <p key={project.id}>{project.name}</p>
          ))}
        </React.Fragment>
      ))}
      <div>
        <button
          onClick={() => fetchNextPage()}
          disabled={!hasNextPage || isFetching}
        >
          {isFetchingNextPage
            ? '正在加载更多...'
            : hasNextPage
              ? '加载更多'
              : '没有更多内容可加载'}
        </button>
      </div>
      <div>{isFetching && !isFetchingNextPage ? '正在获取...' : null}</div>
    </>
  )
}

重要的是要理解，在正在进行的获取过程中调用 fetchNextPage 会有覆盖后台正在进行的数据刷新���风险。当渲染列表并同时触发 fetchNextPage 时，这种情况尤其关键。

请记住，InfiniteQuery 只能有一个正在进行的获取。所有页面共享一个缓存条目，同时尝试获取两次可能会导致数据覆盖。

如果您打算启用同时获取，可以在 fetchNextPage 中使用 { cancelRefetch: false } 选项（默认为 true）。

为确保查询过程无缝且无冲突，强烈建议验证查询是否未处于 isFetching 状态，尤其是在用户不会直接控制该调用的情况下。

jsx
<List onEndReached={() => hasNextPage && !isFetching && fetchNextPage()} />

<List onEndReached={() => hasNextPage && !isFetching && fetchNextPage()} />

当无限查询需要重新获取时会发生什么？

当无限查询变为 stale 并需要重新获取时，每个组都会从第一个组开始按顺序获取。这确保了即使基础数据发生突变，我们也不会使用过时的游标，并且不会出现重复或跳过记录的情况。如果无限查询的结果从 queryCache 中删除，则分页将以初始状态重新开始，仅请求初始组。

如果我想实现双向无限列表怎么办？

双向列表可以通过使用 getPreviousPageParam、fetchPreviousPage、hasPreviousPage 和 isFetchingPreviousPage 属性和函数以与“加载更多”UI 非常相似的方式实现。

tsx
useInfiniteQuery({
  queryKey: ['projects'],
  queryFn: fetchProjects,
  initialPageParam: 0,
  getNextPageParam: (lastPage, pages) => lastPage.nextCursor,
  getPreviousPageParam: (firstPage, pages) => firstPage.prevCursor,
})

useInfiniteQuery({
  queryKey: ['projects'],
  queryFn: fetchProjects,
  initialPageParam: 0,
  getNextPageParam: (lastPage, pages) => lastPage.nextCursor,
  getPreviousPageParam: (firstPage, pages) => firstPage.prevCursor,
})

如果我想以相反的顺序显示页面怎么办？

有时您可能希望以相反的顺序显示页面。如果是这种情况，您可以使用 select 选项：

tsx
useInfiniteQuery({
  queryKey: ['projects'],
  queryFn: fetchProjects,
  select: (data) => ({
    pages: [...data.pages].reverse(),
    pageParams: [...data.pageParams].reverse(),
  }),
})

useInfiniteQuery({
  queryKey: ['projects'],
  queryFn: fetchProjects,
  select: (data) => ({
    pages: [...data.pages].reverse(),
    pageParams: [...data.pageParams].reverse(),
  }),
})

如果我想手动更新无限查询怎么办？

手动删除第一页：
tsx
queryClient.setQueryData(['projects'], (data) => ({
  pages: data.pages.slice(1),
  pageParams: data.pageParams.slice(1),
}))

queryClient.setQueryData(['projects'], (data) => ({
  pages: data.pages.slice(1),
  pageParams: data.pageParams.slice(1),
}))

从单个页面手动删除单个值：
tsx
const newPagesArray =
  oldPagesArray?.pages.map((page) =>
    page.filter((val) => val.id !== updatedId),
  ) ?? []

queryClient.setQueryData(['projects'], (data) => ({
  pages: newPagesArray,
  pageParams: data.pageParams,
}))

const newPagesArray =
  oldPagesArray?.pages.map((page) =>
    page.filter((val) => val.id !== updatedId),
  ) ?? []

queryClient.setQueryData(['projects'], (data) => ({
  pages: newPagesArray,
  pageParams: data.pageParams,
}))

仅保留第一页：
tsx
queryClient.setQueryData(['projects'], (data) => ({
  pages: data.pages.slice(0, 1),
  pageParams: data.pageParams.slice(0, 1),
}))

queryClient.setQueryData(['projects'], (data) => ({
  pages: data.pages.slice(0, 1),
  pageParams: data.pageParams.slice(0, 1),
}))

确保始终保持页面和 pageParams 的相同数据结构！

如果我想限制页面数量怎么办？

在某些用例中，您可能希望限制存储在查询数据中的页面数量，以提高性能和用户体验：

  • 当用户可以加载大量页面时（内存使用）
  • 当您必须重新获取包含数十个页面的无限查询时（网络使用：所有页面都按顺序获取）

解决方案是使用“受限无限查询”。这可以通过使用 maxPages 选项结合 getNextPageParam 和 getPreviousPageParam 来实现在需要时双向获取页面。

在以下示例中，查询数据页面数组中仅保留 3 个页面。如果需要重新获取，则只会按顺序重新获取 3 个页面。

tsx
useInfiniteQuery({
  queryKey: ['projects'],
  queryFn: fetchProjects,
  initialPageParam: 0,
  getNextPageParam: (lastPage, pages) => lastPage.nextCursor,
  getPreviousPageParam: (firstPage, pages) => firstPage.prevCursor,
  maxPages: 3,
})

useInfiniteQuery({
  queryKey: ['projects'],
  queryFn: fetchProjects,
  initialPageParam: 0,
  getNextPageParam: (lastPage, pages) => lastPage.nextCursor,
  getPreviousPageParam: (firstPage, pages) => firstPage.prevCursor,
  maxPages: 3,
})

如果我的 API 不返回游标怎么办？

如果您的 API 不返回游标，您可以将 pageParam 用作游标。因为 getNextPageParam 和 getPreviousPageParam 也会获取当前页面的 pageParam，所以您可以使用它来计算下一个/上一个页面参数。

tsx
return useInfiniteQuery({
  queryKey: ['projects'],
  queryFn: fetchProjects,
  initialPageParam: 0,
  getNextPageParam: (lastPage, allPages, lastPageParam) => {
    if (lastPage.length === 0) {
      return undefined
    }
    return lastPageParam + 1
  },
  getPreviousPageParam: (firstPage, allPages, firstPageParam) => {
    if (firstPageParam <= 1) {
      return undefined
    }
    return firstPageParam - 1
  },
})

return useInfiniteQuery({
  queryKey: ['projects'],
  queryFn: fetchProjects,
  initialPageParam: 0,
  getNextPageParam: (lastPage, allPages, lastPageParam) => {
    if (lastPage.length === 0) {
      return undefined
    }
    return lastPageParam + 1
  },
  getPreviousPageParam: (firstPage, allPages, firstPageParam) => {
    if (firstPageParam <= 1) {
      return undefined
    }
    return firstPageParam - 1
  },
})
在 GitHub 上编辑
分页查询
初始查询数据