Query Keys | TanStack Query React 文档

查询键

TanStack Query 的核心是基于查询键为您管理查询缓存。查询键在顶层必须是一个数组，可以像包含单个字符串的数组一样简单，也可以像包含多个字符串和嵌套对象的数组一样复杂。只要查询键是可序列化的，并且**对于查询的数据是唯一的**，您就可以使用它！

简单的查询键

最简单的键形式是包含常量值的数组。此格式适用于

通用列表/索引资源
非层级资源

tsx

// A list of todos
useQuery({ queryKey: ['todos'], ... })

// Something else, whatever!
useQuery({ queryKey: ['something', 'special'], ... })

// A list of todos
useQuery({ queryKey: ['todos'], ... })

// Something else, whatever!
useQuery({ queryKey: ['something', 'special'], ... })

带有变量的数组键

当查询需要更多信息来唯一描述其数据时，您可以使用包含字符串和任意数量的可序列化对象的数组来描述它。这对于以下情况很有用

层级或嵌套资源
- 通常传递 ID、索引或其他原始值来唯一标识项目
带有附加参数的查询
- 通常传递附加选项的对象

tsx

// An individual todo
useQuery({ queryKey: ['todo', 5], ... })

// An individual todo in a "preview" format
useQuery({ queryKey: ['todo', 5, { preview: true }], ...})

// A list of todos that are "done"
useQuery({ queryKey: ['todos', { type: 'done' }], ... })

// An individual todo
useQuery({ queryKey: ['todo', 5], ... })

// An individual todo in a "preview" format
useQuery({ queryKey: ['todo', 5, { preview: true }], ...})

// A list of todos that are "done"
useQuery({ queryKey: ['todos', { type: 'done' }], ... })

查询键是确定性地哈希的！

这意味着无论对象中键的顺序如何，以下所有查询都被认为是相等的

tsx

useQuery({ queryKey: ['todos', { status, page }], ... })
useQuery({ queryKey: ['todos', { page, status }], ...})
useQuery({ queryKey: ['todos', { page, status, other: undefined }], ... })

useQuery({ queryKey: ['todos', { status, page }], ... })
useQuery({ queryKey: ['todos', { page, status }], ...})
useQuery({ queryKey: ['todos', { page, status, other: undefined }], ... })

但是，以下查询键不相等。数组项顺序很重要！

tsx

useQuery({ queryKey: ['todos', status, page], ... })
useQuery({ queryKey: ['todos', page, status], ...})
useQuery({ queryKey: ['todos', undefined, page, status], ...})

useQuery({ queryKey: ['todos', status, page], ... })
useQuery({ queryKey: ['todos', page, status], ...})
useQuery({ queryKey: ['todos', undefined, page, status], ...})

如果您的查询函数依赖于变量，请将其包含在您的查询键中

由于查询键唯一地描述了它们正在获取的数据，因此它们应包含您在查询函数中使用的任何**更改**的变量。例如

tsx

function Todos({ todoId }) {
  const result = useQuery({
    queryKey: ['todos', todoId],
    queryFn: () => fetchTodoById(todoId),
  })
}

function Todos({ todoId }) {
  const result = useQuery({
    queryKey: ['todos', todoId],
    queryFn: () => fetchTodoById(todoId),
  })
}

请注意，查询键充当查询函数的依赖项。将依赖变量添加到您的查询键将确保查询被独立缓存，并且任何时候变量发生更改，*查询将自动重新获取*（取决于您的 staleTime 设置）。有关更多信息和示例，请参阅 exhaustive-deps 部分。

进一步阅读

有关在大型应用程序中组织查询键的提示，请查看有效的 React Query 键并查看来自社区资源的 Query Key Factory Package。