Java 異常處理的十個建議

前言

Java異常處理的十個建議,但願對你們有幫助~java

本文已上傳github:git

https://github.com/whx123/Jav...

公衆號:撿田螺的小男孩github

1、儘可能不要使用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()語句產生的字符串記錄的是堆棧信息,若是信息太長太多,字符串常量池所在的內存塊沒有空間了,即內存滿了,那麼,用戶的請求就卡住啦~

2、catch了異常,可是沒有打印出具體的exception,沒法更好定位問題

反例:spa

try{
  // do what you want  
}catch(Exception e){
  log.info("你的程序有異常啦");
}

正例:日誌

try{
  // do what you want  
}catch(Exception e){
  log.info("你的程序有異常啦,{}",e);
}

理由:code

  • 反例中,並無把exception出來,到時候排查問題就很差查了啦,究竟是SQl寫錯的異常仍是IO異常,仍是其餘呢?因此應該把exception打印到日誌中哦~

3、不要用一個Exception捕捉全部可能的異常

反例:orm

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);
    }
}

理由:

  • 用基類 Exception 捕捉的全部可能的異常,若是多個層次都這樣捕捉,會丟失原始異常的有效信息哦

4、記得使用finally關閉流資源或者直接使用try-with-resource

反例:

FileInputStream fdIn = null;
try {
    fdIn = new FileInputStream(new File("/jay.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("/jay.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-with-resources保證了每一個聲明瞭的資源在語句結束的時候會被關閉
  • 什麼樣的對象才能當作資源使用呢?只要實現了java.lang.AutoCloseable接口或者java.io.Closeable接口的對象,都OK。
try (FileInputStream inputStream = new FileInputStream(new File("jay.txt")) {
    // use resources   
} catch (FileNotFoundException e) {
    log.error(e);
} catch (IOException e) {
    log.error(e);
}

理由:

  • 若是不使用finally或者try-with-resource,當程序發生異常,IO資源流沒關閉,那麼這個IO資源就會被他一直佔着,這樣別人就沒有辦法用了,這就形成資源浪費。

5、捕獲異常與拋出異常必須是徹底匹配,或者捕獲異常是拋異常的父類

反例:

//BizException 是 Exception 的子類
public class BizException extends Exception {}
//拋出父類Exception
public static void test() throws Exception {}

try {
    test(); //編譯錯誤
} catch (BizException e) { //捕獲異常子類是無法匹配的哦
    log.error(e);
}

正例:

//拋出子類Exception
public static void test() throws BizException {}

try {
    test();
} catch (Exception e) {
    log.error(e);
}

6、捕獲到的異常,不能忽略它,至少打點日誌吧

反例:

public static void testIgnoreException() throws Exception {
    try {       
        // 搞事情
    } catch (Exception e) {     //通常不會有這個異常
        
    }
}

正例:

public static void testIgnoreException() {
    try {
        // 搞事情
    } catch (Exception e) {     //通常不會有這個異常
        log.error("這個異常不該該在這裏出現的,{}",e); 
    }
}

理由:

  • 雖然一個正常狀況都不會發生的異常,可是若是你捕獲到它,就不要忽略呀,至少打個日誌吧~

7、注意異常對你的代碼層次結構的侵染(早發現早處理)

反例:

public UserInfo queryUserInfoByUserId(Long userid) throw SQLException {
    //根據用戶Id查詢數據庫
}

正例:

public UserInfo queryUserInfoByUserId(Long userid) {
    try{
        //根據用戶Id查詢數據庫
    }catch(SQLException e){
        log.error("查詢數據庫異常啦,{}",e);
    }finally{
        //關閉鏈接,清理資源
    }
}

理由:

  • 咱們的項目,通常都會把代碼分 Action、Service、Dao 等不一樣的層次結構,若是你是DAO層處理的異常,儘早處理吧,若是往上 throw SQLException,上層代碼就仍是要try catch處理啦,這就污染了你的代碼~

8、自定義封裝異常,不要丟棄原始異常的信息Throwable cause

咱們經常會想要在捕獲一個異常後拋出另外一個異常,而且但願把原始異常的信息保存下來,這被稱爲異常鏈。公司的框架提供統一異常處理就用到異常鏈,咱們自定義封裝異常,不要丟棄原始異常的信息,不然排查問題就頭疼啦

反例:

public class TestChainException {
    public void readFile() throws MyException{
        try {
            InputStream is = new FileInputStream("jay.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);
    }

運行結果以下,沒有了Throwable cause,很差排查是什麼異常了啦

正例:

public class TestChainException {
    public void readFile() throws MyException{
        try {
            InputStream is = new FileInputStream("jay.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);
    }

9、運行時異常RuntimeException ,不該該經過catch 的方式來處理,而是先預檢查,好比:NullPointerException處理

反例:

try {
  obj.method() 
} catch (NullPointerException e) {
...
}

正例:

if (obj != null){
   ...
}

10、注意異常匹配的順序,優先捕獲具體的異常

注意異常的匹配順序,由於只有第一個匹配到異常的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放前面~

公衆號

  • 歡迎關注我我的公衆號,交個朋友,一塊兒學習哈~
  • 若是答案整理有錯,歡迎指出哈,感激涕零~
相關文章
相關標籤/搜索