一、尽量不要使用 e.printStackTrace(),而是使用 log 打印。
反例:
try { // do what you want } catch (Exception e) { e.printStackTrace(); }
复制代码
正例：
try { // do what you want } catch (Exception e) { log.info("你的程序有异常啦,{}", e); }
复制代码
理由：
printStackTrace()打印出的堆栈日志跟业务代码日志是交错混合在一起的，排查异常日志不太方便。
e.printStackTrace()语句产生的字符串记录的是堆栈信息，如果信息太长太多，字符串常量池所在的内存块没有空间了,即内存满了。
二、catch 了异常，但是没有打印出具体的 exception，无法更好定位问题
反例：
try { // do what you want } catch (Exception e) { log.info("你的程序有异常啦"); }
复制代码
正例：
try { // do what you want } catch (Exception e) { log.info("你的程序有异常啦，{}", e); }
复制代码
理由：
三、不要用一个 Exception 捕捉所有可能的异常
反例：
public void test () { try { // 抛出 IOException 的代码调用 // 抛出 SQLException 的代码调用 } catch (Exception e) { // 用基类 Exception 捕捉的所有可能的异常，如果多个层次都这样捕捉，会丢失原始异常的有效信息哦 log.info("Exception in test, exception:{}", e); } }
复制代码
正例：
public void test () { try { // 抛出 IOException 的代码调用 // 抛出 SQLException 的代码调用 } catch (IOException e) { // 仅仅捕捉 IOException log.info("IOException in test,exception:{}", e); } catch (SQLException e) { // 仅仅捕捉 SQLException log.info("SQLException in test,exception:{}", e); } }
复制代码
理由：
四、记得使用 finally 关闭流资源或者直接使用 try-with-resource
反例：
FileInputStream fdIn; try { fdIn = new FileInputStream(new File("/test.txt")); //在这里关闭流资源？有没有问题呢？如果发生异常了呢？ fdIn.close(); } catch (FileNotFoundException e) { log.error(e); } catch (IOException e) { log.error(e); }
复制代码
正例 1：
需要使用 finally 关闭流资源，如下
FileInputStream fdIn = null; try { fdIn = new FileInputStream(new File("/test.txt")); } catch (FileNotFoundException e) { log.error(e); } catch (IOException e) { log.error(e); } finally { try { if (fdIn != null) { fdIn.close(); } } catch (IOException e) { log.error(e); } }
复制代码
正例 2：
当然，也可以使用 JDK7 的新特性 try-with-resource 来处理，它是 Java7 提供的一个新功能，它用于自动资源管理。
try (FileInputStream inputStream = new FileInputStream(new File("test.txt")) { // use resources } catch(FileNotFoundException e) { log.error(e); } catch (IOException e) { log.error(e); }
复制代码
理由：
五、捕获异常与抛出异常必须是完全匹配，或者捕获异常是抛异常的父类
反例：
// BizException 是 Exception 的子类 public class BizException extends Exception {} // 抛出父类Exception public static void test() throws Exception {}
try { // 编译错误 test(); } catch (BizException e) { // 捕获异常子类是没法匹配的 log.error(e); }
复制代码
正例：
//抛出子类Exceptionpublic static void test() throws BizException {}
try { test();} catch (Exception e) { log.error(e);}
复制代码
六、捕获到的异常，不能忽略它，至少打点日志吧
反例：
public static void testIgnoreException() throws Exception { try { // 搞事情 } catch (Exception e) {
} }
复制代码
正例：
public static void testIgnoreException () { try { // 搞事情 } catch (Exception e) { log.error("这个异常不应该在这里出现的,{}", e); } }
复制代码
理由：
七、注意异常对你的代码层次结构的侵染（早发现早处理）
反例：
public UserInfo queryUserInfoByUserId(Long userid) throw SQLException { // 根据用户Id查询数据库 }
复制代码
正例：
public UserInfo queryUserInfoByUserId(Long userid) { try { //根据用户Id查询数据库 } catch (SQLException e) { log.error("查询数据库异常啦，{}", e); } finally { //关闭连接，清理资源 } }
复制代码
理由：
八、自定义封装异常，不要丢弃原始异常的信息 Throwable cause
我们常常会想要在捕获一个异常后抛出另一个异常，并且希望把原始异常的信息保存下来，这被称为异常链。公司的框架提供统一异常处理就用到异常链，我们自定义封装异常，不要丢弃原始异常的信息，否则排查问题就头疼啦
反例：
public class TestChainException { public void readFile() throws MyException { try { InputStream is = new FileInputStream("test.txt"); Scanner in = new Scanner(is); while (in.hasNext()) { System.out.println(in.next()); } } catch (FileNotFoundException e) { //e 保存异常信息 throw new MyException("文件在哪里呢"); } }
public void invokeReadFile() throws MyException { try { readFile(); } catch (MyException e) { //e 保存异常信息 throw new MyException("文件找不到"); } }
public static void main(String[] args) { TestChainException t = new TestChainException(); try { t.invokeReadFile(); } catch (MyException e) { e.printStackTrace(); } } }
//MyException 构造器 public MyException(String message) { super(message); }
复制代码
正例：
public class TestChainException { public void readFile() throws MyException { try { InputStream is = new FileInputStream("test.txt"); Scanner in = new Scanner(is); while (in.hasNext()) { System.out.println(in.next()); } } catch (FileNotFoundException e) { //e 保存异常信息 throw new MyException("文件在哪里呢", e); } }
public void invokeReadFile() throws MyException { try { readFile(); } catch (MyException e) { //e 保存异常信息 throw new MyException("文件找不到", e); } }
public static void main(String[] args) { TestChainException t = new TestChainException(); try { t.invokeReadFile(); } catch (MyException e) { e.printStackTrace(); } } }
//MyException 构造器 public MyException(String message, Throwable cause) { super(message, cause); }
复制代码
九、运行时异常 RuntimeException ，不应该通过 catch 的方式来处理，而是先预检查，比如：NullPointerException 处理
反例：
try { obj.method() } catch (NullPointerException e) { }
复制代码
正例：
十、注意异常匹配的顺序，优先捕获具体的异常
注意异常的匹配顺序，因为只有第一个匹配到异常的 catch 块才会被执行。如果你希望看到，是 NumberFormatException 异常，就抛出 NumberFormatException，如果是 IllegalArgumentException 就抛出 IllegalArgumentException。
反例：
try { doSomething("test exception");} catch (IllegalArgumentException e) { log.error(e);} catch (NumberFormatException e) { log.error(e);}
复制代码
正例：
try { doSomething("test exception");} catch (NumberFormatException e) { log.error(e);} catch (IllegalArgumentException e) { log.error(e);}
复制代码
理由：因为 NumberFormatException 是 IllegalArgumentException 的子类，反例中，不管是哪个异常，都会匹配到 IllegalArgumentException，就不会再往下执行啦，因此不知道是否是 NumberFormatException。所以需要优先捕获具体的异常，把 NumberFormatException 放前面。
评论