SuperAPI AI 工具集

component-colocation

编程与开发

查看项目

更新于 10-25 20:55

技能介绍

用途

Component Colocation & Refactoring 是一套针对 React 项目的组件结构整理与重构规范,通常在一次功能迁移或重构完成后使用,用来审查组件的组织方式。资料特别指出,它适用于表格、数据网格这类容易出现过度拆分的场景。其核心思路是:在启用 React Compiler 的情况下,许多原本只为性能而拆分组件的理由不再成立,因此应把相关代码合并起来,把文件放在实际使用它的位置,并删除不再使用的文件。

主要能力

该规范以原则和检查清单的形式,给出判断组件是否应当拆分或合并的依据,包括:

  • 不要过度拆分组件:React Compiler 会自动处理记忆化,不需要为了性能把组件拆成更小的部分。资料给出的反例是每个按钮组各占一个文件,而正例是把所有逻辑集中到一个组件中,用条件分支处理不同状态。
  • 大文件是可以接受的:不必害怕 300 到 500 行的组件。拆分反而会带来更多需要浏览的文件、组件之间的属性逐层传递、更难跟踪的数据流以及重复的 Hook 调用。
  • 就近放置:采用垂直切片架构,把功能代码放在一起。反例是把动作按钮、状态徽章和 Hook 分散在共享目录,正例是把它们放进功能目录下的 _components 中。
  • 拆分前先问:只有在需要解耦 Hook 上下文、被两个以上互不相关的功能复用,或用户明确要求分离时才拆分。资料明确列出不应以“可读性”“性能”“单一职责”为理由拆分。

使用方式

资料给出的使用路径是在功能实现后(尤其是表格、数据网格)进入审查,或在重构期间检查组件结构,或在发现文件分散在多个文件夹却只在一处使用时,或在清理状态管理迁移之后的遗留代码时应用。功能完成后的检查清单包括:删除不再被引用的组件与 Hook;合并只在一起使用的文件;把只在该功能使用的文件移入其 _components 目录;若拆分组件之间传递 5 个以上属性则合并;若多个组件调用相同 Hook 则合并组件。

资料还列出常见错误及修正方式,例如“每个变体一个文件”应合并为带条件分支的单个组件,功能专属代码不应放进共享文件夹,删除上下文后不应保留其组件,也不应以“可测试性”为由拆分。合并的警示信号包括:为只在一处使用的组件新建文件、为抵达拆分组件而跨两层以上传递属性、多个小组件调用相同 Hook、共享文件夹中存放功能专属代码、组件名带有 Part1、Section、Inner 等。

适用场景与边界

该规范适用于 example/**、www/** 和包 UI 模块,但前提是先确认受影响的应用确实启用了 React Compiler。资料明确禁止跨公共包导出、运行时入口、生成边界、CLI 模板归属以及 React/Solid 框架边界进行合并。脚手架夹具输出属于生成产物,应改进其源模板后重新生成,不能先编辑已提交的夹具输出再就近放置。

示例

资料给出一个操作按钮重构示例:重构前,按钮逻辑被拆成路由包装、草稿状态、待签署、ISO、标记完成、拒绝、已签署等多个文件,甚至把单个按钮也抽成文件;重构后,所有逻辑集中在一个约 400 行的文件中,用 switch 语句处理每种表单状态,Hook 只调用一次,没有属性逐层传递,便于跟进。

限制

资料未提供该规范的安装命令、配置文件、自动化检查工具、与具体构建系统的集成方式、收费或授权信息,也未说明除 React Compiler 外的其他前置条件,这些内容暂未提供。