SuperAPI AI 工具集

react-hook-writing

编程与开发

查看项目

更新于 10-16 07:15

技能介绍

用途:该资料提供编写 React 自定义 Hook 的设计原则与规范,每节含“做法 + 原因”,用于统一团队 Hook 的 API 与实现风格。作者说明 C1、C7 属于项目约定而非通用 React 规则。

主要能力: API 设计上要求始终返回对象(如 { value })而非元组,参数使用对象而非位置参数,以便命名清晰、顺序无关、可扩展;使用具名导出,不用默认导出。 SSR 安全上采用固定初始值加 useEffect 同步,禁止在 useState 初始化器里调用浏览器 API;纯客户端应用可用条件初始化器。 状态设计上强调派生而非同步(渲染期计算,不用 Effect),用 useRef 存不参与渲染的值,用判别联合类型替代布尔组合,不镜像 props,ID 替代对象,归类相关状态,用卫语句提前返回。 Effect 模式上仅用于同步外部系统,禁止 Effect 链,用 key 重置替代 Effect 清状态,依赖只在 Effect 内使用时定义在内部,父级回调在同一事件处理器中调用,订阅浏览器 API 或第三方 store 优先用 useSyncExternalStore。 清理:每个副作用都需清理,包括移除事件监听、AbortController 中止异步、clearInterval 清定时器;异步需忽略标记或 AbortController 防竞态。 性能:仅用于每秒超过 30 次的事件(滚动、缩放、键盘),如 16ms 节流、去重跳过相同值、startTransition;useMemo 仅用于实测 ≥1ms 计算,useCallback 仅在传给 memo() 子组件时使用。 TypeScript:泛型 <T> 不用 any,严格布尔判断,声明用 function 关键字,内联回调用箭头函数。文档使用 JSDoc 标注参数与返回值。 依赖:零运行时依赖,仅 peerDependencies;外部依赖通过参数注入;同一状态加 Effect 在 2 个以上组件出现时抽成 Hook。

使用方式:资料未给出具体安装命令或运行步骤,仅说明完整 Hook 实现见 patterns.md;涉及更高层 React API 或抽象设计时改用 react-design-principles。

限制:C1、C7 等条目是项目约定,并非 React 强制规则;性能优化强调只在实测必要且高频场景下应用。