Java 异常处理基本规则,Java异常处理的基本规范

发布于:2021-05-14 23:48:23

看了团队中原来代码中的异常处理,心碎了一地,稍微对照阿里巴巴的异常处理规范整理了一遍,准备分享一下,Java的异常处理规范&约束。


一、运行异常的扑捉

不要捕获 Java 类库中定义的继承自 RuntimeException 的运行时异常类,如:IndexOutOfBoundsException / NullPointerException ,这类异常由程序员预检查来规避,保证程序健壮性。


正例:


if(null != obj) {
//TODO
}
复制代码

反例:


try {
obj.method()
} catch(NullPointerException e){
//TODO
}
复制代码

二、 try-catch 作用域(现有代码出现率较高)

对大段代码进行try-catch ,这是不负责任的表现。catch 时请分清稳定代码和非稳定代码,稳定代码指的是无论如何不会出错的代码。对于非稳定代码的 catch 尽可能进行区分异常类型,再做对应的异常处理。


正例: 分块catch ,或者直接抛出相对应的异常,然后由下层细化处理。


map.put("status", 500);
try{
//代码省略
map.put("message", "success!");
map.put("status", 200);
} catch (UnknownHostException e) {
//域名错误
map.put("message", "请输入正确的网址");
LoggerUtils.fmtError(e, "网址异常[%s]", url);
} catch (SocketTimeoutException e) {
//超时
map.put("message", "请求地址超时");
LoggerUtils.fmtError(e, "请求地址超时[%s]", url);

} catch (Exception e) {
//其他异常
map.put("message", "请求出现未知异常,请重试!
" + e.getMessage());
LoggerUtils.fmtError(e, "请求出现未知异常,请重试![%s]", url);
}
return map;
复制代码

反例:


try {
//此处省略1024行代码
} catch(Exception e){
//TODO
}
复制代码

三、异常的捕捉 & 异常的处理(现有代码出现率较高)

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


正例:


try{
//代码省略
} catch (UnknownHostException e) {
//域名错误
map.put("message", "请输入正确的网址");
LoggerUtils.fmtError(XXXXManager.class, e, "网址异常[%s]", url);
} catch (SocketTimeoutException e) {
//超时
map.put("message", "请求地址超时");
LoggerUtils.fmtError(XXXXManager.class, e, "请求地址超时[%s]", url);

} catch (Exception e) {
//其他异常
map.put("message", "请求出现未知异常,请重试!
" + e.getMessage());
LoggerUtils.fmtError(XXXXManager.class, e, "请求出现未知异常,请重试![%s]", url);
}
复制代码

只为描述一下异常,继续抛出。


try{
//代码省略
} catch (UnknownHostException e) {
throw new HNException("xxx处理失败。",e);
}
复制代码

反例: 1.如下,调用者对异常没有任何感知。


try{
//代码省略
} catch (Exception e) {
System.out.println("插入异常");
}
复制代码

2.如下,调用者对异常无法定位和判断


try{
//代码省略
} catch (UnknownHostException e) {
throw new RuntimeException("500");
}
复制代码

四、异常 & 事务

    try 块放到了事务代码中,catch 异常后,如果需要回滚事务,一定要注意手动回滚事务。在有事务的代码中,catch 异常后,做描述异常等处理后,如果需要事务生效,请把异常继续抛出。

五、异常 & finally

1.如果有对IO 流和资源做操作,必须逐一关闭IO 流和资源对象(从里层到外层),有异常也要做处理。


try{
//代码省略
} catch (Exception e) {
throw new HNException("xxx处理失败。",e);

}finally{

try {
if(null != conn){
conn.disconnect();
}
} catch (Exception e1) {
LoggerUtils.fmtInfo("请求完毕关闭流出现异常![%s]", url);
}
try {
if(null != outStream){
outStream.close();
}
} catch (Exception e2) {
LoggerUtils.fmtInfo("请求完毕关闭流出现异常![%s]", url);
}
try {
if(null != out){
out.close();
}
} catch (Exception e3) {
LoggerUtils.fmtInfo("请求完毕关闭流出现异常![%s]", url);
}

}
复制代码

JDK 7 以上可以使用try-with-resources 方式。


六、finally & return

不能在 finally 块中使用 returnfinally 块中的 return 返回后方法结束执行,不会再执行 try 块中的 return 语句。


七、异常需要精确

捕获异常与抛异常,必须是完全匹配,或者捕获异常是抛异常的父类。如果预期对方抛的是绣球,实际接到的是铅球,就会产生意外情况。


八、程序员的基本修养 & NPE(现有代码中出现率较高)

1.方法(接口)的返回值可以为 null ,但不推荐返回空集合,或者空对象等,必须添加注释充分说明什么情况下会返回 null 值。调用方需要进行 null 判断防止 NPE 问题。


    防止 NPE ,是程序员的基本修养,注意 NPE 产生的场景。

    a.查询数据库返回null ,包括null 对象和null 集合。

    b.集合内元素有null 对象。








转载于:https://juejin.im/post/5cff44c3f265da1b5d57a208

相关推荐

最新更新

猜你喜欢