1、命名均不以下划线或美元符号开始,也不以下划线或美元符号结束。
2、命名禁用拼音与英文混合的方式,不直接使用中文的方式。(hangzhou等国际通用名称可视同英文)
3、类名使用UpperCamelCase风格,方法名、参数名、成员变量、局部变量都统一使用lowerCamelCase风格,必须遵从驼峰形式。
4、常量命名全部大写,单词间用下划线隔开,力求语义表达完整清楚。
5、抽象类命名使用 Abstract 或 Base 开头;异常类命名使用 Exception 结尾;测试类命名以它要测试的类的名称开始,以 Test 结尾。
6、类型与中括号紧挨相连来表示数组。(定义整数型数组int[] arrayDemo;)
7、POJO{(Plain Ordinary Java Object)简单的Java对象}类中布尔类型变量都不要加 is 前缀。
8、包名统一使用小写,点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用单数形式,但是类名如果有复数含义,类名可以使用复数形式。
9、子父类的成员变量之间、或者不同代码块的局部变量之间采用不相同的命名。
10、使用规范缩写,避免望文不知义。
11、在常量与变量的命名时,表示类型的名词放在词尾;如果模块、接口、类、方法使用了设计模式,在命名时需体现出具体模式。
12、对于 Service 和 DAO 类,基于 SOA 的理念,暴露出来的服务一定是接口,内部的实现类用Impl 的后缀与接口区别。(CacheServiceImpl 实现 CacheService 接口)。
13、形容能力的接口名称取对应的形容词为接口名(通常是-able的形容词)。
14、枚举(枚举其实就是特殊的类,域成员均为常量,且构造方法被默认强制是私有)类名带上 Enum 后缀,枚举成员名称需要全大写,单词间用下划线隔开。(枚举名字为 ProcessStatusEnum 的成员名称:SUCCESS / UNKNOWN_REASON)
15、各层命名规约:
A) Service/DAO 层方法命名规约
1) 获取单个对象的方法用 get 做前缀。
2) 获取多个对象的方法用 list 做前缀,复数形式结尾如:listObjects。
3) 获取统计值的方法用 count 做前缀。
4) 插入的方法用 save/insert 做前缀。
5) 删除的方法用 remove/delete 做前缀。
6) 修改的方法用 update 做前缀。
B) 领域模型命名规约
1) 数据对象:xxxDO,xxx 即为数据表名。
2) 数据传输对象:xxxDTO,xxx 为业务领域相关的名称。
3) 展示对象:xxxVO,xxx 一般为网页名称。
4) POJO 是 DO/DTO/BO/VO 的统称,禁止命名成 xxxPOJO
Java中常见的对象类型简述(DO、BO、DTO、VO、AO、PO):比如我们一张表有100个字段,那么对应的PO就有100个属性。但是我们界面上只要显示10个字段,客户端用WEB service来获取数据,没有必要把整个PO对象传递到客户端,这时我们就可以用只有这10个属性的DTO来传递结果到客户端,这样也不会暴露服务端表结构.到达客户端以后,如果用这个对象来对应界面显示,那此时它的身份就转为VO。(转自:https://blog.youkuaiyun.com/uestcyms/article/details/80244407)
编程规约-命名风格
最新推荐文章于 2025-05-07 23:42:43 发布