SuperAPI AI 工具集

code-refactor

编程与开发

查看项目

更新于 10-16 11:44

技能介绍

用途

code-refactor 是一个程式码重构技能,主要用途是主动侦测并执行程式码重构,以维持 DDD 架构和程式码品质。它既可由使用者指令触发,也可在侦测到程式码超过阈值时主动触发。

触发条件

  • 使用者说「重构这段程式码」「refactor」。
  • 使用者说「这个档案太长了」。
  • 使用者提到「模组化」「拆分」。
  • 主动触发:侦测到程式码超过阈值时。

核心原则

  • 依据宪法第 7.3 条「主动重构原则」。
  • 重构不是改天换地,而是持续的小步快跑。
  • 每次提交都应该比上次更干净。

阈值设定

长度阈值

类型 警告 强制重构
档案 > 200 行 > 400 行
类别 > 150 行 > 300 行
函数 > 30 行 > 50 行
目录档案数 > 10 个 > 15 个

复杂度阈值

指标 警告 强制重构
圈复杂度 > 10 > 15
嵌套深度 > 3 层 > 4 层
参数数量 > 4 个 > 6 个
依赖数量 > 5 个 > 8 个

重构模式库

  1. Extract Method(提取方法):触发条件为函数过长、重复逻辑。将过长的处理流程拆分为独立的验证、计算、储存方法,并加上说明。
  2. Extract Class(提取类别):触发条件为类别职责过多、超过 150 行。例如从 User 类别提取出 Address 值物件。
  3. Replace Conditional with Polymorphism(多态取代条件):触发条件为大量 if-elif-else 或 switch。以策略模式取代条件地狱,例如不同运送方式的运费计算。
  4. Introduce Parameter Object(参数物件):触发条件为参数超过 4 个。以 dataclass 封装多个参数,例如 CreateUserCommand。
  5. Split Module(拆分模组):触发条件为目录超过 10 个档案。按子领域拆分,例如将 Domain 拆为 Identity、Ordering、Catalog、Promotion、Communication 等子目录。

DDD 架构守护

重构时必须检查是否违反 DDD 原则,常见违规包括:

  • Domain 层依赖 Infrastructure(例如 Domain/Services/OrderService.py 直接 from infrastructure.database import db)。
  • Presentation 直接存取 Domain(例如 Presentation/API/routes.py 直接 from domain.repositories import UserRepository,应透过 Application)。
  • Entity 包含持久化逻辑(例如 User 类别内定义 save() 直接操作 db.session.add(self),应放在 Repository)。

正确依赖方向为:Presentation → Application → Domain,且 Infrastructure 位于下方被依赖。

重构流程

  1. 侦测阶段:报告档案路径、问题(如档案长度 342 行超过 200 行警告阈值)、复杂度(如圈复杂度 12 超过 10 警告阈值)。
  2. 分析阶段:分析结果,例如 process_order() 函数 85 行建议拆分、发现 3 处重复逻辑建议提取、识别出 2 个隐藏的 Value Object。
  3. 规划阶段:重划计划,例如提取 OrderValidator 类别、提取 PricingCalculator 服务、建立 OrderStatus Value Object、更新测试确保覆盖。
  4. 执行阶段:执行重构并逐项勾选,例如建立 OrderValidator 类别、迁移验证逻辑、更新测试、确认测试通过,再继续下一项。
  5. 验证阶段:验证结果,例如测试全部通过(42/42)、覆盖率 85%(+3%)、复杂度 8(-4)、架构符合 DDD。

主动建议范本

当侦测到需要重构时,AI 应主动建议,内容包括:侦测到档案已达 250 行建议模组化、建议拆分方案表格(新档案、内容、行数)、预期效益(单一职责原则、更易测试、降低认知负荷),并询问是否执行该重构。

与其他 Skills 整合

Skill 整合方式
code-reviewer 审查时触发重构建议
test-generator 重构前先生成测试
ddd-architect 确保重构符合 DDD
memory-updater 记录重构决策

限制

资料中未提供适用程式语言范围、是否支援自动化执行或仅提供建议、安装方式与收费模式等资讯,暂未提供。