技術文章 » Java 例外處理：使用和思考

Java 例外處理：使用和思考

2023-04-10 06:05:11

概念

例外處理的概念起源於早期的程式語言，如 LISP、PL/I 和 CLU。這些程式語言首次引入了例外處理機制，以便在程式執行過程中檢測和處理錯誤情況。例外處理機制隨後在 Ada、Modula-3、C++、Python、Java 等程式語言中得到了廣泛採用和發展。在 Java 中，例外處理是提供一種在程式執行時處理錯誤和異常情況的方法。例外處理機制使得程式能夠在遇到錯誤時繼續執行，而不是立即崩潰。這種機制使程式更具有健壯性和容錯性。異常分為兩類：受檢異常（Checked Exceptions）和非受檢異常（Unchecked Exceptions）

受檢異常（Checked Exceptions）：

受檢異常是指那些在編譯時必須處理的異常。它們通常是由程式設計師的錯誤或外部資源問題引起的。例如，IOException、FileNotFoundException 等。受檢異常必須在方法簽名中使用 throws 關鍵字宣告，或者在方法體內用 try-catch 塊捕獲和處理。

非受檢異常（Unchecked Exceptions）：

非受檢異常是指那些在編譯時不強制要求處理的異常。它們通常是由程式設計錯誤引起的，如空指標異常（NullPointerException）、陣列越界（ArrayIndexOutOfBoundsException）等。非受檢異常繼承自 java.lang.RuntimeException 類，不需要在方法簽名中宣告，也不需要強制捕獲和處理。

它們的關係如下：

classDiagram class Throwable { +getMessage(): String +printStackTrace(): void } class Error { } class AssertionError{ } class VirtualMachineError{ } class Exception { } class RuntimeException { } class IOException { } class FileNotFoundException { } class NullPointerException { } class IndexOutOfBoundsException { } Throwable <|-- Error Throwable <|-- Exception Error <|-- AssertionError Error <|-- VirtualMachineError Exception <|-- RuntimeException Exception <|-- IOException IOException <|-- FileNotFoundException RuntimeException <|-- NullPointerException RuntimeException <|-- IndexOutOfBoundsException

例外處理

Java 使用 try/catch 關鍵字進行異常捕獲，使用 throw 宣告丟擲異常，範例程式碼如下：

public class NullPointerExceptionExample {
    public static void main(String[] args) {
        String nullString = null;
        try {
            int length = nullString.length();
        } catch (NullPointerException e) {
            System.out.println("Caught NullPointerException!");
            e.printStackTrace();
        }
    }
}

在這個範例中，我們嘗試獲取一個 null 字串的長度。當呼叫 nullString.length() 時，會丟擲 NullPointerException。我們使用 try-catch 語句捕獲異常並處理它

自定義異常

Java 官方異常不可能預見所有可能發生的錯誤，有時候你需要結合自己的業務場景，例如以下場景：

  1. 當內建的 Java 異常類無法準確描述你所遇到的異常情況時。
  2. 需要為特定領域或業務邏輯建立一組特定的異常。
  3. 當希望通過自定義異常類向呼叫者提供更多的上下文資訊或特定的錯誤程式碼時。

構建特定的異常，這也很簡單，繼承已有的異常類（最好繼承含義差不多的），如下，我們建立一個表示賬戶餘額不足的異常：

public class InsufficientBalanceException extends RuntimeException {
    private double balance;
    private double amount;

    public InsufficientBalanceException(double balance, double amount) {
        super("Insufficient balance: " + balance + ", required amount: " + amount);
        this.balance = balance;
        this.amount = amount;
    }

    public double getBalance() {
        return balance;
    }

    public double getAmount() {
        return amount;
    }
}

接下來，我們在業務邏輯程式碼中使用這個自定義異常：

public class BankAccount {
    private double balance;

    public BankAccount(double balance) {
        this.balance = balance;
    }

    public void withdraw(double amount) throws InsufficientBalanceException {
        if (amount > balance) {
            throw new InsufficientBalanceException(balance, amount);
        }
        balance -= amount;
    }
}

呼叫者可以捕獲並處理這個自定義異常：

public class BankAccountTest {
    private static final Logger logger = Logger.getLogger(BankAccountTest.class.getName());

    public static void main(String[] args) {
        BankAccount account = new BankAccount(1000.00);
        try {
            account.withdraw(2000.00);
        } catch (InsufficientBalanceException e) {
            System.out.println("Error: " + e.getMessage());
            System.out.println("Current balance: " + e.getBalance());
            System.out.println("Required amount: " + e.getAmount());
            
            logger.log(Level.SEVERE, "An exception occurred", e);
        }
    }
}

可以看到自定義異常使我們能夠更清晰地表達業務邏輯中可能出現的異常情況，同時為呼叫者提供更多關於異常的上下文資訊。我們還使用 java.util.logging 工具將輸出記錄到紀錄檔中

多重捕獲

在 Java 早起版本，處理多個沒有共同基礎類別的異常，需要為每一個異常型別編寫一個 catch 語句處理，如下：

class CustomException1 extends Exception {
    public CustomException1(String message) {
        super(message);
    }
}

class CustomException2 extends Exception {
    public CustomException2(String message) {
        super(message);
    }
}

public class SingleCatchException {

    public static void main(String[] args) {
        try {
            // 根據引數選擇丟擲哪種異常
            if (args.length > 0 && "type1".equals(args[0])) {
                throw new CustomException1("This is a custom exception type 1.");
            } else {
                throw new CustomException2("This is a custom exception type 2.");
            }
        } catch (CustomException1 e) {
            // 當 CustomException1 發生時，執行此程式碼塊
            System.err.println("Error occurred: " + e.getMessage());
        } catch (CustomException2 e) {
            // 當 CustomException2 發生時，執行此程式碼塊
            System.err.println("Error occurred: " + e.getMessage());
        }
    }
}

這樣的程式碼不僅難以閱讀，而且也不夠簡潔。

多重異常捕獲機制，它允許在一個 catch 語句中捕獲多個異常型別。這種方法可以避免重複的程式碼，使例外處理更加簡潔。以下是一個使用多重異常捕獲機制的範例：

public class MultiCatchExample {

    public static void main(String[] args) {
        try {
            // 根據引數選擇丟擲哪種異常
            if (args.length > 0 && "type1".equals(args[0])) {
                throw new CustomException1("This is a custom exception type 1.");
            } else {
                throw new CustomException2("This is a custom exception type 2.");
            }
        } catch (CustomException1 | CustomException2 e) {
            // 當 CustomExceptionType1 或 CustomExceptionType2 發生時，執行此程式碼塊
            System.err.println("Error occurred: " + e.getMessage());
        }
    }
}

重新丟擲異常

在某些情況下，你可能希望將異常傳遞給呼叫者處理，而不是在當前方法中處理。或者需要在捕獲異常時執行一些處理操作，如記錄紀錄檔、清理資源或者新增額外的上下文資訊。在這種情況下，你可以在 catch 塊中處理異常，然後重新丟擲原始異常或丟擲一個新的異常，包含額外的資訊，如下：

public class RethrowExceptionExample {
    public static void main(String[] args) {
        try {
            doSomething();		// 可能會丟擲異常的方法
        } catch (IOException e) {
            // 例外處理邏輯
            System.err.println("An error occurred: " + e.getMessage());            
            // 重新丟擲異常
            throw e;
        }
    }
}

更好的 NPE

NPE（NullPointerExceptions）是很常見異常，在 JDK 14 以前遇到 NPE 異常，能得到資訊有限，JDK 15 引入了一項名為「Helpful NullPointerExceptions」的新功能，這項功能改進了 NullPointerException (NPE) 的診斷。在之前的 JDK 版本中，當發生 NullPointerException 時，異常資訊通常並不提供足夠的上下文來幫助開發人員定位問題的具體位置。

範例程式碼：

class A {
    String s;
    public A(String s) {
        this.s = s;
    }
}

class B {
    A a;
    public B(A a) {
        this.a = a;
    }
}

class C {
    B b;
    public C(B b) {
        this.b = b;
    }
}

public class BetterNullPointerReports {

    public static void main(String[] args) {
        C[] ca = {
                new C(new B(new A(null))),
                new C(new B(null)),
                new C(null)
        };

        for (C c : ca) {
            try {
                System.out.println(c.b.a.s);
            } catch (NullPointerException npe) {
                System.out.println(npe);
            }
        }
    }
}

在 JDK 14 及之前的版本中，輸出結果：

# 你根本看不出哪裡出了問題
null
java.lang.NullPointerException
java.lang.NullPointerException

在 JDK 15 及之後的版本中，輸出結果：

# 得到更詳細的 NPE 資訊
null
java.lang.NullPointerException: Cannot read field "s" because "c.b.a" is null
java.lang.NullPointerException: Cannot read field "a" because "c.b" is null

清道夫：finally

當程式發生了非預期的異常，那麼程式會終止執行，但是對於很多需要執行清理操作，這是不可接受的，例如：

  • 關閉資源：在 try 塊中開啟的資源，如檔案、資料庫連線、網路連線等，需要在完成操作後確保被正確關閉
  • 釋放鎖：在並行程式設計中，可能會使用鎖來同步程式碼。在釋放鎖之前，如果發生異常，可能會導致其他執行緒無法獲取鎖
  • 回滾事務：在資料庫程式設計中，可能需要在事務中執行一系列操作。如果這些操作中的任何一個失敗，事務需要回滾
  • 恢復狀態：在執行某些操作時，可能需要更改物件或系統的狀態。在操作完成後，可能需要恢復原始狀態

對於以上的程式來說，finally 就非常重要了，它可以解決以上程式的清理操作。

範例程式碼：

import java.io.BufferedReader;
import java.io.FileReader;
import java.io.IOException;

public class FinallyExample {

    public static void main(String[] args) {
        BufferedReader reader = null;
        try {
            reader = new BufferedReader(new FileReader("example.txt"));
            String line;
            while ((line = reader.readLine()) != null) {
                System.out.println(line);
            }
        } catch (IOException e) {
            System.err.println("Error reading file: " + e.getMessage());
        } finally {
            if (reader != null) {
                try {
                    reader.close();
                } catch (IOException e) {
                    System.err.println("Error closing file: " + e.getMessage());
                }
            }
        }
    }
}

在以上程式碼中，無論程式是否出錯，finally 都可以確保檔案被正確關閉

異常的約束

Java 在物件導向中對異常存在頗多約束和限制，其主要目的如下：

  • 保持子型別可替換性：當子類覆蓋父類別的方法或實現介面的方法時，子類的方法應該滿足父類別或介面方法的約定
  • 避免意外的異常：如果子類方法可以丟擲任意異常，那麼呼叫者在處理異常時可能遇到意外的異常型別，導致程式出錯
  • 提高程式碼可讀性：通過限制異常的繼承和實現規則，可以使得程式碼更加清晰和易於理解
  • 促進良好的設計實踐：如果子類方法可以丟擲任意異常，那麼程式設計師可能會過度依賴異常來處理錯誤情況，導致程式碼難以維護

在介面和繼承中使用異常，需要遵循以下規則：

  1. 子類可以丟擲與介面或者父類別方法相同的異常。
  2. 子類可以不丟擲任何異常，即使介面或父類別方法宣告了異常。這意味著實現類的方法已經處理了這些異常。
  3. 子類可以丟擲介面方法或父類別宣告異常的相同型別的異常，因為子類異常依然符合介面方法的約定。

程式碼範例：

class CustomException extends RuntimeException {}
class CustomExceptionChild extends CustomException {}
interface MyInterface {
    void myMethod() throws CustomException;
}

class MyClass1 implements MyInterface {
    // 1：丟擲與介面方法相同異常
    @Override
//    public void myMethod() throws FileNotFoundException {     // 編譯錯誤，不能丟擲不同型別的異常
    public void myMethod() throws CustomException {
        // ...
    }
}

class MyClass2 implements MyInterface {
    // 2：即使不丟擲任何異常，也沒有問題
    @Override
    public void myMethod() {
    }
}

class MyClass3 implements MyInterface {
    // 3: 丟擲介面方法宣告異常的子類異常（或者父類別，既相同型別即可）
    @Override
    public void myMethod() throws CustomExceptionChild {
        // ...
    }
}

try-with-resources

在 Java 7 中，關於自動管理資源。在處理需要關閉的資源（如檔案、資料庫連線、網路連線等）有了更好的選擇，那就是使用 try-catch-finally 進行處理，它對比 finally 具有以下優勢：

  1. 簡化程式碼：相比 finally 顯示關閉資源，使用 Try-With-Resources，可以自動關閉資源，從而使程式碼更簡潔、易讀。
  2. 避免資源洩漏：使用 Try-With-Resources 能夠確保在退出 try 程式碼塊時自動關閉資源，降低資源洩漏的風險。
  3. 減少錯誤：Try-With-Resources 能夠正確地處理資源關閉過程中的異常，並提供完整的異常資訊，有助於減少錯誤。

範例程式碼：

import java.io.BufferedReader;
import java.io.FileReader;
import java.io.IOException;

public class TryWithResourcesExample {

    public static void main(String[] args) {
        String fileName = "example.txt";

        try (BufferedReader reader = new BufferedReader(new FileReader(fileName))) {
            String line;
            while ((line = reader.readLine()) != null) {
                System.out.println(line);
            }
        } catch (IOException e) {
            System.err.println("Error reading file: " + e.getMessage());
        }
    }
}

在這個範例中，我們使用 Try-With-Resources 語句建立了一個 BufferedReader 範例。BufferedReader 實現了 Closeable 介面，因此在退出 try 程式碼塊時，reader 會自動呼叫 close() 方法以釋放資源。

為了一探 Try-With-Resources 的究竟，我們可以建立自定義的 AutoCloseable 類：

class Reporter implements AutoCloseable {
    String name = getClass().getSimpleName();
    public Reporter() {
        System.out.println("Creating " + name);
    }
    @Override
    public void close() throws Exception {
        System.out.println("Closing " + name);
    }
}
class First extends Reporter {}
class Second extends Reporter {}

public class AutoCloseableDetails {
    public static void main(String[] args) {
        try (First f = new First(); Second s = new Second()) {
            System.out.println("In body");
        } catch (Exception e) {
            System.out.println("Exception caught");
        }
    }
}

輸出結果：

Creating First
Creating Second
In body
Closing Second
Closing First

退出 try 塊會呼叫兩個物件的 close() 方法，並以與建立順序相反的順序關閉它們。（順序很重要）。

使用 Try-With-Resource 是很安全的，假設你隨意在 Try 頭使用物件，會出現編譯錯誤：

class Anything {}

public class TryAnything {
    public static void main(String[] args) {
        // 假設我們定義的類，不是 AutoCloseable 的物件，會出現編譯錯誤
        try (Anything a = new Anything()) {     // compile error
            System.out.println("In body");
        } catch (Exception e) {
            System.out.println("Exception caught");
        }
    }
}

異常型別匹配

Java 在丟擲異常時，會根據異常型別進行匹配。例外處理程式會從上到下依次檢查 catch 子句，看它們是否與丟擲的異常型別相容。當發現相容的 catch 子句時，Java 就會執行該子句的程式碼來處理異常。請注意，Java 只會執行與丟擲異常型別相容的第一個 catch 子句。

範例程式碼：

public class ExceptionMatchingExample {
    public static void main(String[] args) {
        try {
            // ... Some code that may throw exceptions ...
            throw new FileNotFoundException("File not found");
        } catch (FileNotFoundException e) {
            System.out.println("Handling FileNotFoundException: " + e.getMessage());
        } catch (IOException e) {
            System.out.println("Handling IOException: " + e.getMessage());
        } catch (Exception e) {
            System.out.println("Handling general exception: " + e.getMessage());
        }
    }
}

在這個範例中，我們丟擲了一個 FileNotFoundException，Java 會從上到下檢查 catch 子句，看它們是否與 FileNotFoundException 相容。因為 FileNotFoundException 是 IOException 的子類，它與 FileNotFoundException 和 IOException 的 catch 子句相容。但是，Java 只會執行第一個相容的 catch 子句，即 FileNotFoundException 子句。如果沒有找到相容的 catch 子句，Java 會繼續在呼叫棧中查詢例外處理程式，直到找到一個合適的處理程式或者程式終止。

輸出結果：

Handling FileNotFoundException: File not found

使用指南

異常看似簡單易懂，但在處理過程中還需要遵循許多最佳實踐，例如：

  • 除非你知道如何處理，否則不要捕獲異常（錯誤處理程式碼太多，容易干擾主執行緒式碼的邏輯和可讀性）
  • 不要生吞異常：捕獲異常不進行處理會導致異常消失，從而對於線上問題排查，無從下手
  • 捕獲具體異常：儘量捕獲具體的異常類，而不是捕獲泛化的 Exception 類
  • 儘可能的使用多重異常捕獲來簡化重複程式碼，並且提高程式碼的可讀性
  • 儘可能的使用 Try-With-Resources 清理資源
  • 自定義異常：在需要時，為特定於你的應用程式的異常情況建立自定義異常

檢查型異常是 shit ?

檢查型異常（checked exceptions）在 Java 中引發了很多爭議。有些人認為它們是一種有益的設計，可以提高程式碼的可靠性，而另一些人則認為它們是一種糟糕的設計，會導致程式碼冗餘和難以維護，例如 Martin Fowler （《UML 精粹》、《重構》）作者，也曾在部落格發表稱：

總的來說，我認為異常很不錯，但是 Java 的檢查型異常要比好處多

那麼檢查型異常究竟帶來了什麼問題 ？ 常見的槽點有：

  1. 強制錯誤處理：檢查型異常強制開發者處理異常情況，導致主執行緒式碼中充斥著大量和業務邏輯無關的程式碼
  2. 程式碼冗餘：檢查型異常可能導致大量的 try-catch 程式碼塊，增加程式碼冗餘，影響程式碼可讀性
  3. 異常傳遞：對於一些需要在多層方法呼叫中傳遞異常的情況，檢查型異常可能導致開發者不得不為每個方法新增異常宣告

Go 也沒有異常啊

最幾年 Go 語言的成功讓很多人加深了這一觀點，Go 語言沒有檢查型異常的概念，但它們的程式碼依然可以具有很高的可靠性。這表明檢查型異常並非是提高程式碼可靠性的唯一方法。Go 語言的設計者們有意避免了引入檢查型異常，主要有以下原因：

  • 程式碼簡潔性：Go 語言的設計者們希望保持程式碼簡潔，避免因為例外處理而產生的大量冗餘程式碼。
  • 顯示錯誤處理：Go 語言鼓勵開發者顯式地處理錯誤，而不是通過異常機制隱式地處理。
  • 降低複雜性：異常機制會增加程式的複雜性。Go 語言的設計者們希望通過避免引入異常機制，讓程式更簡單易懂。
  • 效能開銷：例外處理機制可能會帶來一定的效能開銷，通過返回 error 型別，可以避免這種效能開銷。

範例程式碼：

package main

import (
    "errors"
    "fmt"
)

func divide(a, b int) (int, error) {
    if b == 0 {
        return 0, errors.New("division by zero")
    }
    return a / b, nil
}

func main() {
    result, err := divide(10, 2)
    if err != nil {
        fmt.Println("Error:", err)
    } else {
        fmt.Println("Result:", result)
    }

    result, err = divide(10, 0)
    if err != nil {
        fmt.Println("Error:", err)
    } else {
        fmt.Println("Result:", result)
    }
}

在這個範例中，我們定義了一個名為divide的函數，它接受兩個整數引數a和b，計算它們的商。如果b為零，函數將返回一個非空的error型別值，以指示發生了錯誤。否則，函數將返回商和一個空error值。在 main 函數中，我們呼叫divide兩次，一次使用一個非零除數，另一次使用零作為除數。對於第一次呼叫，divide將返回一個空的error值，我們就可以列印出計算結果。對於第二次呼叫，divide將返回一個非空的error值，我們使用if err != nil來檢查這個值是否為nil，如果不是，就列印錯誤資訊。

輸出結果：

Result: 5
Error: division by zero

以上就是 Go 在處理異常的方式。儘管 Go 語言沒有引入檢查型異常，但它依然具備了一套有效的錯誤處理機制。使用多值返回（value, error）的方式，可以讓程式碼更簡潔、易讀，同時鼓勵開發者顯式地處理錯誤。這種設計理念與 Go 語言追求簡潔、高效的目標相一致。

陳述總結

最後，關於檢查型異常在某些場景下可以提高程式碼的可靠性和健壯性，但在另一些場景下可能導致程式碼冗餘和難以維護。在很多人看來弊大於利了。然而，這並不意味著在所有情況下都不應該使用檢查型異常。在某些場景下，合理地使用檢查型異常可以幫助提高程式碼的健壯性和可靠性。關鍵是要明確例外處理的目的，在實際開發中，可以根據需要和團隊的編碼規範來權衡使用檢查型異常。