快捷導(dǎo)航

Lombok 的@StandardException注解解析

更新時間：2023年05月11日 09:46:23 作者：明明如月學(xué)長

@StandardException 是一個實(shí)驗(yàn)性的注解，添加到 Project Lombok 的 v__1.18.22 版本中，在本教程中，我們將使用 Lombok 的 @StandardException 注解自動生成異常類型類的構(gòu)造函數(shù),需要的朋友可以參考下

1. 引言

在 Java 應(yīng)用程序中，異常類對于正確捕獲和處理錯誤至關(guān)重要。我們常常在編寫異常處理的重復(fù)代碼上花費(fèi)時間，而不是關(guān)注應(yīng)用程序的其他方面。

在本教程中，我們將使用 Lombok 的 @StandardException 注解自動生成異常類型類的構(gòu)造函數(shù)。此外，我們還將了解其優(yōu)缺點(diǎn)。

2. 什么是 @StandardException?

@StandardException 是一個實(shí)驗(yàn)性的注解，添加到 Project Lombok 的 v__1.18.22 版本中。該注解適用于任何 Throwable 的子類，并自動生成四個構(gòu)造函數(shù)：

一個無參數(shù)構(gòu)造函數(shù)
一個僅帶消息的構(gòu)造函數(shù)，無異常原因
一個僅帶異常原因的構(gòu)造函數(shù)，無消息
一個帶有消息和異常原因的標(biāo)準(zhǔn)構(gòu)造函數(shù)

與大多數(shù) Lombok 注解一樣，@StandardException 非常簡單，我們將在以下部分看到。

2.1. 添加 Lombok 依賴

我們需要使用 Project Lombok 的 v.1.18.22 或更高版本來使用該注解。因此，讓我們將最新的 lombok::1.18.26 添加到我們的 pom.xml 文件中：

<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <version>1.18.26</version>
    <scope>provided</scope>
</dependency>

2.2. 使用類注解

要在我們的異常中使用 @StandardException，我們必須創(chuàng)建一個擴(kuò)展 Throwable 類或其任何子類的目標(biāo)類。因此，它適用于檢查和未檢查異常以及錯誤。

為了說明，讓我們創(chuàng)建一個 CustomException 類：

@StandardException
public class CustomException extends Throwable {
}

由于 CustomException 擴(kuò)展了 Throwable，代碼正常編譯。讓我們看看編譯后生成的代碼：

public class CustomException extends Throwable {
    public CustomException() {
        this((String)null, (Throwable)null);
    }
    public CustomException(String message) {
        this(message, (Throwable)null);
    }
    public CustomException(Throwable cause) {
        this(cause != null ? cause.getMessage() : null, cause);
    }
    public CustomException(String message, Throwable cause) {
        super(message);
        if (cause != null) {
            super.initCause(cause);
        }
    }
}

Lombok 注解的工作方式與實(shí)現(xiàn)自定義異常構(gòu)造函數(shù)的通常 Java 方法不同。通常，JDK 通過調(diào)用指定簽名的 super 構(gòu)造函數(shù)版本來實(shí)現(xiàn)它們。例如，僅包含異常原因的構(gòu)造函數(shù)在其實(shí)現(xiàn)中將調(diào)用 super(cause)。

另一方面，Lombok 的前三個構(gòu)造函數(shù)依賴于生成的標(biāo)準(zhǔn)構(gòu)造函數(shù)來構(gòu)建異常對象。標(biāo)準(zhǔn)構(gòu)造函數(shù)調(diào)用 super(message) 來構(gòu)建初始對象。然后，如果不是 null，它使用 initCause() 方法初始化 CustomException 的原因。

在使用注解時，我們必須考慮這兩種實(shí)現(xiàn)的不同細(xì)微差別。

接下來，我們將在下一部分中討論與通常方法相比，@StandardException 的一些優(yōu)點(diǎn)和缺點(diǎn)。

3. 優(yōu)點(diǎn)

使用 @StandardException 的主要優(yōu)點(diǎn)是我們避免了編寫樣板代碼。例如，在純 Java 中創(chuàng)建一個 NumberFormatException 的子類可能是這樣的：

public class CustomNumberFormatException extends NumberFormatException{
    public CustomNumberFormatException() {
        super();
    }
    public CustomNumberFormatException(String s) {
        super(s);
    }
}

在上面的代碼中，我們手動使用 NumberFormatException 的可用 super 構(gòu)造函數(shù)創(chuàng)建了構(gòu)造函數(shù)。

在實(shí)際應(yīng)用程序中，該代碼通常會在異常類之間重復(fù)。因此，我們最終多次復(fù)制粘貼相同的代碼。當(dāng)異常類數(shù)量較多時，這會更難維護(hù)。

相比之下，**通過使用 @StandardException，我們可以通過一行代碼獲得四個自動生成的構(gòu)造函數(shù)。**因此，它可能會提高開發(fā)速度并改善代碼可維護(hù)性。

關(guān)于 @StandardException 的另一個好點(diǎn)是，生成的構(gòu)造函數(shù)僅使用 super(message) 構(gòu)造函數(shù)，這在大多數(shù) Java 異常中都存在。因此，我們避免了調(diào)用在父類中不存在的 super 構(gòu)造函數(shù)。例如，NumberFormatException 沒有定義標(biāo)準(zhǔn)和僅異常原因構(gòu)造函數(shù)。因此，在其子類中調(diào)用 super(message, cause) 或 super(cause) 將失敗。

最后，所有使用 @StandardException 的異常都具有 Lombok 實(shí)現(xiàn)的相同行為。由于 Lombok 自動生成代碼，我們無法修改它。因此，我們不太可能向使用 @StandardException 注解的類中引入潛在的問題代碼。

4. 缺點(diǎn)

使用代碼生成器的一個明顯缺點(diǎn)是增加了調(diào)試的復(fù)雜性。在編寫的代碼中調(diào)試和發(fā)現(xiàn)缺陷比在生成的代碼中更容易。因此，如果某些內(nèi)容運(yùn)行不正確，使用 @StandardException 可能會使調(diào)試會話變得復(fù)雜。

另一個需要考慮的陷阱是對 Lombok 的依賴。將我們的代碼與 @StandardException 耦合會增加返回純Java 時的工作量。此外，如果 Lombok 方面出現(xiàn)問題，將影響所有使用該注解的異常。