Loading...
Loading...
Compare original and translation side by side
variablesuseErrorBoundaryonlinealwaysofflineFirstqueryOptionsonErroronSuccessonSettledonMutateResultvariablesuseErrorBoundaryonlinealwaysofflineFirstqueryOptionsonErroronSuccessonSettledonMutateResultnpm install @tanstack/react-query@latest @tanstack/react-query-devtools@latestimport { QueryClient, QueryClientProvider } from '@tanstack/react-query'
import { ReactQueryDevtools } from '@tanstack/react-query-devtools'
const queryClient = new QueryClient({
defaultOptions: {
queries: {
staleTime: 1000 * 60 * 5, // 5 min
gcTime: 1000 * 60 * 60, // 1 hour
refetchOnWindowFocus: false,
},
},
})
function App() {
return (
<QueryClientProvider client={queryClient}>
<YourApp />
<ReactQueryDevtools initialIsOpen={false} />
</QueryClientProvider>
)
}npm install @tanstack/react-query@latest @tanstack/react-query-devtools@latestimport { QueryClient, QueryClientProvider } from '@tanstack/react-query'
import { ReactQueryDevtools } from '@tanstack/react-query-devtools'
const queryClient = new QueryClient({
defaultOptions: {
queries: {
staleTime: 1000 * 60 * 5, // 5分钟
gcTime: 1000 * 60 * 60, // 1小时
refetchOnWindowFocus: false,
},
},
})
function App() {
return (
<QueryClientProvider client={queryClient}>
<YourApp />
<ReactQueryDevtools initialIsOpen={false} />
</QueryClientProvider>
)
}TanStackDevtoolsnpm install -D @tanstack/react-devtoolsimport { QueryClient, QueryClientProvider } from '@tanstack/react-query'
import { ReactQueryDevtoolsPanel } from '@tanstack/react-query-devtools'
import { TanStackDevtools } from '@tanstack/react-devtools'
function App() {
return (
<QueryClientProvider client={queryClient}>
<YourApp />
<TanStackDevtools
config={{ position: 'bottom-right' }}
plugins={[
{ name: 'TanStack Query', render: <ReactQueryDevtoolsPanel /> },
// Add more plugins: Router, etc.
]}
/>
</QueryClientProvider>
)
}*PanelReactQueryDevtoolsPanelTanStackRouterDevtoolsPanelTanStackDevtoolsimport { useQuery, useMutation, useQueryClient, queryOptions } from '@tanstack/react-query'
const todosQueryOptions = queryOptions({
queryKey: ['todos'],
queryFn: async () => {
const res = await fetch('/api/todos')
if (!res.ok) throw new Error('Failed to fetch')
return res.json()
},
})
function useTodos() {
return useQuery(todosQueryOptions)
}
function useAddTodo() {
const queryClient = useQueryClient()
return useMutation({
mutationFn: async (newTodo: { title: string }) => {
const res = await fetch('/api/todos', {
method: 'POST',
headers: { 'Content-Type': 'application/json' },
body: JSON.stringify(newTodo),
})
if (!res.ok) throw new Error('Failed to add')
return res.json()
},
onSuccess: () => {
queryClient.invalidateQueries({ queryKey: ['todos'] })
},
})
}TanStackDevtoolsnpm install -D @tanstack/react-devtoolsimport { QueryClient, QueryClientProvider } from '@tanstack/react-query'
import { ReactQueryDevtoolsPanel } from '@tanstack/react-query-devtools'
import { TanStackDevtools } from '@tanstack/react-devtools'
function App() {
return (
<QueryClientProvider client={queryClient}>
<YourApp />
<TanStackDevtools
config={{ position: 'bottom-right' }}
plugins={[
{ name: 'TanStack Query', render: <ReactQueryDevtoolsPanel /> },
// 添加更多插件:Router等
]}
/>
</QueryClientProvider>
)
}TanStackDevtools*PanelReactQueryDevtoolsPanelTanStackRouterDevtoolsPanelimport { useQuery, useMutation, useQueryClient, queryOptions } from '@tanstack/react-query'
const todosQueryOptions = queryOptions({
queryKey: ['todos'],
queryFn: async () => {
const res = await fetch('/api/todos')
if (!res.ok) throw new Error('Failed to fetch')
return res.json()
},
})
function useTodos() {
return useQuery(todosQueryOptions)
}
function useAddTodo() {
const queryClient = useQueryClient()
return useMutation({
mutationFn: async (newTodo: { title: string }) => {
const res = await fetch('/api/todos', {
method: 'POST',
headers: { 'Content-Type': 'application/json' },
body: JSON.stringify(newTodo),
})
if (!res.ok) throw new Error('Failed to add')
return res.json()
},
onSuccess: () => {
queryClient.invalidateQueries({ queryKey: ['todos'] })
},
})
}| Priority | Category | Rule File | Impact |
|---|---|---|---|
| CRITICAL | Query Keys | | Prevents cache bugs and data inconsistencies |
| CRITICAL | Caching | | Optimizes performance and data freshness |
| HIGH | Invalidation | | Ensures stale data is properly refreshed |
| HIGH | Mutations | | Ensures data integrity after writes |
| HIGH | Optimistic Updates | | Responsive UI during mutations |
| HIGH | Error Handling | | Prevents poor user experiences |
| MEDIUM | Prefetching | | Improves perceived performance |
| MEDIUM | Infinite Queries | | Prevents pagination bugs |
| MEDIUM | SSR/Hydration | | Enables proper server rendering |
| MEDIUM | Parallel Queries | | Dynamic parallel fetching |
| LOW | Performance | | Reduces unnecessary re-renders |
| LOW | Offline Support | | Enables offline-first patterns |
| 优先级 | 类别 | 规则文件 | 影响 |
|---|---|---|---|
| 关键 | 查询键 | | 避免缓存错误和数据不一致 |
| 关键 | 缓存 | | 优化性能和数据新鲜度 |
| 高 | 失效 | | 确保陈旧数据被正确刷新 |
| 高 | 变更 | | 确保写入后的数据完整性 |
| 高 | 乐观更新 | | 变更过程中保持UI响应性 |
| 高 | 错误处理 | | 避免糟糕的用户体验 |
| 中 | 预获取 | | 提升感知性能 |
| 中 | 无限查询 | | 避免分页错误 |
| 中 | SSR/水合 | | 实现正确的服务端渲染 |
| 中 | 并行查询 | | 动态并行获取数据 |
| 低 | 性能 | | 减少不必要的重渲染 |
| 低 | 离线支持 | | 实现离线优先模式 |
useQuery({ queryKey, queryFn, ...options })['todos']['todos', id]['todos', { filter }]if (!res.ok) throw new Error('Failed')if (isPending) return <Loading />onSuccess: () => queryClient.invalidateQueries({ queryKey: ['todos'] })useQueryuseSuspenseQueryprefetchQueryuseQuery({ queryKey, queryFn, ...options })['todos']['todos', id]['todos', { filter }]if (!res.ok) throw new Error('Failed')if (isPending) return <Loading />onSuccess: () => queryClient.invalidateQueries({ queryKey: ['todos'] })useQueryuseSuspenseQueryprefetchQueryuseQuery(['todos'], fetchTodos)onSuccessonErroronSettleduseEffectisPendingplaceholderData: keepPreviousDatauseQuery(['todos'], fetchTodos)onSuccessonErroronSettleduseEffectisPendingplaceholderData: keepPreviousData| v4 | v5 | Notes |
|---|---|---|
| | Object syntax only |
| | Renamed |
| | |
| | Import |
| | Renamed |
| Removed | Use |
| | Required for infinite queries |
| | Renamed |
| | v5.89+ added 4th param |
| v4 | v5 | 说明 |
|---|---|---|
| | 仅支持对象语法 |
| | 已重命名 |
| | |
| | 需导入 |
| | 已重命名 |
查询中的 | 已移除 | 使用 |
| | 无限查询必填 |
| | 已重命名 |
| | v5.89+新增第4个参数 |
void prefetchQueryuseSuspenseQueryisFetchingawaitfetchStatususeQueryisLoadinguseSuspenseQueryretryOnMount: falserefetchOnMount: falsemutation.state.variablesunknownselectrefetchType: 'all'void prefetchQueryuseSuspenseQueryisFetchingawaitfetchStatususeQueryisLoadinguseSuspenseQueryretryOnMount: falserefetchOnMount: falsemutation.state.variablesunknownselectrefetchType: 'all'// Dependent queries (B waits for A)
const { data: user } = useQuery({ queryKey: ['user', id], queryFn: () => fetchUser(id) })
const { data: posts } = useQuery({
queryKey: ['posts', user?.id],
queryFn: () => fetchPosts(user!.id),
enabled: !!user,
})
// Parallel queries
const results = useQueries({
queries: ids.map(id => ({ queryKey: ['item', id], queryFn: () => fetchItem(id) })),
combine: (results) => ({ data: results.map(r => r.data), pending: results.some(r => r.isPending) }),
})
// Prefetch on hover
const handleHover = () => queryClient.prefetchQuery({ queryKey: ['item', id], queryFn: () => fetchItem(id) })
// Infinite scroll
useInfiniteQuery({
queryKey: ['posts'],
queryFn: ({ pageParam }) => fetchPosts(pageParam),
initialPageParam: 0,
getNextPageParam: (lastPage) => lastPage.nextCursor,
})
// Query cancellation
queryFn: async ({ signal }) => {
const res = await fetch(`/api/search?q=${query}`, { signal })
return res.json()
}
// Data transformation
useQuery({ queryKey: ['todos'], queryFn: fetchTodos, select: (data) => data.filter(t => t.completed) })// 依赖查询(B等待A完成)
const { data: user } = useQuery({ queryKey: ['user', id], queryFn: () => fetchUser(id) })
const { data: posts } = useQuery({
queryKey: ['posts', user?.id],
queryFn: () => fetchPosts(user!.id),
enabled: !!user,
})
// 并行查询
const results = useQueries({
queries: ids.map(id => ({ queryKey: ['item', id], queryFn: () => fetchItem(id) })),
combine: (results) => ({ data: results.map(r => r.data), pending: results.some(r => r.isPending) }),
})
// 悬停时预获取
const handleHover = () => queryClient.prefetchQuery({ queryKey: ['item', id], queryFn: () => fetchItem(id) })
// 无限滚动
useInfiniteQuery({
queryKey: ['posts'],
queryFn: ({ pageParam }) => fetchPosts(pageParam),
initialPageParam: 0,
getNextPageParam: (lastPage) => lastPage.nextCursor,
})
// 查询取消
queryFn: async ({ signal }) => {
const res = await fetch(`/api/search?q=${query}`, { signal })
return res.json()
}
// 数据转换
useQuery({ queryKey: ['todos'], queryFn: fetchTodos, select: (data) => data.filter(t => t.completed) })