Java 異常處理的十個建議
阿新 • • 發佈：2020-06-14
## 前言
Java異常處理的十個建議，希望對大家有幫助~
本文已上傳github:
> https://github.com/whx123/JavaHome
**公眾號：撿田螺的小男孩**
### 一、儘量不要使用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出來，到時候排查問題就不好查了啦，到底是SQl寫錯的異常還是IO異常，還是其他呢？所以應該把exception列印到日誌中哦~
### 三、不要用一個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);
}
}
```
理由：
- 用基類 Exception 捕捉的所有可能的異常，如果多個層次都這樣捕捉，會丟失原始異常的有效資訊哦
### 四、記得使用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資源就會被他一直佔著，這樣別人就沒有辦法用了，這就造成資源浪費。
### 五、捕獲異常與丟擲異常必須是完全匹配，或者捕獲異常是拋異常的父類
**反例：**
```
//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);
}
```
### 六、捕獲到的異常，不能忽略它，至少打點日誌吧
**反例：**
```
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{
//關閉連線，清理資源
}
}
```
**理由：**
- 我們的專案，一般都會把程式碼分 Action、Service、Dao 等不同的層次結構，如果你是DAO層處理的異常，儘早處理吧，如果往上 throw SQLException，上層程式碼就還是要try catch處理啦，這就汙染了你的程式碼~
### 八、自定義封裝異常，不要丟棄原始異常的資訊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);
}
```
### 九、執行時異常RuntimeException ，不應該通過catch 的方式來處理，而是先預檢查，比如：NullPointerException處理
**反例：**
```
try {
obj.method()
} catch (NullPointerException e) {
...
}
```
**正例：**
```
if (obj != null){
...
}
```
### 十、注意異常匹配的順序，優先捕獲具體的異常
注意異常的匹配順序，因為只有第一個匹配到異常的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放前面~
## 公眾號
- 歡迎關注我個人公眾號，交個朋友，一起學習哈~
- 如果答案整理有錯，歡迎指出哈，感激不盡~