React Query 中关于 Zod Schema 被误判为依赖项的解析

在 React Query 的使用过程中，开发者经常会遇到一个特殊场景：当使用 Zod 等数据验证库时，ESLint 插件可能会错误地将 Zod Schema 识别为需要包含在 queryKey 中的依赖项。这种现象虽然看起来是个小问题，但实际上反映了静态代码分析工具在处理外部不可变值时的局限性。

问题本质分析

在 React Query 的最佳实践中，queryKey 应该包含所有会影响查询结果的变量。ESLint 插件通过静态分析来确保这一点，但它有时会将一些实际上不会变化的常量（如 Zod Schema）误判为需要包含的依赖项。

Zod Schema 本质上是一个静态的类型定义，它不会在运行时改变查询结果。将其包含在 queryKey 中不仅没有必要，还会导致缓存效率降低，因为每次渲染都会生成不同的 queryKey，即使 Schema 本身没有变化。

技术背景

React Query 的缓存机制依赖于 queryKey 的稳定性。当 queryKey 变化时，查询会被视为不同的查询，从而触发新的请求。这正是为什么 ESLint 插件会严格检查 queryKey 的完整性。

然而，像 Zod Schema 这样的纯函数式构造器具有以下特点：

1. 它们是静态的、不可变的
2. 在模块作用域中只初始化一次
3. 不会随着组件渲染而改变

解决方案

对于这种情况，开发者有以下几种处理方式：

1. 忽略规则：使用 ESLint 注释暂时禁用该规则

// eslint-disable-next-line @tanstack/query/exhaustive-deps

2. 重构代码：将 Schema 移到 queryKey 生成逻辑之外

const featureFlagsQueryKey = queries.root();
const featureFlagsQueryOptions = queryOptions({
  queryKey: featureFlagsQueryKey,
  // ...
});

3. 类型断言：明确告诉 TypeScript 这是一个常量

const FeatureFlagsSchema = z.string().array() as const;

最佳实践建议

1. 区分真正的依赖项和静态配置：Schema、配置对象等静态内容不应被视为依赖项
2. 保持 queryKey 的简洁性：只包含真正会影响数据获取的变量
3. 合理使用 ESLint 规则：理解规则的意图，但不盲目遵守

总结

React Query 的 ESLint 插件虽然提供了有价值的开发约束，但在处理外部不可变值时可能会出现误判。理解工具的工作原理和限制，能够帮助开发者做出更合理的决策，在保持代码质量的同时避免不必要的性能开销。

对于这类问题，开发者应该基于对业务逻辑和工具原理的理解，选择最适合项目需求的解决方案，而不是简单地遵循工具的所有提示。