譯者 | 李睿
審校 | 重樓
在不斷發展的Java開發世界中，開發人員不斷尋找工具和代碼庫來簡化代碼編寫過程。其中一個工具是Project Lombok，通常簡稱為Lombok。這個Java庫提供了代碼生成功能，有望簡化開發人員的工作。然而，與任何強大的工具一樣，也需要注意避開一些設計缺陷。
本文將以Lombok為重點深入研究代碼設計的世界，探討Lombok看似方便的注釋(例如Builder和Log)可能並不像看起來那麼完美的原因。此外還將強調封裝的重要性，並討論Lombok的Data和NotNull注釋如何導致意想不到的挑戰。無論是經驗豐富的開發人員還是開始走上編碼之旅的新手，本文都將提供具有價值的見解，以增強他們的工程技能。
Lombok的優點
在深入研究潛在的缺陷之前，有必要認識到Lombok的優點。Lombok提供了幾個可以顯著簡化代碼編寫的注釋：
- Log注釋：Lombok的Log注釋允許開發人員快速生成日誌代碼，減少對樣板代碼的需求。
- Builder注釋：Builder注釋通過開發增強代碼可讀性的構建器方法，簡化了複雜對象的創建。
封裝的挑戰
Lombok的應用並不是一帆風順的。Lombok帶來的最重要的挑戰之一與封裝概念有關。封裝是面向對象編程的基本原則，強調將數據(屬性)和對數據進行操作的方法(函數)捆綁到一個稱為類的單元中。它有助於維護數據完整性，並保護數據免受未經授權的訪問。
- 數據注釋：Lombok的數據注釋雖然看起來很方便，但可能導致「貧血模型」。貧血模型是一個術語，用於描述主要存儲幾乎沒有行為的數據的對象。該注釋為類中的所有欄位生成getter和setter方法，通過將內部狀態暴露給外部操作，有效地破壞了封裝。
考慮這樣一個場景，其中有一個帶有敏感信息(如密碼欄位)的User類。應用Data注釋將自動為密碼欄位生成getter和setter方法，從而可能允許對敏感數據進行未經授權的訪問。這可能導致安全漏洞和數據完整性問題。
- NotNull注釋：另一個挑戰來自Lombok的NotNull注釋。這裡給出的建議是一些來自Java 8的帶有Objects.requireNonNull的顯式API。
為了解決Null值的問題，Java8和更高版本提供了一個內置的解決方案。Objects.requireOnNull方法允許開發人員顯式檢查Null值，並在遇到Null值時拋出NullPointerException。這種方法提供了一種清晰簡潔的方法來處理Null檢查，確保基本欄位不會未初始化。
以下是如何使用Objects.requireOnNull的示例：
複製
Java
public void setUser(User user) {
this.user = Objects.requireNonNull(user, "User must not be null");
}
通過使用Objects.requireOnNull，開發人員可以更穩健地執行Null檢查，即使不依賴Lombok的NotNull注釋。
增強代碼模板和IDE支持
同樣需要注意的是，即使不使用Lombok，開發團隊也可以在集成開發環境（IDE）中增強代碼模板。例如，流行的Java IDE IntelliJ IDEA為生成構建器模式提供了原生支持。開發人員可以創建自定義代碼模板，或者使用IDE特定的功能來生成符合他們首選編碼標準的代碼。
通過利用IDE特性和定製模板，開發團隊可以獲得Lombok的許多好處，例如減少樣板代碼和改進代碼可讀性，同時保持對生成代碼的完全控制。
執行最佳實踐的挑戰
在理想情況下，開發人員可以使用像Arch Unit這樣的工具來強制執行編碼最佳實踐，並防止使用不安全的注釋。然而，事實表明，這說起來容易做起來難。通過自動化工具避免特定的Lombok注釋可能面臨挑戰或限制。這給代碼審查和開發人員帶來了更大的責任，以捕捉和糾正潛在的問題。
使用Lombok的權衡
像任何工具一樣，Lombok從代碼設計的角度進行了權衡。它提供了便利，並減少了樣板代碼，但是也會給數據封裝帶來風險，並且在代碼審查期間需要額外的警惕。在項目中使用Lombok的決定應該經過深思熟慮，需要考慮應用程式的特定需求以及開發團隊對Lombok的特性和潛在缺陷的熟悉程度。
結語
總之，Lombok是一個強大的工具，可以顯著提高Java開發中的代碼可讀性，並減少樣板代碼。但是必須謹慎使用它，特別是在數據封裝方面。了解潛在的缺陷(例如Data和NotNull注釋)對於維護代碼完整性和安全性至關重要。
與開發人員工具箱中的任何工具一樣，應該謹慎地使用Lombok，仔細考慮它的優點和缺點。充分了解Lombok的方法可以幫助用戶利用它的優勢，同時降低風險，最終生成更可維護和更安全的Java代碼。
因此，在Java項目中使用Lombok之前，需要記住揭示其代碼設計缺陷並做出明智的決策，以提高工程技能並確保代碼庫的完整性。
原文標題：Unraveling Lombok's Code Design Pitfalls: Exploring Encapsulation Issues，作者：Otavio Santana