SuperAPI AI 工具集

clean-apex

编程与开发

查看项目

更新于 10-16 06:48

技能介绍

clean-apex 是一套面向 Salesforce Apex 的整洁代码指导技能,强调极简、有主见的规范,聚焦可读性、命名、架构分层、错误处理与测试分离。默认不处理安全检查、性能调优或评分,除非用户明确要求。

用途与主要能力:提供生成与审查两种模式。生成时要求采用三层结构:入口点保持最小化,服务层负责编排,OO 类负责内存计算;所有 DML 只放在静态服务层,OO 类保持无 DML;SOQL 放在 selector/查询类中,并以属性方式注入 OO 类;严格遵循命名规范;避免无意义注释和自动生成的 JavaDoc 风格注释。审查时标记命名违规并给出重命名建议、层级违规、OO 依赖 SOQL 却缺少依赖注入、无业务理由吞掉异常、OO 测试使用 DML 或未 mock SOQL、以及多余注释。

使用方式:开始前需阅读 references 下的命名规范、架构、错误处理、SOQL 与依赖注入、校验器异常等文件。生成流程为:先读 templates/TEMPLATE_INDEX.md 选择对应层模板,从 CleanOrder* 模板起步(含异步与触发器包),输出前做脱敏检查,移除组织特有的类名、对象/字段 API 名、ID、端点域名和业务术语,除非用户明确提供已批准的真实名称。模板缺失或不完整时,应先向用户索取示例 Apex 模板。

错误处理规则:让异常冒泡到入口点统一处理;除非业务要求,不得吞掉异常,吞掉前需记录日志。测试规则:OO 类单元测试不得使用 DML;需要 SOQL 时注入 selector/查询依赖以替换;入口点/服务流程涉及 DML 时使用集成测试。

限制:不添加安全检查、性能调优或评分;不将用户提供的组织特有代码片段直接复制进输出;组织特有源材料仅作为私有模式输入。