譯者 | 李睿

審校 | 重樓

在不斷發(fā)展的Java開發(fā)世界中，開發(fā)人員不斷尋找工具和代碼庫來簡化代碼編寫過程。其中一個工具是Project Lombok，通常簡稱為Lombok。這個Java庫提供了代碼生成功能，有望簡化開發(fā)人員的工作。然而，與任何強(qiáng)大的工具一樣，也需要注意避開一些設(shè)計缺陷。

本文將以Lombok為重點(diǎn)深入研究代碼設(shè)計的世界，探討Lombok看似方便的注釋(例如Builder和Log)可能并不像看起來那么完美的原因。此外還將強(qiáng)調(diào)封裝的重要性，并討論Lombok的Data和NotNull注釋如何導(dǎo)致意想不到的挑戰(zhàn)。無論是經(jīng)驗(yàn)豐富的開發(fā)人員還是開始走上編碼之旅的新手，本文都將提供具有價值的見解，以增強(qiáng)他們的工程技能。

Lombok的優(yōu)點(diǎn)

在深入研究潛在的缺陷之前，有必要認(rèn)識到Lombok的優(yōu)點(diǎn)。Lombok提供了幾個可以顯著簡化代碼編寫的注釋：

• Log注釋：Lombok的Log注釋允許開發(fā)人員快速生成日志代碼，減少對樣板代碼的需求。
• Builder注釋：Builder注釋通過開發(fā)增強(qiáng)代碼可讀性的構(gòu)建器方法，簡化了復(fù)雜對象的創(chuàng)建。

封裝的挑戰(zhàn)

Lombok的應(yīng)用并不是一帆風(fēng)順的。Lombok帶來的最重要的挑戰(zhàn)之一與封裝概念有關(guān)。封裝是面向?qū)ο缶幊痰幕驹瓌t，強(qiáng)調(diào)將數(shù)據(jù)(屬性)和對數(shù)據(jù)進(jìn)行操作的方法(函數(shù))捆綁到一個稱為類的單元中。它有助于維護(hù)數(shù)據(jù)完整性，并保護(hù)數(shù)據(jù)免受未經(jīng)授權(quán)的訪問。

• 數(shù)據(jù)注釋：Lombok的數(shù)據(jù)注釋雖然看起來很方便，但可能導(dǎo)致“貧血模型”。貧血模型是一個術(shù)語，用于描述主要存儲幾乎沒有行為的數(shù)據(jù)的對象。該注釋為類中的所有字段生成getter和setter方法，通過將內(nèi)部狀態(tài)暴露給外部操作，有效地破壞了封裝。

考慮這樣一個場景，其中有一個帶有敏感信息(如密碼字段)的User類。應(yīng)用Data注釋將自動為密碼字段生成getter和setter方法，從而可能允許對敏感數(shù)據(jù)進(jìn)行未經(jīng)授權(quán)的訪問。這可能導(dǎo)致安全漏洞和數(shù)據(jù)完整性問題。

• NotNull注釋：另一個挑戰(zhàn)來自Lombok的NotNull注釋。這里給出的建議是一些來自Java 8的帶有Objects.requireNonNull的顯式API。

為了解決Null值的問題，Java8和更高版本提供了一個內(nèi)置的解決方案。Objects.requireOnNull方法允許開發(fā)人員顯式檢查Null值，并在遇到Null值時拋出NullPointerException。這種方法提供了一種清晰簡潔的方法來處理Null檢查，確保基本字段不會未初始化。

以下是如何使用Objects.requireOnNull的示例：

Java 
 public void setUser(User user) {
 this.user = Objects.requireNonNull(user, "User must not be null");
 }

通過使用Objects.requireOnNull，開發(fā)人員可以更穩(wěn)健地執(zhí)行Null檢查，即使不依賴Lombok的NotNull注釋。

增強(qiáng)代碼模板和IDE支持

同樣需要注意的是，即使不使用Lombok，開發(fā)團(tuán)隊(duì)也可以在集成開發(fā)環(huán)境（IDE）中增強(qiáng)代碼模板。例如，流行的Java IDE IntelliJ IDEA為生成構(gòu)建器模式提供了原生支持。開發(fā)人員可以創(chuàng)建自定義代碼模板，或者使用IDE特定的功能來生成符合他們首選編碼標(biāo)準(zhǔn)的代碼。

通過利用IDE特性和定制模板，開發(fā)團(tuán)隊(duì)可以獲得Lombok的許多好處，例如減少樣板代碼和改進(jìn)代碼可讀性，同時保持對生成代碼的完全控制。

執(zhí)行最佳實(shí)踐的挑戰(zhàn)

在理想情況下，開發(fā)人員可以使用像Arch Unit這樣的工具來強(qiáng)制執(zhí)行編碼最佳實(shí)踐，并防止使用不安全的注釋。然而，事實(shí)表明，這說起來容易做起來難。通過自動化工具避免特定的Lombok注釋可能面臨挑戰(zhàn)或限制。這給代碼審查和開發(fā)人員帶來了更大的責(zé)任，以捕捉和糾正潛在的問題。

使用Lombok的權(quán)衡

像任何工具一樣，Lombok從代碼設(shè)計的角度進(jìn)行了權(quán)衡。它提供了便利，并減少了樣板代碼，但是也會給數(shù)據(jù)封裝帶來風(fēng)險，并且在代碼審查期間需要額外的警惕。在項(xiàng)目中使用Lombok的決定應(yīng)該經(jīng)過深思熟慮，需要考慮應(yīng)用程序的特定需求以及開發(fā)團(tuán)隊(duì)對Lombok的特性和潛在缺陷的熟悉程度。

結(jié)語

總之，Lombok是一個強(qiáng)大的工具，可以顯著提高Java開發(fā)中的代碼可讀性，并減少樣板代碼。但是必須謹(jǐn)慎使用它，特別是在數(shù)據(jù)封裝方面。了解潛在的缺陷(例如Data和NotNull注釋)對于維護(hù)代碼完整性和安全性至關(guān)重要。

與開發(fā)人員工具箱中的任何工具一樣，應(yīng)該謹(jǐn)慎地使用Lombok，仔細(xì)考慮它的優(yōu)點(diǎn)和缺點(diǎn)。充分了解Lombok的方法可以幫助用戶利用它的優(yōu)勢，同時降低風(fēng)險，最終生成更可維護(hù)和更安全的Java代碼。

因此，在Java項(xiàng)目中使用Lombok之前，需要記住揭示其代碼設(shè)計缺陷并做出明智的決策，以提高工程技能并確保代碼庫的完整性。

原文標(biāo)題：Unraveling Lombok's Code Design Pitfalls: Exploring Encapsulation Issues，作者：Otavio Santana