工程开发
java-coding-standards avatar

java-coding-standards

强制执行高质量 Java 17+ 编码标准、Spring Boot 惯例以及可维护的项目架构。

简介

Java Coding Standards 技能为编写、审查和维护 Spring Boot 服务中的干净、可扩展代码提供了完整的框架。专为使用 Java 17 或更高版本的开发人员设计,它确保了命名惯例、异常处理和现代语言功能使用的统一性。通过优先考虑清晰度和不变性,此技能可帮助团队减少技术债务并建立更强大、可观察的后端系统。无论您是构建新的微服务还是重构旧组件,此工具都能作为自动化架构指南,确保代码保持地道、类型安全且适合生产环境。

  • 强制执行严格的类、记录和方法命名惯例,以及清晰的 PascalCase 和 camelCase 标准。

  • 通过鼓励使用 Java records、final 字段以及避免共享可变状态来提升不变性。

  • 提供现代 Java 功能的最佳实践,包括有效的 Optional 处理、Stream 管道和模式匹配。

  • 指导 Maven 和 Gradle 项目结构,将其划分为 config、controller、service、repository 和 dto 等逻辑领域。

  • 设定明确的错误管理期望,优先使用领域特定的未检查异常和有意义的日志模式。

  • 支持与 JUnit 5、AssertJ 和 Mockito 的集成,以促进确定性、流畅且易于维护的单元测试。

  • 在开发过程中,使用此技能根据标准项目结构验证方法签名和包配置。

  • 输入您的代码片段或拉取请求,以获取有关长参数列表、深度嵌套或魔术数字等反模式的反馈。

  • 在同行评审中将此作为基准,以确保 Bean Validation、nullable 注解和依赖注入的一致使用。

  • 此技能强调 Java 17+ 功能;旧版本可能需要进行特定调整。本技能假设采用标准 Spring Boot 生态系统;自定义框架可能需要进行微小的配置调整以符合建议的项目配置。

仓库统计

Star 数
170,586
Fork 数
26,440
Open Issue 数
153
主要语言
JavaScript
默认分支
main
同步状态
空闲
最近同步时间
2026年4月30日 10:39
在 GitHub 查看