1.【强制】Java 类库中定义的可以通过预检查方式规避的 RuntimeException 异常不应该通过 catch 的方式来处理,比如:NullPointerExceptionIndexOutOfBoundsException 等等。  

说明:无法通过预检查的异常除外,比如,在解析字符串形式的数字时,可能存在数字格式错误,不得不通过 catch  NumberFormatException 来实现。  

正例:if (obj != null) {...}  

反例:try { obj.method(); } catch (NullPointerException e) {…}  

2.【强制】异常捕获后不要用来做流程控制,条件控制  

说明:异常设计的初衷是解决程序运行中的各种意外情况,且异常的处理效率比条件判断方式要低很多。  

3.【强制】catch 时请分清稳定代码和非稳定代码,稳定代码指的是无论如何不会出错的代码。对于非稳定 

代码的 catch 尽可能进行区分异常类型,再做对应的异常处理。  

说明:对大段代码进行 try-catch,使程序无法根据不同的异常做出正确的应激反应,也不利于定位问题,这是一种不负 责任的表现。  

正例:用户注册的场景中,如果用户输入非法字符,或用户名称已存在,或用户输入密码过于简单,在程序上作出分门 别类的判断,并提示给用户。  

4.【强制】捕获异常是为了处理它不要捕获了却什么都不处理而抛弃之如果不想处理它请将该异常抛给它的调用者。最外层的业务使用者必须处理异常将其转化为用户可以理解的内容。  

5.【强制】事务场景中抛出异常被 catch 后如果需要回滚一定要注意手动回滚事务。  

6.【强制】finally 块必须对资源对象、流对象进行关闭有异常也要做 try-catch。  

说明:如果 JDK7,可以使用 try-with-resources 方式。  

7.【强制】不要在 finally 块中使用 return  

说明:try 块中的 return 语句执行成功后,并不马上返回,而是继续执行 finally 块中的语句,如果此处存在 return 语句, 则会在此直接返回,无情丢弃掉 try 块中的返回点。  

反例:  

private int x = 0;  
public int checkReturn() {  
try {  
	// x 等于 1,此处不返回  
return ++x;  
} finally {  
// 返回的结果是 2  
return ++x;  
} 
}  

8.【强制】捕获异常与抛异常必须是完全匹配或者捕获异常是抛异常的父类。 

说明:如果预期对方抛的是绣球,实际接到的是铅球,就会产生意外情况。  

9.【强制】在调用 RPC二方包或动态生成类的相关方法时,捕捉异常使用 Throwable 类进行拦截。  

说明:通过反射机制来调用方法,如果找不到方法,抛出 NoSuchMethodException。什么情况会抛出 NoSuchMethodError 呢?二方包在类冲突时,仲裁机制可能导致引入非预期的版本使类的方法签名不匹配,或者在 字节码修改框架(比如:ASM)动态创建或修改类时,修改了相应的方法签名。这些情况,即使代码编译期是正确 的,但在代码运行期时,会抛出 NoSuchMethodError。  

反例:足迹服务引入了高版本的 spring,导致运行到某段核心逻辑时,抛出 NoSuchMethodError 错误,catch 用的 类却是 Exception,堆栈向上抛,影响到上层业务。这是一个非核心功能点影响到核心应用的典型反例。

10.【推荐】方法的返回值可以为 null,不强制返回空集合,或者空对象等,必须添加注释充分说明什么情况下会返回 null 值。  

说明:本规约明确防止 NPE 是调用者的责任。即使被调用方法返回空集合或者空对象,对调用者来说,也并非高枕无 忧,必须考虑到远程调用失败,运行时异常等场景返回 null 的情况。  

11.【推荐】防止 NPE是程序员的基本修养注意 NPE 产生的场景:  

1)返回类型为基本数据类型,return 包装数据类型的对象时,自动拆箱有可能产生 NPE  

反例:public int method() { return Integer 对象; },如果为 null,自动解箱抛 NPE。  

2)数据库的查询结果可能为 null。  

3)集合里的元素即使 isNotEmpty,取出的数据元素也可能为 null。  

4)远程调用返回对象时,一律要求进行空指针判断,防止 NPE。  

5)对于 Session 中获取的数据,建议进行 NPE 检查,避免空指针。  

6)级联调用 obj.getA().getB().getC();一连串调用,易产生 NPE。  

正例:使用 JDK8 的 Optional 类来防止 NPE 问题。  

12.【推荐】定义时区分 unchecked / checked 异常避免直接抛出 new RuntimeException()更不允许抛出 Exception 或者 Throwable应使用有业务含义的自定义异常。推荐业界已定义过的自定义异常,如:DAOException / ServiceException 等。  

 13.【参考】对于公司外的 http / api 开放接口必须使用错误码而应用内部推荐异常抛出;跨应用间RPC 调用优先考虑使用 Result 方式,封装 isSuccess() 方法、错误码、错误简短信息;应用内部推荐异常抛出。  

 说明:关于 RPC 方法返回方式使用 Result 方式的理由:  

1)使用抛异常返回方式,调用方如果没有捕获到就会产生运行时错误。  

2)如果不加栈信息,只是 new 自定义异常,加入自己的理解的 error message,对于调用端解决问题的帮助不会太多。 如果加了栈信息,在频繁调用出错的情况下,数据序列化和传输的性能损耗也是问题。   

作者:刘冬冬  创建时间:2024-06-19 14:22
最后编辑:刘冬冬  更新时间:2024-06-26 16:33