Spring Boot 项目命名与开发规范

目录和文件

• 模块目录使用小写加中划线（kebab-case），例如：user-service、order-api。
• Java 包名全部小写，建议采用反域名命名规则，例如：com.example.project.module。
• 类的文件名与类名保持一致，采用驼峰法命名（首字母大写），例如：UserController.java。
• 配置文件使用小写和中划线命名，例如：application-dev.yml。

类、接口、方法和属性命名

• 类命名采用大驼峰命名法（首字母大写），例如：UserService、OrderRepository。
• 接口命名以功能名 + 后缀 Interface 或省略后缀，例如：PaymentService。
• 方法命名采用小驼峰命名法（首字母小写），例如：getUserById()、saveOrder()。
• 属性命名采用小驼峰命名法，例如：userName、orderList。
• 常量命名使用全大写字母加下划线，例如：MAX_RETRY_COUNT。

数据库命名规范

• 数据表和字段命名使用小写字母加下划线，例如：user_account、order_id。
• 表名建议使用复数形式，字段名应简洁明了。
• 避免使用驼峰、中文或特殊符号。

配置和环境变量

• 配置参数统一使用小写字母加中划线，例如：driver-class-name、maximum-pool-size。
• 静态常量使用大写字母加下划线，例如：SPRING_PROFILES_ACTIVE。

代码结构与规范

• 控制器层：处理 HTTP 请求，命名建议以 Controller 结尾。
• 服务层：处理业务逻辑，命名建议以 Service 结尾。
• 持久层：数据库操作，命名建议以Mapper 结尾。
• 避免在控制器中直接操作数据库，所有数据库操作应通过 Service -> Mapper 层完成。

安全规范

• 使用 Spring Security 进行权限校验。
• 避免拼接 SQL，应使用 MyBatis 的参数绑定功能。
• 所有用户输入必须校验（使用 @Valid、@Validated）。
• 敏感数据（如密码）应加密存储，例如使用 BCrypt。

注释规范

• 类、方法、复杂逻辑块应添加清晰的注释。

• 使用 Javadoc 风格注释，例如：

  /**
   * 根据 ID 获取用户信息
   * @param userId 用户ID
   * @return 用户信息
   */
  public User getUserById(Long userId) { ... }
  

• 注释应与代码保持同步更新。

编码规范

• 遵循 Google Java Style 或阿里巴巴 Java 开发规范。
• 每行代码长度不超过 120 字符。
• 使用四个空格缩进，不使用制表符（Tab）。
• 避免魔法值，统一使用常量替代。