一、命名风格
1、代码中的命名均不能以下划线或美元符号开始或结束
2、严禁以拼音与英文混合的方式命名，不允许使用中文命名，避免采用纯拼音命名
3、除BO、DTO、TO、VO、AO、PO等情况外，类名都要使用首字母大写的驼峰式命名法
4、方法名、参数名、成员变量、局部变量都使用首字母小写的驼峰式命名法
5、常量命名全部大写，单词间用下划线隔开，语义表达要完整
6、❗️抽象类名使用Abstract或Base开头，
- 异常类使用Exception结尾，
- 测试类以要测试的类名开头，以Test结尾
7、❗️定义数组，采用类型与中括号紧挨的方式
8、❗️POJO类中布尔类型都不要以is作为前缀
9、❗️包名统一用小写，每个点分隔符之间只有一个自然语义的单词，
- 包名使用单数形式
- 类名可以使用复数形式
10、杜绝不规范缩写
11、命名时尽量使用完整语义的单词组合
12、❗️模块、接口、类、方法中有使用到设计模式的，命名时体现具体模式
13、❗️接口类中的方法和属性不要加任何修饰符号，public也不要加不要在接口里定义变量，（定义变量，肯定是 与接口方法相关，并且是整个应用的基础常量。）
14、❗️接口和实现类的命名:
- 对于 Service 和 DAO 类，基于 SOA 的理念，暴露出来的服务一定是接口，内部的实现类用 Impl 的后缀与接口区别。
- 如果是形容能力的接口名称，取对应的形容词为接口名(通常是–able 的形式)。
15、❗️枚举类名带上 Enum 后缀，枚举成员名称需要全大写，单词间用下划线隔开
16、各层命名:
- Service/DAO层方法命名：
获取单个对象的方法用get做前缀
获取多个对象的方法用list做前缀
获取统计值的方法用count做前缀
插入的方法用save/insert做前缀
删除的方法用remove/delete做前缀
修改的方法用update做前缀 - ❗️领域模型的命名：
数据对象：xxxDO
数据传输对象：xxxDTO
展示对象：xxxVO
POJO是统称，不要最为后缀。
网友评论