SuperAPI AI 工具集

no-use-effect

编程与开发

查看项目

更新于 10-16 07:29

技能介绍

用途

no-use-effect 是一个面向 React 开发的技能,用于在编写或审查 React 代码时强制执行「不使用 useEffect」的规则。它针对的是 React 中常见的 useEffect 滥用问题,引导开发者采用更符合 React 设计理念的替代方案。

该技能在以下场景中激活:编写新的 React 组件、重构已有的 useEffect 调用、审查引入 useEffect 的 PR,以及当智能体「以防万一」添加 useEffect 时。

主要能力

技能的核心主张是:永远不要直接调用 useEffect。取而代之的是使用派生状态、事件处理器、数据获取库或 useMountEffect。

技能提供了五条替换规则,每条规则都配有「坏味道测试」(smell test)帮助判断何时适用:

规则 1:派生状态,不要同步状态。 大多数从其他状态设置状态的 effect 都是不必要的,并且会增加额外的渲染。应改为在一次渲染中内联计算。坏味道测试:你正准备写 useEffect(() => setX(deriveFromY(y)), [y]),或者你有仅镜像其他状态或 props 的状态。

规则 2:使用数据获取库。 基于 effect 的数据获取会产生竞态条件并重复缓存逻辑。应改用 useQuery 等查询库来处理取消、缓存和过期。坏味道测试:你的 useEffect 内部有 fetch、axios 或任何异步调用,并且你在手动管理 loading/error/data 状态。

规则 3:使用事件处理器,而非 effect。 如果某事是响应用户操作而发生的,就把它放在事件处理器中。坏味道测试:你的 effect 因为某个状态变量变化而运行,但该状态变量是由你控制的事件处理器设置的。

规则 4:用 useMountEffect 处理一次性外部同步。 对于稳定依赖(单例、refs、永不变化的 context 值),使用 useMountEffect。坏味道测试:你的 effect 依赖是稳定的(永不变化),或者你在 effect 内部用条件守卫。

规则 5:用 key 重置,而非依赖编排。 当 prop 变化且需要重置组件状态时,在父组件上使用 key,而不是用监听该 prop 的 effect。坏味道测试:你有 useEffect(() => resetSomething(), [someProp])。

使用方式

技能的工作流程分为三步:

  1. 识别 useEffect:确定该 effect 在做什么——派生状态、获取数据、响应事件、与外部系统同步,还是重置状态。
  2. 应用正确的替换模式:使用上述五条规则选择正确的替代方案。
  3. 验证:运行以下命令进行验证:
npm run lint -- --filter=<package>
npm run typecheck -- --filter=<package>
npm run test -- --filter=<package>

技能还提供了逃生舱 useMountEffect,用于需要在挂载时与外部系统同步的罕见情况。其实现用空依赖数组包装 useEffect,使意图更明确:

export function useMountEffect(effect: () => void | (() => void)) {
  /* eslint-disable no-restricted-syntax */
  useEffect(effect, []);
}

此外,技能给出了一个组件模板,展示了推荐的代码组织方式:本地状态、计算值(而非 useEffect + setState)、数据获取(而非 useEffect + fetch)、事件处理器、一次性设置(而非带空数组的 useEffect)。

适用场景

  • 编写新的 React 组件时,避免引入不必要的 useEffect。
  • 重构现有代码中滥用 useEffect 的部分。
  • 在代码审查中识别并纠正引入 useEffect 的 PR。
  • 约束智能体在生成 React 代码时不要随意添加 useEffect。

限制

资料中未提供该技能的具体安装方式、支持的 React 版本、与特定框架或工具的集成细节、收费信息或价格。技能中提到的 lint 规则为 no-restricted-syntax(配置为禁用 useEffect),并引用了 React 官方文档「You Might Not Need an Effect」。