Java开发手册-1

最新推荐文章于 2024-04-18 10:58:32 发布

weixin_42583701

最新推荐文章于 2024-04-18 10:58:32 发布

阅读量494

点赞数

文章标签： java 开发语言

本文链接：https://blog.csdn.net/weixin_42583701/article/details/130380382

版权

Java开发手册-1

编程规约
- 命名风格
- 常量定义

编程规约

命名风格

【强制】所有编程相关的命名均不能以下划线或美元符号开始，也不能以下划线或美元符号结束。
反例：_name/_name/$Object/name_/name$/Object$
【强制】所有编程相关的命名严禁使用拼音与英文混合的方式，更不允许直接使用中文的方式。
说明：正确的英文拼写和语法可以让阅读者易于理解，避免歧义。注意，即使纯拼音命名方式也要避免采用。
正例：ali/alibaba/taobao/kaikeba/aliyun/youku/hangzhou等国际通用的名称，可视同英文。
反例：DaZhePromotion【打折】/getPingfenByName()【评分】/String fw【福娃】/int变量名=3
【强制】类名使用 UpperCamelCase风格，以下情形例外：DO/PO/DTO/BO/VO/UID 等。
正例：ForceCode/UserDO/HtmlDTO/XmIService/TopUdpDeal/TaPromotion
反例：forcecode/UserDo/HTMLDto/XMLService/TCPUDPDeal/TAPromotion
【强制】方法名、参数名、成员变量、局部变量都统一使用lowerCamelCase风格。
正例：localValue/getHttpMessage()/inputUserld
【强制】常量命名应该全部大写，单词间用下划线隔开，力求语义表达完整清楚，不要嫌名字长。
正例：MAX_STOCK_COUNT/CACHE_EXPIRED_TIME
反例：MAX_COUNT/EXPIRED_TIME
【强制】抽象类命名使用Abstract或Base开头；异常类命名使用Exception结尾，测试类命名以它要测试的类的名称开始，以Test结尾。
【强制】类型与中括号紧挨相连来定义数组。
正例：定义整形数组int[] arrayDemo。
反例：在main参数中，使用String args[]来定义。
【强制】POJO类中的任何布尔类型的变量，都不要加is前缀，否则部分框架解析会引起序列化错误。
反例：定义为布尔类型Boolean isDeleted的字段（它的getter方法也是isDeleted()，部分框架在反向解析时，“误以为"对应的字段名称是deleted，导致字段获取不到，得到意料之外的结果或抛出异常。）
【强制】包名统一使用小写，点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用单数形式，但是类名如果有复数含义，类名可以使用复数形式。
正例：应用工具类包名为com.alibaba.ei.kunlun.aap.util类名为MessageUtils（此规则参考spring的框架结构）。
【强制】避免在子父类的成员变量之间、或者不同代码块的局部变量之间采用完全相同的命名，使可理解性降低。
说明：子类、父类成员变量名相同，即使是public也是能够通过编译，而局部变量在同一方法内的不同代码块中同名也是合法的，但是要避免使用。对于非setter/getter的参数名称也要避免与成员变量名称相同。
反例：

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

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

【强制】杜绝完全不规范的英文缩写，避免望文不知义。
反例：AbstractClass"缩写"成AbsClass；condition“缩写”成condi；Function“缩写”成Fu，此类随意缩写严重降低了代码的可阅读性。
【推荐】为了达到代码自解释的目标，任何自定义编程元素在命名时，使用完整的单词组合来表达。
正例：在JDK中，对某个对象引用的volatile字段进行原子更新的类名为AtomicReferenceFieldUpdater。
反例：常见的方法内变量为int a；的定义方式。
【推荐】在常量与变量命名时，表示类型的名词放在词尾，以提升辨识度。
正例：startTime/workQueue/nameList/TERMINATED_THREAD_COUNT
反例：startedAt/QueueOfWork/listName/COUNT_TERMINATED_THREAD
【推荐】如果模块、接口、类、方法使用了设计模式，在命名时要体现出具体模式。
说明：将设计模式体现在名字中，有利于阅读者快速理解架构设计思想。
正例：public class OrderFactory； public class LoginProxy;public class ResourceObserver;
【推荐】接口类中的方法和属性不要加任何修饰符号（public也不要加），保持代码的简洁性，并加上有效的Javadoc注释。尽量不要在接口里定义常量，如果一定要定义，最好确定该常量与接口的方法相关，并且是整个应用的基础常量。
正例：接口方法签名void commit()；接口基础常量String COMPANY = "alibaba"；
反例：接口方法定义public abstract void commit()；
说明：JDK8中接口允许有默认实现，那么这个default方法，是对所有实现类都有价值的默认实现。
接口和实现类的命名有两套规则：
1、【强制】对于Service和DAO类，基于SOA的理念，暴露出来的服务一定是接口，内部的实现类用Impl的后缀与接口区别。
正例：CacheServicelmpl实现CacheService接口。
2、【推荐】如果是形容能力的接口名称，取对应的形容词为接口名（通常是-able结尾的形容词）。
正例：AbstractTranslator实现Translatable。
【参考】枚举类名带上Enum后缀，枚举成员名称需要全大写，单词间用下划线隔开。
说明：枚举其实就是特殊的常量类，且构造方法被默认强制是私有。
正例：枚举名字为ProcesstatusEnum的成员名称：SUCCESS/UNKNOWN_REASON
【参考】命名规约：
(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。

常量定义

【强制】不允许任何魔法值（即未经预先定义的常量）直接出现在代码中。
反例：

//开发者A定义了缓存的key。 
String key = "ld#taobao_" + tradeld;
cache.put(key, value);
//开发者B使用缓存时直接复制少了下划线，即key是"Id#taobao"+tradeld，导致出现故障。 String key =
"ld#taobao" + tradeld; 
cache.get(key);

【强制】long或Long赋值时，数值后使用大写L，不能是小写I，小写容易跟数字混淆，造成误解。
说明：public static final Long NUM = 21;写的是数字的21，还是Long型的2？
11.【强制】浮点数类型的数值后缀统一为大写的D或F。正例：
```
static final float WEIGHT = 150.3F; ```
```
【推荐】不要使用一个常量类维护所有常量，要按常量功能进行归类，分开维护。
说明：大而全的常量类，杂乱无章，使用查找功能才能定位到要修改的常量，不利于理解，也不利于维护。
正例：缓存相关常量放在类CacheConsts下；系统配置相关常量放在类SystemConfigConsts下。
【推荐】常量的复用层次有五层：跨应用共享常量、应用内共享常量、子工程内共享常量、包内共享常量、类内共享常量。
1、跨应用共享常量：放置在二方库中，通常是client.jar中的constant目录下。
2、应用内共享常量：放置在一方库中，通常是子模块中的constant目录下。
反例：易懂常量也要统一定义成应用内共享常量，两个程序员在两个类中分别定义了表示“是”的常量：
类A中：public static final String YES = "yes"；
类B中：public static final String YES = "y"；
A.YES.equals(B.YES)，预期是true，但实际返回为false，导致线上问题。
3、子工程内部共享常量：即在当前子工程的constant目录下。
4、包内共享常量：即在当前包下单独的constant目录下。
5、类内共享常量：直接在类内部private static final定义。
【推荐】如果变量值仅在一个固定范围内变化用 enum类型来定义。
说明：如果存在名称之外的延伸属性应使用 enum类型，下面正例中的数字就是延伸信息，表示一年中的第几个季节。
正例：

public enum SeasonEnum{ 
	SPRING(1), SUMMER(2), AUTUMN(3), WINTER(4);
		private int seq;
		SeasonEnum(int seq) {
			thisseq=seq;
        }
        
	public int getSeq() {
		return seq;
	}
}

weixin_42583701

关注

0
点赞
踩
1

收藏

觉得还不错? 一键收藏
0
评论
Java开发手册-1

【强制】不允许任何魔法值（即未经预先定义的常量）直接出现在代码中。//开发者A定义了缓存的key。//开发者B使用缓存时直接复制少了下划线，即key是"Id#taobao"+tradeld，导致出现故障。【强制】long或Long赋值时，数值后使用大写L，不能是小写I，小写容易跟数字混淆，造成误解。写的是数字的21，还是Long型的2？11.【强制】浮点数类型的数值后缀统一为大写的D或F。```【推荐】不要使用一个常量类维护所有常量，要按常量功能进行归类，分开维护。
复制链接

扫一扫