一、编程规约

咸鱼2024-09-082024-09-08

一、编程规约

1、命名规约

强制部分

1、所有编程相关命名均不能以下划线或美元符号开始，也不能以下划线或美元符号结束。

2、所有编程相关的命名严禁使用拼音与英文混合的方式，更不允许直接使用中文的方式。

3、类名使用UpperCamelCase风格，必须遵从驼峰形式，但以下情形例外：（领域模型的相关命名）DO / DTO / VO / DAO 等。

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

5、常量命名全部大写，单词间用下划线隔开，力求语义表达完整清楚，不要嫌名字长。

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

7、中括号是数组类型的一部分，数组定义如下：String[] args;

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

反例：定义为基本数据类型boolean isSuccess；的属性，它的方法也是isSuccess()，RPC 框架在反向解析的时候，“以为”对应的属性名称是success，导致属性获取不到，进而抛出异常。

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

正例：应用工具类包名为com.alibaba.mpp.util、类名为MessageUtils（此规则参考spring 的框架结构）

10、杜绝完全不规范的缩写，避免望文不知义。

反例：<某业务代码>AbstractClass“缩写”命名成AbsClass；condition“缩写”命名成 condi，此类随意缩写严重降低了代码的可阅读性。

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

正例：CacheServiceImpl 实现CacheService 接口。

参考部分

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

说明：枚举其实就是特殊的常量类，且构造方法被默认强制是私有。

正例：枚举名字：DealStatusEnum；成员名称：SUCCESS / UNKOWN_REASON。

✨2、各层命名规约：

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。

2、常量定义

强制部分

1、不允许出现任何魔法值（即未经定义的常量）直接出现在代码中。

反例： String key=”Id#taobao_”+tradeId；

cache.put(key, value);

2、long或者Long初始赋值时，必须使用大写的L，不能是小写的l，小写容易跟数字1 混淆，造成误解。

说明：Long a = 2l; 写的是数字的21，还是Long型的2?

3、格式规约

强制部分

1、大括号的使用约定。如果是大括号内为空，则简洁地写成{}即可，不需要换行；如果是非空代码块则：

左大括号前不换行。
左大括号后换行。
右大括号前换行。
右大括号后还有else等代码则不换行；表示终止右大括号后必须换行。

2、左括号和后一个字符之间不出现空格；同样，右括号和前一个字符之间也不出现空格。详见第5条下方正例提示。

3、if/for/while/switch/do 等保留字与左右括号之间都必须加空格。

4、任何运算符左右必须加一个空格。

说明：运算符包括赋值运算符=、逻辑运算符&&、加减乘除符号、三目运行符等。

5、代码块缩进4个空格，如果使用tab缩进，请设置成1个tab为4个空格。

正例：（涉及1-5点）

public static void main(String args[]) {
	// 缩进4个空格
	String say = "hello";
	// 运算符的左右必须有一个空格
	int flag = 0;
	// 关键词if与括号之间必须有一个空格，括号内f与左括号，1与右括号不需要空格
	if (flag == 0) {
		System.out.println(say);
	}
	// 左大括号前加空格且不换行；左大括号后换行
	if (flag == 1) {
		System.out.println("world");
	// 右大括号前换行，右大括号后有else，不用换行
	} else {
		System.out.println("ok");
		// 右大括号做为结束，必须换行
	}   
}

6、单行字符数限制不超过120个，超出需要换行，换行时，遵循如下原则：

换行时相对上一行缩进4个空格。
运算符与下文一起换行。
方法调用的点符号与下文一起换行。
在多个参数超长，逗号后进行换行。
在括号前不要换行，见反例。

正例：

StringBuffer sb = new StringBuffer();

//超过120个字符的情况下，换行缩进4个空格，并且方法前的点符号一起换行 sb.append(“zi”).append(“xin”)…

.append(“huang”);

反例：

StringBuffer sb = new StringBuffer();

//超过120个字符的情况下，不要在括号前换行

sb.append(“zi”).append(“xin”)…append

(“huang”);

//参数很多的方法调用也超过120个字符，逗号后才是换行处

method(args1, args2, args3, …

, argsX);

✨7、方法参数在定义和传入时，多个参数逗号后边必须加空格。

正例：下例中实参的”a”,后边必须要有一个空格。 method(“a”, “b”, “c”);

✨8、IDE的text file encoding 设置为UTF-8; IDE中文件的换行符使用Unix格式，不要使用windows格式。

4、OOP规约

强制部分

1、避免通过一个类的对象引用访问此类的静态变量或静态方法，无谓增加编译器解析成本，直接用类名来访问即可。

2、所有的覆写方法，必须加@Override注解。

✨3、相同参数类型，相同业务含义，才可以使用Java的可变参数，避免使用Object。

说明：可变参数必须放置在参数列表的最后。（提倡同学们尽量不用可变参数编程）

正例：public User getUsers(String type, Integer… ids);

✨4、对外暴露的接口签名，原则上不允许修改方法签名（即方法名、参数列表等），避免对接口调用方产生影响。接口过时必须加@Deprecated注解，并清晰地说明采用的新接口或者新服务是什么。

5、不能使用过时的类或方法。

✨6、Object的equals方法容易抛空指针异常，应使用常量或确定有值的对象来调用equals。

正例： “test”.equals(object);

反例： object.equals(“test”);

说明：推荐使用java.util.Objects#equals （JDK7 引入的工具类）

✨7、所有的相同类型的包装类对象之间值的比较，全部使用equals方法比较。

说明：对于Integer var=?在**-128至127之间的赋值，Integer对象是在IntegerCache.cache 产生，会复用已有对象，这个区间内的Integer值可以直接使用==进行判断，但是这个区间之外的所有数据，都会在堆上产生，并不会复用已有对象**，这是一个大坑，推荐使用equals方法进行判断。

✨8、关于基本数据类型与包装数据类型的使用标准如下：

1） 所有的POJO类属性必须使用包装数据类型。

2） RPC方法的返回值和参数必须使用包装数据类型。

3）所有的局部变量推荐使用基本数据类型。

RPC方法是指通过网络调用远程服务的方法或函数，它可以简化分布式系统之间的交互，让开发人员能够在不同计算机之间调用函数，就像调用本地函数一样简单直接。

说明：POJO类属性没有初值是提醒使用者在需要使用时，必须自己显式地进行赋值，任何 NPE 问题，或者入库检查，都由使用者来保证。

正例：数据库的查询结果可能是null，因为自动拆箱，用基本数据类型接收有NPE（空指针异常）风险。

反例：某业务的交易报表上显示成交总额涨跌情况，即正负x%，x为基本数据类型，调用的 RPC 服务，调用不成功时，返回的是默认值，页面显示：0%，这是不合理的，应该显示成中划线-。所以包装数据类型的null值，能够表示额外的信息，如：远程调用失败，异常退出

9、定义DO/DTO/VO等POJO类时，不要设定任何属性默认值。

反例：某业务的DO的gmtCreate默认值为new Date();但是这个属性在数据提取时并没有置入具体值，在更新其它字段时又附带更新了此字段，导致创建时间被修改成当前时间。

🎃10、序列化类新增属性时，请不要修改serialVersionUID字段，避免反序列失败；如果完全不兼容升级，避免反序列化混乱，那么请修改serialVersionUID值。

说明：注意serialVersionUID 不一致会抛出序列化运行时异常。

✨11、构造方法里面禁止加入任何业务逻辑，如果有初始化逻辑，请放在init方法中。

✨12、POJO类必须写toString方法。使用工具类source > generate toString时，如果继承了另一个POJO类，注意在前面加一下super.toString。

说明：在方法执行抛出异常时，可以直接调用POJO的toString()方法打印其属性值，便于排查问题。

5、集合处理

强制部分

✨1、Map/Set的key为自定义对象时，必须重写hashCode和equals。

正例：String重写了hashCode和equals方法，所以我们可以非常愉快地使用String对象作为key来使用。

✨2、ArrayList的subList结果不可强转成ArrayList，否则会抛出ClassCastException 异常：java.util.RandomAccessSubList cannot be cast to java.util.ArrayList ;

说明：subList 返回的是 ArrayList 的内部类 SubList，并不是 ArrayList ，而是 ArrayList 的一个视图，对于SubList子列表的所有操作最终会反映到原列表上。

3、在subList场景中，高度注意对原集合元素个数的修改，会导致子列表的遍历、增加、删除均产生ConcurrentModificationException 异常。

✨4、使用集合转数组的方法，必须使用集合的toArray(T[] array)，传入的是类型完全一样的数组，大小就是list.size()。

反例：直接使用toArray无参方法存在问题，此方法返回值只能是Object[]类，若强转其它类型数组将出现ClassCastException错误。

正例：

List list = new ArrayList(2);       
list.add("guan");       
list.add("bao");        
String[] array = new String[list.size()];       
array = list.toArray(array);

说明：使用toArray带参方法，入参分配的数组空间不够大时，toArray方法内部将重新分配内存空间，并返回新数组地址；如果数组元素大于实际所需，下标为[ list.size() ]的数组元素将被置为null，其它数组元素保持原值，因此最好将方法入参数组大小定义与集合元素个数一致。

✨5、使用工具类Arrays.asList()把数组转换成集合时，不能使用其修改集合相关的方法，它的add/remove/clear 方法会抛出UnsupportedOperationException 异常。

说明：asList的返回对象是一个Arrays内部类，并没有实现集合的修改方法。Arrays.asList 体现的是适配器模式，只是转换接口，后台的数据仍是数组。

String[] str = new String[] { “a”, “b” };

List list = Arrays.asList(str);

第一种情况：list.add(“c”); 运行时异常。

第二种情况：str[0]= “gujin”; 那么list.get(0)也会随之修改。

6、泛型通配符来接收返回的数据，此写法的泛型集合不能使用add方法。

说明：苹果装箱后返回一个对象，此对象就不能往里加任何水果，包括苹果。

🎃7、不要在foreach循环里进行元素的remove/add操作。remove元素请使用Iterator方式，如果并发操作，需要对Iterator对象加锁。

反例：

List a = new ArrayList();       
a.add("1");       
a.add("2");       
for (String temp : a) {
	if("1".equals(temp)){
		a.remove(temp);
	}
}

正例：

Iterator it = a.iterator();
while(it.hasNext()){
	String temp =  it.next();
	if(删除元素的条件){
		it.remove();
	}
}

8、在JDK7版本以上，Comparator要满足自反性，传递性，对称性，不然Arrays.sort， Collections.sort 会报 IllegalArgumentException 异常。

说明： 1）自反性：x，y的比较结果和y，x的比较结果相反。

2）传递性：x>y,y>z,则x>z。

3）对称性：x=y,则x,z比较结果和y，z比较结果相同。

反例：下例中没有处理相等的情况，实际使用中可能会出现异常：

new Comparatorr<Student>() {            
	@Override           
	public int compare(Student o1, Student o2) {               
		return o1.getId() > o2.getId() ? 1 : -1;           
	}       
}

集合类	Key	Value	Super	说明
Hashtable	不允许为null	不允许为null	Dictionary	线程安全
ConcurrentHashMap	不允许为null	不允许为null	AbstractMap	线程局部安全
TreeMap	不允许为null	允许为null	AbstractMap	线程不安全
HashMap	允许为null	允许为null	AbstractMap	线程不安全

参考部分

1、合理利用好集合的有序性(sort)和稳定性(order)，避免集合的无序性(unsort)和不稳定性(unorder)带来的负面影响。

说明：稳定性指集合每次遍历的元素次序是一定的。有序性是指遍历的结果是按某种比较规则依次排列的。如：ArrayList是order/unsort；HashMap是unorder/unsort；TreeSet 是 order/sort。

2、利用Set元素唯一的特性，可以快速对另一个集合进行去重操作，避免使用List的 contains 方法进行遍历去重操作。

6、并发处理

强制部分

1、获取单例对象要线程安全。在单例对象里面做操作也要保证线程安全。

说明：资源驱动类、工具类、单例工厂类都需要注意。

2、线程资源必须通过线程池提供，不允许在应用中自行显式创建线程。

说明：使用线程池的好处是减少在创建和销毁线程上所花的时间以及系统资源的开销，解决资源不足的问题。如果不使用线程池，有可能造成系统创建大量同类线程而导致消耗完内存或者 “过度切换”的问题。

🎃3、SimpleDateFormat 是线程不安全的类，一般不要定义为static变量，如果定义为 static，必须加锁，或者使用DateUtils工具类。

正例：注意线程安全，使用DateUtils。亦推荐如下处理：

private static final ThreadLocal<DateFormat> df = new ThreadLocal<DateFormat>() {       
	@Override        
	protected DateFormat initialValue() {            
		return new SimpleDateFormat("yyyy-MM-dd");        
	}    
};

说明：如果是JDK8的应用，可以使用instant代替Date，Localdatetime代替Calendar， Datetimeformatter 代替 Simpledateformatter，官方给出的解释：simple beautiful strong immutable thread-safe。

4、高并发时，同步调用应该去考量锁的性能损耗。能用无锁数据结构，就不要用锁；能锁区块，就不要锁整个方法体；能用对象锁，就不要用类锁。

5、对多个资源、数据库表、对象同时加锁时，需要保持一致的加锁顺序，否则可能会造成死锁。

说明：线程一需要对表A、B、C依次全部加锁后才可以进行更新操作，那么线程二的加锁顺序也必须是A、B、C，否则可能出现死锁。

6、并发修改同一记录时，避免更新丢失，要么在应用层加锁，要么在缓存加锁，要么在数据库层使用乐观锁，使用version作为更新依据。

说明：如果每次访问冲突概率小于20%，推荐使用乐观锁，否则使用悲观锁。乐观锁的重试次数不得小于3次。

7、线程并行处理定时任务时，Timer运行多个TimeTask时，只要其中之一没有捕获抛出的异常，其它任务便会自动终止运行，使用ScheduledExecutorService则没有这个问题。

✨8、线程池不允许使用Executors去创建，而是通过ThreadPoolExecutor的方式，这样的处理方式让写的同学更加明确线程池的运行规则，规避资源耗尽的风险。

说明：Executors 各个方法的弊端：

1）newFixedThreadPool 和 newSingleThreadExecutor:

主要问题是堆积的请求处理队列可能会耗费非常大的内存，甚至OOM。

2）newCachedThreadPool 和 newScheduledThreadPool:

主要问题是线程数最大数是Integer.MAX_VALUE，可能会创建数量非常多的线程，甚至OOM。

9、创建线程或线程池时请指定有意义的线程名称，方便出错时回溯。

正例：

public class TimerTaskThread extends Thread {      
	public TimerTaskThread(){          
		super.setName("TimerTaskThread"); …  
}

参考部分

1、volatile解决多线程内存不可见问题。对于一写多读，是可以解决变量同步问题，但是如果多写，同样无法解决线程安全问题。如果想取回count++数据，使用如下类实现： AtomicInteger count = new AtomicInteger(); count.addAndGet(1); count++操作如果是 JDK8，推荐使用LongAdder对象，比AtomicLong性能更好（减少乐观锁的重试次数）。

2、注意HashMap的扩容死链，导致CPU飙升的问题。

3、ThreadLocal无法解决共享对象的更新问题，ThreadLocal对象建议使用static修饰。这个变量是针对一个线程内所有操作共有的，所以设置为静态变量，所有此类实例共享此静态变量，也就是说在类第一次被使用时装载，只分配一块存储空间，所有此类的对象(只要是这个线程内定义的)都可以操控这个变量。

7、控制语句

强制部分

1、在一个switch块内，每个case要么通过break/return来终止，要么注释说明程序将继续执行到哪一个case为止；在一个switch块内，都必须包含一个default语句并且放在最后，即使它什么代码也没有。

2、在if/else/for/while/do 语句中必须使用大括号，即使只有一行代码，避免使用下面的形式：if (condition) statements;

参考部分

1、方法中需要进行参数校验的场景：

1）调用频次低的方法。

2）执行时间开销很大的方法，参数校验时间几乎可以忽略不计，但如果因为参数错误导致中间执行回退，或者错误，那得不偿失。

3）需要极高稳定性和可用性的方法。

4）对外提供的开放接口，不管是RPC/API/HTTP接口。

2、方法中不需要参数校验的场景：

1）极有可能被循环调用的方法，不建议对参数进行校验。但在方法说明里必须注明外部参数检查。

2）底层的方法调用频度都比较高，一般不校验。毕竟是像纯净水过滤的最后一道，参数错误不太可能到底层才会暴露问题。一般DAO层与Service层都在同一个应用中，部署在同一台服务器中，所以DAO的参数校验，可以省略。

3）被声明成private只会被自己代码所调用的方法，如果能够确定调用方法的代码传入参数已经做过检查或者肯定不会有问题，此时可以不校验参数。

8、注释规约

强制部分

1、类、类属性、类方法的注释必须使用javadoc规范，使用/**内容*/格式，不得使用 //xxx 方式。

说明：在IDE编辑窗口中，javadoc方式会提示相关注释，生成javadoc可以正确输出相应注释；在IDE中，工程调用方法时，不进入方法即可悬浮提示方法、参数、返回值的意义，提高阅读效率。

2、所有的抽象方法（包括接口中的方法）必须要用javadoc注释、除了返回值、参数、异常说明外，还必须指出该方法做什么事情，实现什么功能。

说明：如有实现和调用注意事项，请一并说明。

3、所有的类都必须添加创建者信息。

4、方法内部单行注释，在被注释语句上方另起一行，使用//注释。方法内部多行注释使用/* */注释，注意与代码对齐。

5、所有的枚举类型字段必须要有注释，说明每个数据项的用途。

参考部分

1、注释掉的代码尽量要配合说明，而不是简单的注释掉。

说明：代码被注释掉有两种可能性：1）后续会恢复此段代码逻辑。2）永久不用。前者如果没有备注信息，难以知晓注释动机。后者建议直接删掉（代码仓库保存了历史代码）。

2、对于注释的要求：第一、能够准确反应设计思想和代码逻辑；第二、能够描述业务含义，使别的程序员能够迅速了解到代码背后的信息。完全没有注释的大段代码对于阅读者形同天书，注释是给自己看的，即使隔很长时间，也能清晰理解当时的思路；注释也是给继任者看的，使其能够快速接替自己的工作。

3、好的命名、代码结构是自解释的，注释力求精简准确、表达到位。避免出现注释的一个极端：过多过滥的注释，代码的逻辑一旦修改，修改注释是相当大的负担。

4、特殊注释标记，请注明标记人与标记时间。注意及时处理这些标记，通过标记扫描，经常清理此类标记。线上故障有时候就是来源于这些标记处的代码。

1） 待办事宜（TODO）:（标记人，标记时间，[预计处理时间]）表示需要实现，但目前还未实现的功能。这实际上是一个javadoc的标签，目前的 javadoc 还没有实现，但已经被广泛使用。只能应用于类，接口和方法（因为它是一个javadoc 标签）。

2） 错误，不能工作（FIXME）:（标记人，标记时间，[预计处理时间]）在注释中用FIXME标记某代码是错误的，而且不能工作，需要及时纠正的情况。

9、其他

强制部分

1、在使用正则表达式时，利用好其预编译功能，可以有效加快正则匹配速度。

说明：不要在方法体内定义：Pattern pattern = Pattern.compile(规则);

2、避免用Apache Beanutils进行属性的copy。

说明：Apache BeanUtils 性能较差，可以使用其他方案比如Spring BeanUtils, Cglib BeanCopier。

3、velocity调用POJO类的属性时，建议直接使用属性名取值即可，模板引擎会自动按规范调用POJO的getXxx()，如果是boolean基本数据类型变量（注意，boolean命名不需要加is前缀），会自动调用isXxx()方法。

说明：注意如果是Boolean包装类对象，优先调用getXxx()的方法。

4、后台输送给页面的变量必须加$!{var}——中间的感叹号。

说明：如果var=null或者不存在，那么${var}会直接显示在页面上。

5、注意 Math.random() 这个方法返回是double类型，注意取值范围 0≤x<1（能够取到零值，注意除零异常），如果想获取整数类型的随机数，不要将x放大10的若干倍然后取整，直接使用Random对象的nextInt或者nextLong方法。

6、获取当前毫秒数：System.currentTimeMillis(); 而不是new Date().getTime();

说明：如果想获取更加精确的纳秒级时间值，用System.nanoTime。在JDK8中，针对统计时间等场景，推荐使用Instant类。

一、编程规约

一、编程规约

一、编程规约

1、命名规约

强制部分

推荐部分

参考部分

2、常量定义

强制部分

推荐部分

3、格式规约

强制部分

推荐部分

4、OOP规约

强制部分

推荐部分

5、集合处理

强制部分

推荐部分

参考部分

6、并发处理

强制部分

推荐部分

参考部分

7、控制语句

强制部分

推荐部分

参考部分

8、注释规约

强制部分

推荐部分

参考部分

9、其他

强制部分

推荐部分

咸鱼