SuperAPI AI 工具集

java-conventions

编程与开发

查看项目

更新于 10-16 05:47

技能介绍

用途:在 Java 项目中统一编码习惯与注释要求,在不引入过度设计的前提下保证一致性与可维护性。

主要能力:

  1. 日志规范:统一使用 SLF4J 并结合 Lombok 注解(如 @Slf4j),禁止 System.out.println 与 printStackTrace(),日志避免敏感信息与大对象全量输出。
  2. Bean/Lombok 注解:领域/DTO/VO/BO 按需选 @Getter/@Setter/@Builder/@Data;需可控 equals/hashCode/toString 时显式选择注解组合,避免一把梭;序列化或频繁日志输出时注意 toString 的敏感与大字段。
  3. 判空与防御式编程:优先用 JDK 工具 Objects.requireNonNull、Objects.nonNull、Optional;不用全局 try/catch 吞异常掩盖空指针,应在边界校验输入。
  4. 工具类优先级:Spring → Apache Commons → Hutool → Guava;已有依赖满足时不引入新依赖,同类工具统一团队选择。
  5. 设计与拆分:复杂逻辑用设计模式(策略、模板方法、责任链等)提升可扩展性与可测试性;简单逻辑避免过度设计与拆分;业务规则尽量收敛到领域对象/领域服务,避免贫血模型堆在 ServiceImpl。
  6. 注释规范:创建或更新对象/方法时检查并补全对象与方法注释;非最简单 CRUD 的方法按逻辑块补充注释说明关键意图与边界条件;Controller、Service、ServiceImpl、Mapper 均需注释且与代码一致。

使用方式:先判断改动范围,仅改当前涉及的类/方法,不做无关格式化;统一基础规范(日志、判空、工具类、Bean 注解);再做注释检查;最后编译加测试通过后提交。Review/改造交付时列出已调整的规范点、受影响文件清单与验证方式。

适用场景:Java 项目的编码规范落地、代码评审与改造。

限制与注意:需注意框架版本与依赖库兼容性、配置文件格式、环境变量设置、依赖冲突(可用 lock 文件锁定版本)及大数据量下的性能问题(如 N+1 查询)。更完整的注释模板与检查清单见 references/api_reference.md。