SuperAPI AI 工具集

tanstack-query-best-practices

通用与其它

查看项目

更新于 10-16 06:14

技能介绍

用途:该规则集用于在 React 应用中实现或审查 TanStack Query(React Query)的使用模式,覆盖数据获取、缓存、变更与服务端状态同步,帮助写对配置和代码结构。

适用时机:编写新的数据获取逻辑、设置查询配置、实现变更与乐观更新、配置缓存策略、集成 SSR/SSG、重构既有数据获取代码。

主要能力(21 条本地规则):缓存方面含 cache-gc-time(非活跃查询保留的 gcTime 配置)、cache-invalidation(用定向失效替代宽泛模式)、cache-placeholder-vs-initial(区分占位数据与初始数据)、cache-stale-time(按数据易变性设置 staleTime)。错误与分页方面含 err-error-boundaries(配合 useQueryErrorResetBoundary 使用错误边界)、inf-page-params(无限查询必须提供 getNextPageParam)。变更方面含 mut-invalidate-queries(变更后失效相关查询)、mut-mutation-state(用 useMutationState 跨组件跟踪变更状态)、mut-optimistic-updates(实现乐观更新)。网络与性能方面含 network-mode(配置离线支持的网络模式)、parallel-use-queries(用 useQueries 做动态并行查询)、perf-select-transform(用 select 转换与过滤数据)、persist-queries(配置查询持久化以支持离线)、pf-intent-prefetch(在 hover、focus 等用户意图时预取)。查询键方面含 qk-array-structure(查询键始终用数组)、qk-factory-pattern(复杂应用用查询键工厂)、qk-hierarchical-organization(层级化组织键)、qk-include-dependencies(包含查询依赖的全部变量)、qk-serializable(键各部分必须可 JSON 序列化)。其他含 query-cancellation(正确实现查询取消)与 ssr-dehydration(SSR 使用 Dehydrate/Hydrate 模式)。

使用方式:每条规则文件位于 rules/ 目录,包含 Explanation(为何重要)、Bad Example(应避免的反模式)、Good Example(推荐实现)、Context(何时适用或跳过)。未覆盖主题可查阅与所装包版本匹配的官方文档。

限制:资料未提供具体安装命令、代码示例与详细实现步骤,需查看各规则文件;该规则集面向 TanStack Query 与 React 场景,其他框架或版本适配情况暂未提供。