Spring Boot编程规范涵盖了多个方面，旨在提高代码的可读性、可维护性和可扩展性。以下是一些关键的Spring Boot编程规范：
一、项目结构与命名规范
-
项目结构：
- 应按照功能模块进行划分，如controller、service、mapper、entity、config等，确保代码结构清晰。
- 应遵循清晰、简洁的原则，便于团队成员理解和维护。
- 通常包括
src/main/java（存放Java源代码）、src/main/resources（存放资源文件如配置文件、静态资源等）、src/test/java（存放测试代码）等目录。
-
命名规范：
- 类名应使用驼峰命名法，且为名词性。
- 变量和方法名也应使用驼峰命名法。
- 常量名应全大写，单词间用下划线分隔。
- 包名应使用小写字母，且遵循域名的反向路径命名法。
二、代码规范
-
注释：
- 每个公开的方法应有Javadoc风格的注释，描述方法的目的、参数、返回值和可能抛出的异常。
- 类和成员变量应有简洁明了的注释。
- 代码中的复杂逻辑应有相应的注释解释。
-
入参校验：
- 应使用Spring的
@Valid注解和JSR 303规范中定义的注解（如@NotNull、@Size、@Min等）进行入参校验。
-
数据库交互：
- 应使用JPA或MyBatis进行数据库操作，避免在业务逻辑代码中硬编码SQL语句。
- 尽量避免使用
nativeQuery = true，以提高代码的可读性和可维护性。
-
日志记录：
- 应使用SLF4J和Logback等日志框架进行日志记录。
- 日志记录应包含必要的信息，如时间戳、线程名、日志级别、日志消息等。
三、配置规范
-
配置文件：
- 应统一使用
application.yml或application.properties配置文件。
- 配置文件应包含必要的参数设置，如数据库连接信息、服务器端口等。
- 应为不同环境（如开发、测试、生产）准备不同的配置文件。
-
自动配置：
- 应充分利用Spring Boot的自动配置功能，减少手动配置的工作量。
- 如需修改默认配置，应在配置文件中指定相应的参数。
四、API与文档规范
-
API设计：
- 应遵循RESTful风格设计API接口。
- 应使用HTTP方法（如GET、POST、PUT、DELETE等）来表示对资源的操作。
-
文档生成：
- 应使用Springdoc或Swagger等工具生成API文档。
- API文档应包含接口的描述、参数说明、返回值说明等信息。
五、异常处理规范
-
全局异常处理：
- 应使用
@ControllerAdvice和@ExceptionHandler进行全局异常处理。
- 异常处理应返回标准的错误格式和HTTP状态码。
-
自定义异常：
- 应根据需要定义自定义异常类，并为其编写相应的异常处理方法。
六、测试规范
-
单元测试：
- 应为每个业务功能编写相应的单元测试。
- 应使用JUnit或其他测试框架进行单元测试。
-
集成测试：
- 应进行必要的集成测试，以确保各个模块之间的协同工作正常。