java-coding-standards
Installation
SKILL.md
Java 编码规范 (Java Coding Standards)
适用于 Spring Boot 服务中可读、可维护的 Java (17+) 代码规范。
何时激活 (When to Activate)
- 在 Spring Boot 项目中编写或评审 Java 代码时
- 强制执行命名、不可变性(immutability)或异常处理约定时
- 使用 records、密封类(sealed classes)或模式匹配(pattern matching)(Java 17+)时
- 评审 Optional、流(streams)或泛型(generics)的使用时
- 规划包结构和项目布局时
核心原则 (Core Principles)
- 清晰度优先于技巧性
- 默认不可变;尽量减少共享的可变状态
- 快速失败(Fail fast)并提供有意义的异常信息
- 保持命名和包结构的一致性