类命名
使用大驼峰命名形式
| 场景 | 约束 | 示例 |
|---|---|---|
| 抽象类 | Abstract/Base开头 | BaseUserService |
| 枚举类 | Enum作为后缀 | GenderEnum |
| 工具类 | Utils作为后缀 | StringUtils |
| 异常类 | Exception作为后缀 | RuntimeException |
| 接口实现类 | 接口名+Impl | UserServiceImpl |
| 设计模式相关类 | Builder,Factory等 | 使用设计模式时,需要使用相对应的设计模式作为后缀 ThreadFactory |
| 特定功能类 | Handler,Predicate,Validator | 表示处理器,校验器和断言 |
| 特定层级的类 | Controller,Service,Dao | UserController,UserDao |
| 特定层级的值对象 | AO,Param,VO,Config,Message | Param调用入参 AO为返回对象 VO为通用值对象 config配置类 Message消息 |
| 测试类 | 以Test结尾 | UserServiceTest,表示用来测试哪一个接口 |
方法命名
采用小驼峰的形式命名,最好见名知意
| 场景 | 约束 | 示例 |
|---|---|---|
| 返回真伪值 | is/can/has/needs/should | isValid/canRemove |
| 用于检查 | ensure/validate | ensureCapacity/ validateInputs |
| 按需执行 | try/orElse | tryCreate/getOrDefault |
| 数据相关 | get/search save/update batchSave/batchUpdate saveOrUpdate/select insert/update/delete |
getUserById |
| 生命周期 | initialize/pause stop/destory |
onPause |
