程序编写规范之编程规约

最新推荐文章于 2023-08-14 21:08:26 发布

康明

最新推荐文章于 2023-08-14 21:08:26 发布

阅读量429

点赞数 1

分类专栏：编程规约

本文链接：https://blog.csdn.net/qq_25094457/article/details/105233266

版权

编程规约专栏收录该内容

2 篇文章 0 订阅

订阅专栏

此文目的：无规矩不成方圆，无规范难以协同

对代码来说，适当的规范和标准绝不是消灭代码内容的创造性、优雅性，而是限制过度个性化，以一种普遍认可的统一方式一起做事，提升协作效率，降低沟通成本。代码的字里行间流淌的是软件系统的血液，质量的提升是尽可能少踩坑，杜绝踩重复的坑，切实提升系统稳定性，码出质量。
根据内容，细分成若干二级子目录。另外，依据约束力强弱及故障敏感性，规约依次分为强制、推荐、参考三大类。在延伸信息中，“说明”对规约做了适当扩展和解释；“正例”提倡什么样的编码和实现方式；“反例”说明需要提防的雷区，以及真实的错误案例。
参考阿里巴巴Java开发手册（华山版）

命名风格

1. 【强制】代码中的命名均不能以下划线或美元符号开始，也不能以下划线或美元符号结束。
	反例：_name / __name / $name / name_ / name$ / name__
2. 【强制】代码中的命名严禁使用拼音与英文混合的方式，更不允许直接使用中文的方式。
	说明：正确的英文拼写和语法可以让阅读者易于理解，避免歧义。注意，纯拼音命名方式更要避免采用。
	正例：renminbi / alibaba / taobao / youku / hangzhou 等国际通用的名称，可视同英文。
	反例：DaZhePromotion [打折] / getPingfenByName() [评分] / int 某变量 = 3
3. 【强制】方法名、参数名、成员变量、局部变量都统一使用 lowerCamelCase 风格，必须遵从驼峰形式。
	正例： localValue / getHttpMessage() / inputUserId 
4. 【强制】常量命名全部大写，单词间用下划线隔开，力求语义表达完整清楚，不要嫌名字长。
	正例：MAX_STOCK_COUNT / CACHE_EXPIRED_TIME
	反例：MAX_COUNT / EXPIRED_TIME
5. 【强制】抽象类命名使用 Abstract 或 Base 开头；异常类命名使用 Exception 结尾；测试类命名以它要测试的类的
		  名开始，以 Test 结尾。
6. 【强制】类型与中括号紧挨相连来表示数组。
	正例：定义整形数组 int[] arrayDemo;
	反例：在 main 参数中，使用 String args[]来定义。
7. 【强制】包名统一使用小写，点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用单数形式，但是类名如果有复数含义，
		  类名 可以使用复数形式。
	正例：应用工具类包名为 com.alibaba.ai.util、类名为 MessageUtils（此规则参考 spring 的框架结构）
8. 【强制】杜绝完全不规范的缩写，避免望文不知义。
	反例：AbstractClass“缩写”命名成 AbsClass；condition“缩写”命名成 condi，此类随意缩写严重降低了代码的可阅读性。
9. 【推荐】为了达到代码自解释的目标，任何自定义编程元素在命名时，使用尽量完整的单词
组合来表达其意。
	正例：在 JDK 中，表达原子更新的类名为：AtomicReferenceFieldUpdater。
	反例：int a 的随意命名方式。
10. 【推荐】在常量与变量的命名时，表示类型的名词放在词尾，以提升辨识度。
	正例：startTime / workQueue / nameList / TERMINATED_THREAD_COUNT
	反例：startedAt / QueueOfWork / listName / COUNT_TERMINATED_THREAD
11. 【参考】枚举类名带上 Enum 后缀，枚举成员名称需要全大写，单词间用下划线隔开。
	说明：枚举其实就是特殊的类，域成员均为常量，且构造方法被默认强制是私有。
	正例：枚举名字为 ProcessStatusEnum 的成员名称：SUCCESS / UNKNOWN_REASON。
12. 【参考】各层命名规约：
	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。

常量定义

1. 【强制】不允许任何魔法值 （ 即未经预先定义的常量 ） 直接出现在代码中。
   反例：String key = "Id#taobao_" + tradeId;
   cache.put(key, value);
   // 缓存 get 时，由于在代码复制时，漏掉下划线，导致缓存击穿而出现问题
2. 【强制】在 long 或者 Long 赋值时，数值后使用大写的 L，不能是小写的 l，小写容易跟数字 1 混淆，造成误解。
   说明：Long a = 2l; 写的是数字的 21，还是 Long 型的 2。
3. 【推荐】不要使用一个常量类维护所有常量，要按常量功能进行归类，分开维护。
   说明：大而全的常量类，杂乱无章，使用查找功能才能定位到修改的常量，不利于理解和维护。
   正例：缓存相关常量放在类 CacheConsts 下；系统配置相关常量放在类 ConfigConsts 下。
4. 【推荐】常量的复用层次有五层：跨应用共享常量、应用内共享常量、子工程内共享常量、包内共享常量、类内共享常量。
   1） 跨应用共享常量：放置在二方库中，通常是 client.jar 中的 constant 目录下。
   2） 应用内共享常量：放置在一方库中，通常是子模块中的 constant 目录下。
   反例：易懂变量也要统一定义成应用内共享常量，两位工程师在两个类中分别定义了“YES”的变量：
   	类 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 定义。
   5. 【推荐】如果变量值仅在一个固定范围内变化用 enum 类型来定义。
   说明：如果存在名称之外的延伸属性应使用 enum 类型，下面正例中的数字就是延伸信息，表示一年中的第几个季节。
正例：
   public enum SeasonEnum 
   {
   	SPRING(1), SUMMER(2), AUTUMN(3), WINTER(4);
   	private int seq;
   	SeasonEnum(int seq)
   	 {
   	this.seq = seq;
   	}
   public int getSeq()
    {
   return seq;
   }
}

代码格式

1. 【强制】如果是大括号内为空，则简洁地写成{}即可，大括号中间无需换行和空格；如果是非空代码块则：
  	1） 左大括号前不换行。
  	2） 左大括号后换行。
  	3） 右大括号前换行。
  	4） 右大括号后还有 else 等代码则不换行；表示终止的右大括号后必须换行。
2. 【强制】左小括号和字符之间不出现空格 ； 同样，右小括号和字符之间也不出现空格；而左大括号前需要空格。详见第 5 条提示。
  	反例：if (空格 a == b 空格)
3. 【强制】if/for/while/switch/do 等保留字与括号之间都必须加空格。
4. 【强制】任何二目、三目运算符的左右两边都需要加一个空格。
  	说明：运算符包括赋值运算符=、逻辑运算符&&、加减乘除符号等。
5. 【强制】采用 4 个空格缩进，禁止使用 tab 字符。
  	说明：如果使用 tab 缩进，必须设置 1 个 tab 为 4 个空格。IDEA 设置 tab 为 4 个空格时，请勿勾选 Use tab character；
  		而在 eclipse 中，必须勾选 insert spaces for tabs。
  	正例： （涉及 1-5 点）
  	public static void main(String[] args)
  	 {
  		// 缩进 4 个空格
  		String say = "hello";
  		// 运算符的左右必须有一个空格
  		int flag = 0;
  		// 关键词 if 与括号之间必须有一个空格，括号内的 f 与左括号，0 与右括号不需要空格
  		if (flag == 0)
  		 {
  		System.out.println(say);
  		}
  	
  		// 左大括号前加空格且不换行；左大括号后换行
  		if (flag == 1) 
  		{
  			System.out.println("world");
  		// 右大括号前换行，右大括号后有 else，不用换行
  		} 
  		else
  		 {
  			System.out.println("ok");
  	// 在右大括号后直接结束，则必须换行
  		}
  	 }
6. 【强制】注释的双斜线与注释内容之间有且仅有一个空格。
  	正例：
  	// 这是示例注释，请注意在双斜线之后有一个空格
  	String param = new String();
7. 【强制】在进行类型强制转换时，右括号与强制转换值之间不需要任何空格隔开。
  	正例：
  	long first = 1000000000000L;
  	int second = (int)first + 2;
8. 【强制】单行字符数限制不超过 120 个，超出需要换行，换行时遵循如下原则：
  	1）第二行相对第一行缩进 4 个空格，从第三行开始，不再继续缩进，参考示例。
  	2）运算符与下文一起换行。
  	3）方法调用的点符号与下文一起换行。
  	4）方法调用中的多个参数需要换行时，在逗号后进行。
  	5）在括号前不要换行，见反例。
正例：
  	StringBuilder sb = new StringBuilder();
  	// 超过 120 个字符的情况下，换行缩进 4 个空格，点号和方法名称一起换行
  	sb.append("Jack").append("Ma")...
  			.append("alibaba")...
  			.append("alibaba")...
  			.append("alibaba");
反例：
  	StringBuilder sb = new StringBuilder();
  	// 超过 120 个字符的情况下，不要在括号前换行
  	sb.append("Jack").append("Ma")...append
  	("alibaba");
  	
  	// 参数很多的方法调用可能超过 120 个字符，不要在逗号前换行
  	method(args1, args2, args3, ...
  		, argsX);
9. 【强制】方法参数在定义和传入时，多个参数逗号后边必须加空格。
  正例：下例中实参的 args1，后边必须要有一个空格。
  	method(args1, args2, args3);
10. 【强制】IDE 的 text file encoding 设置为 UTF-8; IDE 中文件的换行符使用 Unix 格式，不要使用 Windows 格式。
11. 【推荐】单个方法的总行数不超过 80 行。
说明：除注释之外的方法签名、左右大括号、方法内代码、空行、回车及任何不可见字符的总行数不超过80 行。
  	正例：代码逻辑分清红花和绿叶，个性和共性，绿叶逻辑单独出来成为额外方法，使主干代码更加清晰；共性逻辑抽取成为共性方法，
  		 便于复用和维护。
12. 【推荐】没有必要增加若干空格来使变量的赋值等号与上一行对应位置的等号对齐。
  	正例：
  	int one = 1;
  	long two = 2L;
  	float three = 3F;
  	StringBuilder sb = new StringBuilder();
  	说明：增加 sb 这个变量，如果需要对齐，则给 one、two、three 都要增加几个空格，在变量比较多的情况下，是非常累赘的事情。
13. 【推荐】不同逻辑、不同语义、不同业务的代码之间插入一个空行分隔开来以提升可读性。
  	说明：任何情形，没有必要插入多个空行进行隔开。

控制语句

1. 【强制】在一个 switch 块内，每个 case 要么通过 continue/break/return 等来终止，要么注释说明程序将继续执行到
           哪一个 case 为止；在一个 switch 块内，都必须包含一个default 语句并且放在最后，即使它什么代码也没有。
  	说明：注意 break 是退出 switch 语句块，而 return 是退出方法体。
2. 【强制】当 switch 括号内的变量类型为 String 并且此变量为外部参数时，必须先进行 null判断。
  	反例：猜猜下面的代码输出是什么？
  	public class SwitchString
  	 {
  		public static void main(String[] args)
  		 {
  			method(null);
  		}
  		
  		public static void method(String param)
  		 {
  				switch (param) {
  						// 肯定不是进入这里
  						case "sth":
  								System.out.println("it's sth");
  								break;
  						// 也不是进入这里
  						case "null":
  								System.out.println("it's null");
  								break;
  						// 也不是进入这里
  						default:
  								System.out.println("default");
  					}
  			}
  	}
3. 【强制】在 if / else / for / while / do 语句中必须使用大括号。
  	说明：即使只有一行代码，避免采用单行的编码方式：if (condition) statements;
4. 【强制】在高并发场景中，避免使用”等于”判断作为中断或退出的条件。
  	说明：如果并发控制没有处理好，容易产生等值判断被“击穿”的情况，使用大于或小于的区间判断条件来代替。
  	反例：判断剩余奖品数量等于 0 时，终止发放奖品，但因为并发处理错误导致奖品数量瞬间变成了负数，这样的话，活动无法终止。
5. 【推荐】表达异常的分支时，少用 if-else 方式 ，这种方式可以改写成：
  	if (condition)
  	 {
  				...
  				return obj;
  	}
  	// 接着写 else 的业务逻辑代码;
  	说明：如果非使用 if()...else if()...else...方式表达逻辑，避免后续代码维护困难，【强制】请勿超过 3 层。
  	正例：超过 3 层的 if-else 的逻辑判断代码可以使用卫语句、策略模式、状态模式等来实现，其中卫语句即代码逻辑先考虑失
  		 败、异常、中断、退出等直接返回的情况，以方法多个出口的方式，解决代码中判断分支嵌套的问题，这是逆向思维的体现。
  	示例如下：
  	public void findBoyfriend(Man man)
  	 {
  			if (man. isUgly() ) 
  			{
  				System.out.println("本姑娘是外貌协会的资深会员");
  				return;
  			}
  			
  			if (man. isPoor() ) 
  			{
  					System.out.println("贫贱夫妻百事哀");
  					return;
  			}
  				
  			if (man. isBadTemper() )
  			{
  				System.out.println("银河有多远，你就给我滚多远");
  				return;
  			}
  			
  			System.out.println( "可以先交往一段时间看看" );
  	}
6. 【推荐】除常用方法（如 getXxx/isXxx ）等外，不要在条件判断中执行其它复杂的语句，将复杂逻辑判断的结果赋值给一个
    	   有意义的布尔变量名，以提高可读性。
  	说明：很多 if 语句内的逻辑表达式相当复杂，与、或、取反混合运算，甚至各种方法纵深调用，理解成本非常高。如果赋值
  		一个非常好理解的布尔变量名字，则是件令人爽心悦目的事情。
  	正例：
  	// 伪代码如下
  	final boolean existed = (file.open(fileName, "w") != null) && (...) || (...);
  	if (existed) 
  	{
  	...
  	}
  	反例：
  	public final void acquire(long arg)
  	 {
  			if (!tryAcquire(arg) &&
  				acquireQueued(addWaiter(Node.EXCLUSIVE), arg)) 
  				{
  					selfInterrupt();
  				}
  	}
7. 【推荐】不要在其它表达式（尤其是条件表达式）中，插入赋值语句。
说明：赋值点类似于人体的穴位，对于代码的理解至关重要，所以赋值语句需要清晰地单独成为一行。
  	反例：
  	public Lock getLock(boolean fair) 
  	{
  		// 算术表达式中出现赋值操作，容易忽略 count 值已经被改变
  		threshold = (count = Integer.MAX_VALUE) - 1;
  		// 条件表达式中出现赋值操作，容易误认为是 sync==fair
  		return (sync = fair) ? new FairSync() : new NonfairSync();
  	}
8. 【推荐】循环体中的语句要考量性能，以下操作尽量移至循环体外处理，如定义对象、变量、获取数据库连接，进行不必要的
           try - catch 操作 （ 这个 try - catch 是否可以移至循环体外 ） 。
9. 【推荐】避免采用取反逻辑运算符。
  	说明：取反逻辑不利于快速理解，并且取反逻辑写法必然存在对应的正向逻辑写法。
  	正例：使用 if (x < 628) 来表达 x 小于 628。
  	反例：使用 if (!(x >= 628)) 来表达 x 小于 628。
10. 【推荐】接口入参保护，这种场景常见的是用作批量操作的接口。
11. 【参考】下列情形，需要进行参数校验：
  	1） 调用频次低的方法。
  	2） 执行时间开销很大的方法。此情形中，参数校验时间几乎可以忽略不计，但如果因为参数错误导致中间执行回退，
  		或者错误，那得不偿失。
  	3） 需要极高稳定性和可用性的方法。
  	4） 对外提供的开放接口，不管是 RPC/API/HTTP 接口。
  	5） 敏感权限入口。
12. 【参考】下列情形，不需要进行参数校验：
  	1） 极有可能被循环调用的方法。但在方法说明里必须注明外部参数检查要求。
  	2） 底层调用频度比较高的方法。毕竟是像纯净水过滤的最后一道，参数错误不太可能到底层才
  		会暴露问题。一般 DAO 层与 Service 层都在同一个应用中，部署在同一台服务器中，所以 DAO 
  		的参数校验，可以省略。
  	3） 被声明成 private 只会被自己代码所调用的方法，如果能够确定调用方法的代码传入参数已
  		经做过检查或者肯定不会有问题，此时可以不校验参数。

其他

1. 【推荐】 任何数据结构的构造或初始化，都应指定大小，避免数据结构无限增长吃光内存。
2. 【推荐】 及时清理不再使用的代码段或配置信息。
	说明： 对于垃圾代码或过时配置，坚决清理干净，避免程序过度臃肿，代码冗余。
	正例： 对于暂时被注释掉，后续可能恢复使用的代码片断，在注释代码上方，统一规定使用三个斜杠(///) 来说明注释掉代码的理由。

线程相关

1. 【强制】 获取单例对象需要保证线程安全，其中的方法也要保证线程安全。
   说明： 资源驱动类、工具类、单例工厂类都需要注意。
2. 【强制】 创建线程或线程池时请指定有意义的线程名称，方便出错时回溯。
   正例： 自定义线程工厂，并且根据外部特征进行分组，比如机房信息。
3. 【强制】 SimpleDateFormat 是线程不安全的类，一般不要定义为 static 变量，如果定义为static，必须
    加锁，或者使用 DateUtils 工具类。
4. 【强制】 高并发时，同步调用应该去考量锁的性能损耗。能用无锁数据结构，就不要用锁；
   	能锁区块，就不要锁整个方法体； 能用对象锁，就不要用类锁。
   说明： 尽可能使加锁的代码块工作量尽可能的小，避免在锁代码块中调用 RPC 方法。
5. 【强制】 对多个资源、数据库表、对象同时加锁时，需要保持一致的加锁顺序，否则可能会造成死锁。
   说明： 线程一需要对表 A、 B、 C 依次全部加锁后才可以进行更新操作，那么线程二的加锁顺序也必须是
   A、 B、 C，否则可能出现死锁。
6. 【强制】 在使用阻塞等待获取锁的方式中，必须在 try 代码块之外，并且在加锁方法与 try 代码块之间没有任何可能抛出
   异常的方法调用，避免加锁成功后，在 finally 中无法解锁。
   说明一： 如果在 lock 方法与 try 代码块之间的方法调用抛出异常，那么无法解锁，造成其它线程无法成功获取锁。
   说明二： 如果 lock 方法在 try 代码块之内，可能由于其它方法抛出异常，导致在 finally 代码块中，unlock 对未加锁
   		   的对象解锁，它会调用 AQS 的 tryRelease 方法（取决于具体实现类），抛出IllegalMonitorStateException 异常。
   说明三： 在 Lock 对象的 lock 方法实现中可能抛出 unchecked 异常，产生的后果与说明二相同。
7. 【强制】 在使用尝试机制来获取锁的方式中，进入业务代码块之前，必须先判断当前线程是否持有锁。锁
   		    的释放规则与锁的阻塞等待方式相同。
   	说明： Lock 对象的 unlock 方法在执行时，它会调用 AQS 的 tryRelease 方法（取决于具体实现类），如果
   		  当前线程不持有锁，则抛出 IllegalMonitorStateException 异常。
8.【参考】 volatile 解决多线程内存不可见问题。对于一写多读，是可以解决变量同步问题，但是如果多写，同样
   			无法解决线程安全问题。

康明

关注

1
点赞
踩
2

收藏

觉得还不错? 一键收藏
0
评论
程序编写规范之编程规约

此文目的：无规矩不成方圆，无规范难以协同对软件来说，适当的规范和标准绝不是消灭代码内容的创造性、优雅性，而是限制过度个性化，以一种普遍认可的统一方式一起做事，提升协作效率，降低沟通成本。代码的字里行间流淌的是软件系统的血液，质量的提升是尽可能少踩坑，杜绝踩重复的坑，切实提升系统稳定性，码出质量。本文划分为七个知识点编程规约、异常日志、单元测试、安全规约、MySQL 数据库、工程结构、设计规约...
复制链接

扫一扫