阿⾥命名规范
【强制】代码中的命名均不能以下划线或美元符号开始，也不能以下划线或美元符号结束。 反例：_name / __name / O b j e c t / n a m e / n a m e Object / name_ / name Object/name/n ame / Object$
【强制】代码中的命名严禁使⽤拼⾳与英⽂混合的⽅式，在使⽤中尽量使⽤英⽂，遇到不会的百度嘛。更不允许直接使⽤中⽂的⽅式。 说明：正确的英⽂拼写和语法可以让阅读者易于理解，避免歧义。注意，即使纯拼⾳命名⽅式 也要避免采⽤。 正例：alibaba / taobao / youku / hangzhou 等国际通⽤的名称，可视同英⽂。 反例：DaZhePromotion [打折] / getPingfenByName() [评分] / int 某变量 = 3【强制】类名使⽤ UpperCamelCase 风格，即必须遵从驼峰形式，但以下情形例外：DO / BO / DTO / VO / AO 正例：MarcoPolo / UserDO / XmlService / TcpUdpDeal / TaPromotion 反例：macroPolo / UserDo / XMLService / TCPUDPDeal / TAPromotion 【强制】⽅法名、参数名、成员变量、局部变量都统⼀使⽤ lowerCamelCase 风格，必须遵从 驼峰形式。 正例： localValue / getHttpMessage() / inputUserId
【强制】常量命名全部⼤写，单词间⽤下划线隔开，⼒求语义表达完整清楚，不要嫌名字长。
正例：MAX_STOCK_COUNT 反例：MAX_COUNT
【强制】抽象类命名使⽤ Abstract 或 Base 开头；异常类命名使⽤ Exception 结尾；测试类 命名以它要测试的类的名称开始，以 Test 结尾。
【强制】中括号是数组类型的⼀部分，数组定义如下：String[] args; 反例：使⽤ String args[]的⽅式来定义。
【强制】POJO 类中布尔类型的变量，都不要加 is，否则部分框架解析会引起序列化错误。 反例：定义为基本数据类型 Boolean isDeleted；的属性，它的⽅法也是 isDeleted()，RPC框架在反向解析的时候，“以为”对应的属性名称是 deleted，导致属性获取不到，进⽽抛出异常。
【强制】包名统⼀使⽤⼩写，点分隔符之间有且仅有⼀个⾃然语义的英语单词。包名统⼀使⽤ 单数形式，但是类名如果有复数含义，类名可以使⽤复数形式。 正例： 应⽤⼯具类包名为 com.alibaba.open.util、类名为 MessageUtils（此规则参考 spring 的框架结构）抽象类的使用
【强制】杜绝完全不规范的缩写，避免望⽂不知义。 反例：AbstractClass“缩写”命名成 AbsClass；condition“缩写”命名成condi，此类随 意缩写严重降低了代码的可阅读性。
【推荐】为了达到代码⾃解释的⽬标，任何⾃定义编程元素在命名时，使⽤尽量完整的单词 组合来表达其意。 正例：从远程仓库拉取代码的类命名为 PullCodeFromRemoteRepository。 反例：变量 int a; 的随意命名⽅式。
【推荐】如果模块、接⼝、类、⽅法使⽤了设计模式，在命名时体现出具体模式。 说明：将设计模式体现在名字中，有利于阅读者快速理解架构设计理念。 正例：public class OrderFactory; public class LoginProxy; public class ResourceObserver;
【推荐】接⼝类中的⽅法和属性不要加任何修饰符号（public 也不要加），保持代码的简洁 性，并加上有效的 Javadoc 注释。尽量不要在接⼝⾥定义变量，如果⼀定要定义变量，肯定是 与接⼝⽅法相关，并且是整个应⽤的基础常量。 正例：接⼝⽅法签名：void f(); 接⼝基础常量表⽰：String COMPANY = “alibaba”; 反例：接⼝⽅法定义：public abstract void f(); 说明：JDK8 中接⼝允许有默认实现，那么这个 default ⽅法，是对所有实现类都有价值的默 认实现。
接⼝和实现类的命名有两套规则： 1）【强制】对于 Service 和 DAO 类，基于 SOA 的理念，暴露出来的服务⼀定是接⼝，内部 的实现类⽤ Impl 的后缀与接⼝区别。 正例：CacheServiceImpl 实现 CacheService 接⼝。 2）
【推荐】 如果是形容能⼒的接⼝名称，取对应的形容词做接⼝名（通常是–able 的形式）。 正例：AbstractTranslator 实现Translatable。
【参考】枚举类名建议带上 Enum 后缀，枚举成员名称需要全⼤写，单词间⽤下划线隔开。 说明：枚举其实就是特殊的常量类，且构造⽅法被默认强制是私有。
正例：枚举名字为 ProcessStatusEnum 的成员名称：SUCCESS / UNKOWN_REASON。
【参考】各层命名规约：
A) Service/DAO 层⽅法命名规约
1） 获取单个对象的⽅法⽤ get 做前缀。
2） 获取多个对象的⽅法⽤ list 做前缀。
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。
⼀.命名风格
1.包名：全部使⽤⼩写，点分隔符之间有且仅有⼀个单词
2.类名：驼峰式命名，不能使⽤拼⾳
i.测试类以测试类开头，以Test结尾;
ii.异常类以Exception结尾;
iii.抽象类以Abstract或Base开头。
iv.⼯⼚类以Factory结尾
v.公共类以Command结尾
vi.枚举类型以Enum结尾，成员变量全部⼤写，单词之间以_隔开，
vii.常数类以Constant结尾
3.⽅法名：⾸字母⼩写, 其他单词⾸字母⼤写
i.获取单个对象使⽤get-
ii.获取多个对象使⽤list-
iii.获取统计值使⽤count-
iv.插⼊使⽤insert-/save-
v.删除使⽤remove-/delete-
vi.修改使⽤update-
vii.manage 中的⽅法和字段不要加任何修饰符(public也不要加，保持代码的整洁性)
viii.对于Service和Dao层的实现类，使⽤Impl后缀;
对于形容能⼒的接⼝，其实现类推荐使⽤-able后缀。 AbstractTranslate -- Translatable
4.成员变量名：⾸字母⼩写其他单词⾸字母⼤写，不能以_与$开始(杜绝不规范缩写，最好使⽤完整的单词，尽量不要缩写)
VO(view object, 值对象, 出参)，DTO(data transfer object, 数据传输对象, ⼊参)，
BO(business， 业务对象)，DO(domain, 领域对象)， AO()，PO(持久对象)
i.-DO ：数据表名对象以DO结尾
ii.-DTO : ⾮查询⼊参以DTO结尾
iii.-Query : 查询类⼊参以Query结尾
iv.-VO : 出参以VO结尾
v.常量使⽤全⼤写，单词之间⽤_分隔

版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。