SuperAPI AI 工具集

java-coding-standards

编程与开发

查看项目

更新于 10-16 05:50

技能介绍

用途:为 Spring Boot 项目提供 Java 17+ 编码规范,适用于编写或评审 Java 代码、统一命名与不可变性、处理 record/密封类/模式匹配、评审 Optional/流/泛型,以及组织包与项目结构。

核心原则:清晰优先于取巧;默认不可变,减少共享可变状态;快速失败并抛出有意义的异常;命名与包结构保持一致。

主要能力:命名方面,类与 record 用 PascalCase,方法/字段用 camelCase,常量用 UPPER_SNAKE_CASE。不可变性方面,优先 record 与 final 字段,只提供 getter。Optional 方面,find* 方法返回 Optional,使用 map/flatMap 而非 get()。流方面,用流做转换并保持管道简短。异常方面,领域错误用非受检异常,技术异常附加上下文,定义领域专属异常。泛型方面,避免原生类型,可使用有界泛型。项目结构按 Maven/Gradle 组织 config、controller、service、repository、domain、dto、util 等包,测试目录与主目录对应。

使用方式:作为编码与评审时的检查清单,按命名、不可变性、异常、Optional、泛型、结构逐项对照;日志使用 SLF4J,参数化写法如 log.info("fetch_market slug={}", slug)。测试建议 JUnit 5 + AssertJ + Mockito,保持确定性,无隐藏 sleep。

限制:资料未提供具体工具集成、自动检查配置、安装命令、收费与价格信息,暂未提供。