开发规范

CRMEB JAVA单商户开发规范

目录与文件

目录命名

全小写，使用包名结构（如 com/zbkj/admin），路径分隔符与包名一致。

若需分隔单词，使用小写+连字符（如 src/main/java、src/main/resources）。

文件命名

类文件：与类名一致，采用大驼峰法（如 UserService.java）。

配置文件：全小写，单词间用横线分隔（如 application-prod.yml）。

资源文件：全小写，使用连字符（如 error.properties）。

类与接口

类名

大驼峰法（首字母大写），如 UserController、OrderService。

避免冗余后缀（如 UserService 而非 UserServiceImpl，除非实现类需要明确区分）。

接口名

大驼峰法，直接描述能力（如 UserRepository）。

枚举与注解

枚举名：枚举(Enum)类是一种特殊的类，其命名规范遵循普通类的命名约束条件，首字母大写，采用驼峰命名法；枚举类中定义的值的名称遵循常量的命名规范，且枚举值的名称需要与类名有一定的关联性如 EnumYly）。

注解名：大驼峰法，如 @ ApiModelProperty。

方法、属性与变量

方法命名

小驼峰法（首字母小写），动词开头，如 getUserInfo()。

布尔方法使用 is/has 前缀（如 isValid()、hasPermission()）。

属性与变量

小驼峰法，如 userName、orderList。

避免单字符命名（循环变量除外，如 for (int i = 0; …)）。

常量

全大写+下划线，如 MAX_RETRY_COUNT、DEFAULT_TIMEOUT。

数据库与ORM映射

表名与字段

全小写+下划线（如 user_profile 表，created_at 字段）。

实体类字段名使用小驼峰法，通过注解映射如 JPA 的 @ Column(name = “created_at”)）。

ORM 规范

实体类名与表名一致（如表 user → 类 User）。

避免在字段名中使用数据库保留字（如 desc → 改用 description）。