Java开发规范-编程规范之命名风格

最新推荐文章于 2021-11-18 15:41:29 发布

李思净

最新推荐文章于 2021-11-18 15:41:29 发布

阅读量229

点赞数

分类专栏： Java

本文链接：https://blog.csdn.net/jikui0581/article/details/104391819

版权

Java 专栏收录该内容

35 篇文章 0 订阅

订阅专栏

Java编程规约（命名风格）

内容源自阿里巴巴Java开发手册（华山版）

命名风格

【强制】代码命名中均不能以 _ 或 $ 开始或结束。
- 【反例】：_name、 $name 、 name_ 、 name$
- 【推荐】：命名中不要包含_和$
【强制】代码中命名严禁出现拼音与英文混合方式，更不允许直接使用中文和纯拼音模式。
- 【说明】：正确的英文拼写和语法可以让代码更容易理解，避免歧义。
【强制】类名使用UpperCamelCase风格，以下情形例外：DO/BO/DTO/VO/AO/PO/UID等。
【强制】方法名、参数名、成员变量、局部变量都统一使用lowerCamelCase风格，必须遵从驼峰形式。
【强制】常量命名全部大写，单词间用下划线隔开，力求语义表达完整清楚，不要嫌名字长。
【强制】抽象类命名使用Abstract或Base开头；异常类命名使用Exception结尾；测试类命名以它要测试的类的名称开始，以Test结尾。
【强制】类型与中括号紧挨相连来表示数组。
- 【正例】
```
int[] arrayDemo;
```
【强制】POJO类中布尔类型变量都不要加is前缀，否则部分框架解析会引起序列化错误。
- 【说明】：在本文MySQL规约中的建表约定第一条，表达是与否的值采用is_xxx的命名方式，所以，需要在设置从is_xxx到xxx的映射关系。
- 【反例】：定义为基本数据类型Boolean isDeleted的属性，它的方法也是isDeleted()，RPC框架在反向解析的时候，“误以为”对应的属性名称是deleted，导致属性获取不到，进而抛出异常。
【强制】包名统一使用小写，点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用单数形式，但是类名如果有复数含义，类名可以使用复数形式

【强制】避免在子父类的成员变量之间、或者不同代码块的局部变量之间采用完全相同的命名，使可读性降低。

【反例】

public class ConfusingName { 
	public int age; 
	// 非setter/getter的参数名称，不允许与本类成员变量同名 
	public void getData(String alibaba) { 
		if(condition) { 
			final int money = 531; 
			// ... 
		} 
		for (int i = 0; i < 10; i++) { 
			// 在同一方法体中，不允许与其它代码块中的money命名相同 
			final int money = 615; 
			// ... 
		} 
	} 
} 

class Son extends ConfusingName { 
	// 不允许与父类的成员变量名称相同 
	public int age; 
}

【强制】杜绝完全不规范的缩写，避免望文不知义
【推荐】为了达到代码自解释的目标，任何自定义编程元素在命名时，使用尽量完整的单词组合来表达其意。
【推荐】在常量与变量的命名时，表示类型的名词放在词尾，以提升辨识度。
- 【正例】startTime / workQueue / nameList / TERMINATED_THREAD_COUNT
【推荐】如果模块、接口、类、方法使用了设计模式，在命名时需体现出具体模式，有利于阅读者快速理解架构设计理念。
- 【正例】
```
public class OrderFactory; 
public class LoginProxy; 
public class ResourceObserver;
```
【推荐】接口类中的方法和属性不要加任何修饰符号（public 也不要加），保持代码的简洁性，并加上有效的Javadoc注释。尽量不要在接口里定义变量，如果一定要定义变量，肯定是与接口方法相关，并且是整个应用的基础常量。
- 【正例】
```
接口方法签名 void commit(); 
接口基础常量 String COMPANY = "alibaba";
```
【推荐】接口和实现类的命名有两套规则：
- 【强制】对于Service和DAO类，基于SOA的理念，暴露出来的服务一定是接口，内部的实现类用Impl的后缀与接口区别。
- 【推荐】如果是形容能力的接口名称，取对应的形容词为接口名（通常是–able的形容词）。
【参考】枚举类名带上Enum后缀，枚举成员名称需要全大写，单词间用下划线隔开。
【参考】各层命名规约
- Service/DAO层方法命名规约
  1. 获取单个对象的方法用get做前缀。
  2. 获取多个对象的方法用list做前缀，复数形式结尾如：listObjects。
  3. 获取统计值的方法用count做前缀。
  4. 插入的方法用save/insert做前缀。
  5. 删除的方法用remove/delete做前缀。
  6. 修改的方法用update做前缀。
- 领域模型命名规约
  1. 数据对象：xxxDO，xxx即为数据表名。
  2. 数据传输对象：xxxDTO，xxx为业务领域相关的名称。
  3. 展示对象：xxxVO，xxx一般为网页名称。
  4. POJO是DO/DTO/BO/VO的统称，禁止命名成xxxPOJO。