React Query 中 ESLint 插件对常量依赖的错误检测问题解析

问题背景

在使用 React Query 的 ESLint 插件时，开发者可能会遇到一个关于依赖项检测的特殊情况。当在 queryOptions 中使用外部定义的常量时，ESLint 插件会错误地将其标记为缺失的依赖项，即使这些常量在技术上是不可变的。

问题重现

考虑以下两种代码结构：

// 情况一：函数返回对象 - 正常工作
export const thisDoesNotShowError = () => ({
  q3: queryOptions({
    queryKey: ['getAll'],
    queryFn: () => Promise.resolve(EXAMPLE_CONST),
  }),
});

// 情况二：直接对象定义 - 错误报告
export const thisShowsError = {
  q3: queryOptions({
    queryKey: ['getAll'],
    queryFn: () => Promise.resolve(EXAMPLE_CONST),
  }),
};

在第二种情况下，ESLint 插件会错误地报告："The following dependencies are missing in your queryKey: EXAMPLE_CONST"，尽管 EXAMPLE_CONST 是一个不可变的常量。

技术分析

这个问题源于 ESLint 插件对依赖项分析的实现方式。插件原本设计用于检测可能变化的依赖项，但对于 JavaScript/TypeScript 中的常量（const 声明），理论上它们的值是不可变的，因此不应该被视为需要包含在 queryKey 中的依赖项。

在 React Query 的设计理念中，queryKey 应该包含所有可能影响查询结果的变量。然而，对于真正的常量，它们不会改变查询结果的行为，因为它们的值永远不会改变。

解决方案

React Query 团队已经修复了这个问题。修复的核心思路是改进依赖项分析逻辑，使其能够正确识别 JavaScript 的常量声明，不再将它们误报为需要包含在 queryKey 中的依赖项。

对于开发者来说，这意味着：

1. 可以安全地在 queryOptions 中使用外部定义的常量
2. 不再需要为了通过 lint 检查而将常量包含在 queryKey 中
3. 代码可以保持更简洁，同时仍然保持类型安全

最佳实践

虽然这个问题已经修复，但在使用 React Query 时，仍然建议：

1. 对于真正的常量，使用 const 声明并保持大写命名约定
2. 对于可能变化的值，确保它们包含在 queryKey 中
3. 定期更新 React Query 及其相关插件到最新版本
4. 在团队中统一代码风格，避免混合使用不同的模式（函数返回对象 vs 直接对象定义）

这个问题也提醒我们，在使用静态分析工具时，理解其背后的原理和限制非常重要，这样才能在工具报告问题时做出正确的判断。