Java Conventions

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

使用流程

• 先判断改动范围：仅改动当前涉及的类/方法，不做无关格式化。
• 先统一基础规范：日志、判空、工具类选择、Bean 注解策略。
• 再做注释检查：对象注释、方法注释、逻辑块注释（非简单 CRUD）。
• 最后验证：编译 + 测试通过后再提交。

编码规范

日志规范（必选）

• 统一使用 SLF4J，并结合 Lombok 注解（例如 @Slf4j）。
• 禁止 System.out.println、printStackTrace()。
• 日志内容避免敏感信息与大对象全量输出。

示例：