命名规范

1.代码中的命名均不能以下划线或美元符号开始，也不能以下划线或美元符号结束

 

2.代码中的命名严禁使用拼音与英文混合的方式，更不允许直接使用中文的方式

 

3.类名使用UpperCamelCase风格，必须遵从驼峰形式，但以下情形例外：(领域模型的相关命名) DO/BO/DTO/VO

例如：正确：UserDO

　　　错误：UserDo

VO（View Object）用于表示一个与前端进行交互的视图对象，把某个指定页面或组件的所有数据封装起来

DTO（Data Transfer Object）用于表示一个数据传输对象，通常用于展示层Controller和服务层Service之间的数据传输对象

DO（Data Object）持久化对象，它跟持久层Dao的数据结构形成一一对应的映射关系

BO（Business Object）业务对象，就是从现实世界中抽象出来的有形或者无形的业务实体

 

4.方法名、参数名、成员变量、局部变量都统一使用lowerCamelCase风格，必须遵守驼峰形式

　　inputUserId

 

5.常量命名全部大写，单词间用下划线隔开，尽量让语义表达清楚，不要害怕名字长

 

6.抽象类命名使用Abstract或Base开头，异常类使用Exception结尾，测试类以它要测试的类的名称开始，以Test结尾

 

7.中括号是数组类型的一部分，数组应定义为String[] args;如果定义为String args[]，不会报错，但是禁止使用。

 

8.POJO类中布尔类型的变量，都不要加is命名，否则部分框架解析会引起序列化错误

　　例如boolean isSuccess;方法也是isSuccess()，RPC框架在反向解析的时候，以为对应的属性名称是success，导致属性获取不到

 

9.包名统一使用小写，点分隔符之间有且仅有一个自然语义的英语单词，包名统一使用单数形式，但是类名如果有复数含义，可以使用复数形式

　　例如：工具类包名：com.alibaba.open.util、类名为：MessageUtils

 

10.不要有不规范的缩写，防止望文不知义

 

11.如果使用了设计模式，推荐在类名中体现出具体模式

　　例如：public class OrderFactory;工厂模式　　public class LoginProxy;代理模式

 

12.接口类中的方法和属性不要加任何修饰符号(public也不要加)，保持代码简洁，加上Javadoc注释。尽量不要在接口里定义变量

　　例如：Integer count();定义的方法　　String COMPANY = "alibaba";定义的属性

 

13.接口和实现类的命名有两套规则

　　1.对于Service和DAO类，基于SOA的理念，暴露出来的服务一定是接口，内部的实现类用Impl的后缀与接口区别　　

　　　　例如　　CacheServiceImpl实现CacheService接口

　　2.如果是形容能力的接口名称，取对应的形容词作接口名

　　　　例如　　AbstractTranslator实现Translatable

 

14.枚举类名建议带上Enum后缀，枚举成员名称需要全大写，单词间用下划线隔开

　　枚举类名：DealStatusEnum　　成员名称：SUCCESS/UNKNOWN_REASON

 

15.各部分命名规范

　　Service/DAO层方法命名规范

　　1.获取单个对象的方法用get做前缀

　　2.获取多个对象的方法用list做前缀

　　3.获取统计值的方法用count做前缀

　　4.插入的方法用save(推荐)或insert做前缀

　　5.删除的方法用remove(推荐)或delete做前缀

　　6.修改的方法用update做前缀

　　领域模型命名规范

　　1.数据对象：xxxDO，xxx是数据表名

　　2.