java-coding-guide-pro

Java 编码指南

面向日常 Java 开发的编码约定助手。每条规则含「✗ 禁止 → ✓ 推荐 → 为什么」，覆盖 JDK 8~25+（LTS 锚定：8/11/17/21/25）。

三条铁律

1. 栈中立：库的选择跟随项目既有依赖，本指南不强加任何库；Spring 项目优先 Spring 生态自带能力（Jackson / RestTemplate / WebClient / SLF4J）。
2. 一域一默认：每个场景只给唯一推荐（以项目既有栈为准），不列举「或 A 或 B」制造决策疲劳。
3. 版本门控：先确认目标 JDK，高版本特性按门控使用——JDK 8 项目严禁 var/record/switch 表达式/文本块/sealed/虚拟线程。

第 0 步：栈探测与适配（激活时先执行）

读 pom.xml / build.gradle 一次性探测（读不到则一次问全，勿分多轮）：

1. 目标 JDK：maven.compiler.release / `` / sourceCompatibility；读不到问用户「目标 JDK 版本是（8 / 11 / 17 / 21 / 25）？」。
2. 已有栈：Spring 系（自带 Jackson/RestTemplate/WebClient/SLF4J）、Hutool、commons-lang3、Guava、Gson/Fastjson、OkHttp、Lombok、MapStruct。
3. 三条适配规则：
   • 项目已有对应能力的库 → 跟随既有库，不另引、不混用（一个项目一套字符串/集合工具）；仅当既有库缺该能力时补引，并在代码注释标注混用原因。
   • 高风险能力缺失且任务确实需要（见「高风险场景」表）→ 触发 C-CHECK 询问是否引入。
   • 低风险能力缺失（判空/集合/随机数/日期等）→ 直接用 JDK 原生，零打断、不询问。

JDK 版本策略（五档 LTS 语义）

• JDK 8（下限）：可用 Optional/Stream/java.time/CompletableFuture/Lambda。禁 var/record/switch 表达式/文本块/sealed/虚拟线程/Stream.toList()。
• JDK 11：+ var(10)、JDK HttpClient(11)。
• JDK 17：+ switch 表达式(14)、文本块(15)、record(16)、sealed(17)、Stream.toList()(16)、instanceof 模式匹配(16)。
• JDK 21：+ 虚拟线程、switch 模式匹配、SequencedCollection、record 模式。
• JDK 25：+ 22–24 转正特性（未命名变量 _、Stream Gatherers、Scoped Values 等）；虚拟线程不再被 synchronized 钉住（JEP 491）。

LTS 锚定：门控只标 LTS；22–24 转正特性统一归入 25；preview/incubator 不纳入。详细门控见 references/09-modern-java.md。

高风险场景优先成熟构件（本指南的核心立场）

以下场景手写极易出 bug，优先用成熟构件（顺序：项目既有库 > JDK 原生成熟 API > 推荐引入）：

低风险场景（判空、集合新建/分块、随机数、日期格式化）：项目有 Hutool / commons-lang3 就用其工具方法，没有就 JDK 原生（Objects/String.isBlank(11+)/List.of(9+)/ThreadLocalRandom/java.time），不触发任何询问。

域 → 默认（项目无既有方案时；已有同类库按第 0 步跟随）

生成对应域代码前，先读「详见」列的 reference 文件：含该域完整的「✗ 禁止 → ✓ 推荐 → 为什么」规则、API 速查与 antipattern，本文规则表只是其摘要。

规则表（S/A 分级）

执行规则：

• S 级（bug/事故级）：新代码禁止；审查/修改时发现既有代码命中 → 立即向用户提出改写。
• A 级（风格约定）：仅约束新生成代码；不主动改写用户既有代码、不发起任何询问；工具方法按第 0 步跟随既有栈。

C-CHECK 询问（仅高风险能力缺失时触发）

触发条件：任务确实需要加密/哈希/密码（项目无 crypto 能力）或 Bean 映射（无 MapStruct/Hutool），才向用户询问；低风险场景永不询问。

• 询问要点（一次问全，可与第 0 步的 JDK 提问合并）：说明场景与推荐构件 → 给出坐标（下表）→ 两个选项：A) 引入并使用库；B) 不引入，手写实现。
• 用户拒绝 → 受控降级：手写实现但按对应 reference（references/07-crypto.md / references/06-object-mapping.md）的 antipattern 保留守卫（如 hex 必须 %02x 补零；密码场景禁无盐并再次建议引入），并在代码注释标注这是受控降级。

其他构件参考版本（JDK 8~25 兼容，仅在项目无同类库且确需时引入）：MapStruct 1.5.5.Final（需 annotation processor）、Jackson 2.17.1、OkHttp3 4.12.0、Lombok 1.18.34、SLF4J 2.0.13（JDK 8 用 1.7.36）+ Logback。

Sonar S3252 与 Hutool 门面（StrUtil.isBlank 等会命中）：默认保留 StrUtil 等门面写法，不主动改写；仅当项目门禁启用该规则且阻断时，才全局换 CharSequenceUtil 或配置规则例外，禁混用、禁逐处 NOSONAR，详见 references/01-null-and-string.md。

使用流程

1. 第 0 步栈探测：目标 JDK + 已有栈，确定本次的工具选型基线。
2. 定位并阅读 reference：查「域 → 默认」路由表，生成对应域代码前先读「详见」列文件（含该域完整规则与 antipattern，本文规则表仅是摘要）。
3. 生成代码遵循规则表：S 级禁止项不出现；A 级约定用于新代码；审查/修改时 S 级命中既有代码 → 提出改写。
4. 高风险能力缺失 → 触发 C-CHECK 询问，拒绝则受控降级。
5. 输出前对 S 级规则逐项自检（尤其线程池、日期、金额、加密、随机数当序号、异常处理）。

版本与范围

• Hutool 5.8.x（最新稳定 5.8.47，API 对照官方 javadoc 核实）；JDK 8 为下限，门控见 references/09-modern-java.md。
• 去重原则：一个项目一套字符串/集合工具，不混用。已有 commons-lang3 → 用其 StringUtils/ObjectUtils，仅当缺该能力（如 BCrypt、DateUtil）才补对应 Hutool 模块并注释混用原因；已有 Hutool → 不再加 commons-lang3。