你幹啥的？Lombok

来源:https://www.cnblogs.com/qing-gee/archive/2019/05/07/10823332.html
-Advertisement-
Play Games

01、Lombok 的自我介紹 Lombok 在官網是這樣作自我介紹的： Project Lombok makes java a spicier language by adding 'handlers' that know how to build and compile simple, boil ...


01、Lombok 的自我介紹

Lombok 在官網是這樣作自我介紹的：

Project Lombok makes java a spicier language by adding 'handlers' that know how to build and compile simple, boilerplate-free, not-quite-java code.

說實話，我英文不太好（不是找藉口，真的），但藉助金山詞霸，大致知道了這段英文的意思：Lombok 是個好類庫，可以為 Java 代碼添加一些“處理程式”，讓其變得更簡潔、更優雅。

據我已有的經驗來看，Lombok 最大的好處就在於通過註解的形式來簡化 Java 代碼，簡化到什麼程度呢？

我相信你一定寫過不少的 getter / setter，儘管可以藉助 IDE 來自動生成，可一旦 Javabean 的屬性很多，就免不了要產生大量的 getter / setter，這會讓代碼看起來不夠簡練，就像老太婆的裹腳布一樣，又臭又長。

class Cmower {
    private int age;
    private String name;
    private BigDecimal money;

    public int getAge() {
        return age;
    }

    public void setAge(int age) {
        this.age = age;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public BigDecimal getMoney() {
        return money;
    }

    public void setMoney(BigDecimal money) {
        this.money = money;
    }
}

Lombok 可以通過註解的方式，在編譯的時候自動為 Javabean 的屬性生成 getter / setter，不僅如此，還可以生成構造方法、equals、hashCode，以及 toString。註意是在編譯的時候哦，源碼當中是沒有 getter / setter 等等的。

@Getter
@Setter
class CmowerLombok {
    private int age;
    private String name;
    private BigDecimal money;
}

哎呀，源碼看起來苗條多了，對不對？

02、添加 Lombok 的依賴

如果項目使用 Maven 構建的話，添加Lombok 的依賴就變得輕而易舉了。

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

其中 scope=provided，就說明 Lombok 只在編譯階段生效。也就是說，Lombok 會在編譯期靜悄悄地將帶 Lombok 註解的源碼文件正確編譯為完整的 class 文件。

溫馨提示：只在項目中追加 Lombok 的依賴還不夠，還要為 IDE 添加 Lombok 支持，否則 Javabean 的 getter / setter 就無法自動編譯，也就不能被調用。

03、為 Eclipse 添加 Lombok 支持

第一步，下載 Lombok 的 jar 包。下載地址如下：

http://central.maven.org/maven2/org/projectlombok/lombok/1.18.6/lombok-1.18.6.jar

第二步，雙擊運行該 jar 包。

第三步，點擊「Install / Update」進行安裝。

第四步，重啟 Eclipse，完成項目的重新編譯。

可以通過 Outline 視圖查看已經編譯好的 getter / setter。是不是感覺很奇妙？

這時候，我們就可以使用 Lombok 註解過的 Javabean 了。

04、使用 Jad 查看 Lombok 位元組碼

曾經有一段時間，每個人選擇的反編譯工具都是 Jad。雖然 Jad 已經死了，不再更新了，但仍然有許多人需要它。比如說我就是其中一個。甚至在我的心目中，Jad 是最佳的 Java 反編譯工具，排名在 JD-GUI 之前。

Jad 的下載地址如下，包含各種平臺的版本：
http://www.javadecompilers.com/jad

下載完成後解壓，並不需要任何的安裝步驟。怎麼使用 Jad 呢？

jad CmowerLombok.class
// Parsing CmowerLombok.class... Generating CmowerLombok.jad

執行完以上命令後，會生成一個新的文件，尾碼為 .jad，使用文本編輯器打開後，內容如下：

// Decompiled by Jad v1.5.8g. Copyright 2001 Pavel Kouznetsov.
// Jad home page: http://www.kpdus.com/jad.html
// Decompiler options: packimports(3) 
// Source File Name:   CmowerLombok.java

package com.cmower.java_demo.lombok;

import java.math.BigDecimal;

class CmowerLombok
{

    CmowerLombok()
    {
    }

    public int getAge()
    {
        return age;
    }

    public String getName()
    {
        return name;
    }

    public BigDecimal getMoney()
    {
        return money;
    }

    public void setAge(int age)
    {
        this.age = age;
    }

    public void setName(String name)
    {
        this.name = name;
    }

    public void setMoney(BigDecimal money)
    {
        this.money = money;
    }

    private int age;
    private String name;
    private BigDecimal money;
}

嘿嘿，果然 getter / setter 就在裡面，這真是一件令人開心的事情，開心得我一巴掌拍在桌子上，差一點沒把手拍骨折，也不知道桌子疼不疼。

很早就有朋友勸我使用 Lombok，但我總覺得增加一個能夠產生任何現代 IDE 都能輕易產生的代碼的類庫沒有多大的價值（句子有點長，註意斷句）。現在我再也不會這麼覺得了，Lombok 為我節省了大量的生成樣板代碼的時間。

PS：需要註明一點的是，我首次查看 class 文件的時候遇到了巨坑，getter / setter 竟然不在其中，但是可以調用。試了很多的反編譯工具都不行。

於是我不得不在很多個群裡面發起了咨詢，很多大神都請教了，最後的結論是 Eclipse 的 Lombok 插件可能出了 bug。為此，我還下載了程式員開發利器——IntelliJ IDEA，但我用起來蹩手蹩腳，最後還是放棄了。

折騰了大概 3 個多小時候後，沒辦法，我只得重啟了 Eclipse（解決編譯問題的終極殺招），class 文件中莫名其妙地又出現了 getter / setter（還記得我拍桌子的興奮勁嗎？）。由此我得出的結論是，不管別人有沒有寫 Lombok 的教程，自己一定要親身實踐一番。

05、使用其他反編譯工具查看 Lombok 位元組碼

既然說到反編譯工具，我覺得有必要介紹另外一款優秀的反編譯工具——Enhanced Class Decompiler。

它將 JD、Jad、FernFlow、CFR、Procyon 與 Eclipse 無縫集成，並且允許 Java 開發人員直接調試類文件而不需要源代碼。這還不算完啊，它還集成了 Eclipse 類編輯器 M2E 插件，支持 Javadoc、參考搜索、庫源附加、位元組碼視圖和 JDK 8 lambda 表達式的語法。

總之，Enhanced Class Decompiler 要取代 Jad 在我心目中的位置了。

第一步，在 Eclipse Marketplace 搜索 jad。

第二步，直接點擊「Installed」按鈕進行安裝。安裝完成後重啟 Eclipse。

第三步，右鍵 target，選擇「Show In Remote Systems View」。

第四步，右鍵需要查看的 class 文件，依次選擇「Open With」→「Class Decompiler Viewer」。

看到反編譯後的代碼如下所示。

package com.cmower.java_demo.lombok;

import java.math.BigDecimal;

class CmowerLombok {
    private int age;
    private String name;
    private BigDecimal money;

    public int getAge() {
        return this.age;
    }

    public String getName() {
        return this.name;
    }

    public BigDecimal getMoney() {
        return this.money;
    }

    public void setAge(int age) {
        this.age = age;
    }

    public void setName(String name) {
        this.name = name;
    }

    public void setMoney(BigDecimal money) {
        this.money = money;
    }
}

PS：如果你想把 Enhanced Class Decompiler 設置為預設的 class 文件視圖的話，可以參照下圖哦。

06、常用的 Lombok 註解

1）@Getter / @Setter

@Getter / @Setter 用起來很靈活，比如說像下麵這樣：

class CmowerLombok {
    @Getter @Setter private int age;
    @Getter private String name;
    @Setter private BigDecimal money;
}

位元組碼文件反編譯後的內容是：

class CmowerLombok {
    private int age;
    private String name;
    private BigDecimal money;

    public int getAge() {
        return this.age;
    }

    public void setAge(int age) {
        this.age = age;
    }

    public String getName() {
        return this.name;
    }

    public void setMoney(BigDecimal money) {
        this.money = money;
    }
}

2）@ToString

列印日誌的好幫手哦。

@ToString
class CmowerLombok {
    private int age;
    private String name;
    private BigDecimal money;
}

位元組碼文件反編譯後的內容是：

class CmowerLombok {
    private int age;
    private String name;
    private BigDecimal money;

    public String toString() {
        return "CmowerLombok(age=" + this.age + ", name=" + this.name + ", money=" + this.money + ")";
    }
}

3）val

在編寫 JavaScript 代碼時，我一直覺得 var 這個變數聲明類型用起來特別方便。Lombok 也提供了一個類似的。

class CmowerLombok {
    public void test() {
        val names = new ArrayList<String>();
        names.add("沉默王二");
        val name = names.get(0);
        System.out.println(name);
    }
}

位元組碼文件反編譯後的內容是：

class CmowerLombok {
    public void test() {
        ArrayList<String> names = new ArrayList();
        names.add("沉默王二");
        String name = (String) names.get(0);
        System.out.println(name);
    }
}

4）@Data

@Data 註解可以生成 getter / setter、equals、hashCode，以及 toString，是個總和的選項。

@Data
class CmowerLombok {
    private int age;
    private String name;
    private BigDecimal money;
}

位元組碼文件反編譯後的內容是：

class CmowerLombok {
    private int age;
    private String name;
    private BigDecimal money;

    public int getAge() {
        return this.age;
    }

    public String getName() {
        return this.name;
    }

    public BigDecimal getMoney() {
        return this.money;
    }

    public void setAge(int age) {
        this.age = age;
    }

    public void setName(String name) {
        this.name = name;
    }

    public void setMoney(BigDecimal money) {
        this.money = money;
    }

    public boolean equals(Object o) {
        if (o == this) {
            return true;
        } else if (!(o instanceof CmowerLombok)) {
            return false;
        } else {
            CmowerLombok other = (CmowerLombok) o;
            if (!other.canEqual(this)) {
                return false;
            } else if (this.getAge() != other.getAge()) {
                return false;
            } else {
                Object this$name = this.getName();
                Object other$name = other.getName();
                if (this$name == null) {
                    if (other$name != null) {
                        return false;
                    }
                } else if (!this$name.equals(other$name)) {
                    return false;
                }

                Object this$money = this.getMoney();
                Object other$money = other.getMoney();
                if (this$money == null) {
                    if (other$money != null) {
                        return false;
                    }
                } else if (!this$money.equals(other$money)) {
                    return false;
                }

                return true;
            }
        }
    }

    protected boolean canEqual(Object other) {
        return other instanceof CmowerLombok;
    }

    public int hashCode() {
        int PRIME = true;
        int result = 1;
        int result = result * 59 + this.getAge();
        Object $name = this.getName();
        result = result * 59 + ($name == null ? 43 : $name.hashCode());
        Object $money = this.getMoney();
        result = result * 59 + ($money == null ? 43 : $money.hashCode());
        return result;
    }

    public String toString() {
        return "CmowerLombok(age=" + this.getAge() + ", name=" + this.getName() + ", money=" + this.getMoney() + ")";
    }
}

5）更多的 Lombok 註解，待你解鎖哦。

07、Lombok 的處理流程

一圖勝千言，我就先上圖了。

  • javac 對源代碼進行分析，生成一棵抽象語法樹（AST）

  • javac 編譯過程中調用實現了JSR 269 的 Lombok 程式

  • Lombok 對 AST 進行處理，找到 Lombok 註解所在類對應的語法樹（AST），然後修改該語法樹，增加 Lombok 註解定義的相應樹節點（所謂代碼）

  • javac 使用修改後的抽象語法樹生成位元組碼文件

 


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 結構型模式：享元模式
    文章首發： "結構型模式：享元模式" 七大結構型模式之六：享元模式。 簡介 姓名 ：享元模式 英文名 ：Flyweight Pattern 價值觀 ：共用富貴 個人介紹 ： Use sharing to support large numbers of fine grained objects ef ...
  • 設計模式 - Java中單例模式的6種寫法及優缺點對比
    本篇通過代碼講解6種不同的單例模式的實現方式, 分別是: 饑餓模式、懶惰模式、雙重檢查鎖模式、靜態內部類模式、枚舉類模式和ThreadLocal模式, 並分析了它們之間的優缺點, 最後還介紹了JDK中常見的單例模式的應用, 以及破壞單例模式的多種方法. ...
  • 運營日常：質量建立品牌
    現在APP的開發是愈發平常的事了，可是如何讓自己的APP真正留在用戶手機上，關鍵還是質量問題。 ...
  • gRPC全局異常捕獲
    gRPC全局異常捕獲 引 一般的.net項目比如ASP.NET、控制台程式、Windows服務、桌面程式等都會有framework自帶的全局異常捕獲機制。ASP.NET的ExceptionFilterAttribute，控制台和Windos服務的AppDomain.CurrentDomain.Unh ...
  • 組合模式(Composite Pattern)
    組合模式概述 定義：組合多個對象形成樹形結構以表示具有部分-整體關係的層次結構。組合模式讓客戶端可以統一對待單個對象和組合對象。又被成為“部分-整體”(Part-Whole)模式，屬於對象結構性模式 定義什麼的，最枯燥了。簡單的來說，就如我們滑鼠右擊新建文件夾一樣，在一個磁碟里，我們可以新建一個文件 ...
  • 設計模式之單例模式（一）
    這篇我們學習的是單例模式，相信很多朋友都或多或少使用過這個模式。很多設計模式的入門，都把單例模式作為第一個的，但是因為我們是跟著書本學習，所以放在了第五個裡面。那麼，你使用過的單例模式是怎麼樣的呢？懶漢式？餓漢式？雙重校驗？靜態？ 先來看下定義，單例模式（Singleton Pattern）： 用來 ...
  • PHP學習之PHP編碼習慣
    命名的註意事項： 命名要有實際含義 命名風格保持一致 不用拼音命名 不用語言關鍵字 適當的使用註釋 好的代碼應該是自描述的 難以理解的地方加上註釋 函數的功能加上註釋說明 類的功能和使用方法加註釋 多備份重要的代碼 代碼不能只有一份 啟用編譯器的自動備份 用代碼管理工具備份 堅持字元編碼統一 PHP ...
  • Ubuntu系統搭建django+nginx+uwsgi
    1. 在開發機上的準備工作 2. 在伺服器上的準備工作 3.安裝uwsgi 4.編寫uwsgi配置文件,使用配置文件啟動uwsgi 5. 安裝nginx 6. 收集靜態文件 7. 編寫nginx配置文件： 8. 使用supervisor配置 1. 在開發機上的準備工作 git init git re ...
一周排行
    -Advertisement-
    Play Games
  • WPF 已知問題 監聽 WMI 事件導致觸摸失效
    示例項目結構 在 Visual Studio 中創建一個 WinForms 應用程式後，項目結構如下所示： MyWinFormsApp/ │ ├───Properties/ │ └───Settings.settings │ ├───bin/ │ ├───Debug/ │ └───Release/ ...
  • [STAThread]特性
    [STAThread] 特性用於需要與 COM 組件交互的應用程式，尤其是依賴單線程模型（如 Windows Forms 應用程式）的組件。在 STA 模式下，線程擁有自己的消息迴圈，這對於處理用戶界面和某些 COM 組件是必要的。 [STAThread] static void Main(stri ...
  • UWP WinUI3 傳入 AddHandler 的 RoutedEventHandler 類型與事件所需不匹配將拋出參數異常
    在WinForm中使用全局異常捕獲處理 在WinForm應用程式中，全局異常捕獲是確保程式穩定性的關鍵。通過在Program類的Main方法中設置全局異常處理，可以有效地捕獲並處理未預見的異常，從而避免程式崩潰。 註冊全局異常事件 [STAThread] static void Main() { / ...
  • .NET 多版本 WinForm 開源控制項庫 SunnyUI
    前言 給大家推薦一款開源的 Winform 控制項庫，可以幫助我們開發更加美觀、漂亮的 WinForm 界面。 項目介紹 SunnyUI.NET 是一個基於 .NET Framework 4.0+、.NET 6、.NET 7 和 .NET 8 的 WinForm 開源控制項庫，同時也提供了工具類庫、擴展 ...
  • .net core8 使用Swagger（附當前源碼）
    說明 該文章是屬於OverallAuth2.0系列文章，每周更新一篇該系列文章（從0到1完成系統開發）。 該系統文章，我會儘量說的非常詳細，做到不管新手、老手都能看懂。 說明：OverallAuth2.0 是一個簡單、易懂、功能強大的許可權+可視化流程管理系統。 有興趣的朋友，請關註我吧(*^▽^*) ...
  • WPF 什麼時候 VisualTreeHelper.GetDescendantBounds 將返回無窮大
    一、下載安裝 1.下載git 必須先下載並安裝git，再TortoiseGit下載安裝 git安裝參考教程：https://blog.csdn.net/mukes/article/details/115693833 2.TortoiseGit下載與安裝 TortoiseGit，Git客戶端，32/6 ...
  • C# 開源教程帶你輕鬆掌握數據結構與演算法
    前言 在項目開發過程中，理解數據結構和演算法如同掌握蓋房子的秘訣。演算法不僅能幫助我們編寫高效、優質的代碼，還能解決項目中遇到的各種難題。 給大家推薦一個支持C#的開源免費、新手友好的數據結構與演算法入門教程：Hello演算法。 項目介紹 《Hello Algo》是一本開源免費、新手友好的數據結構與演算法入門 ...
  • 第22篇 生成proto文件bat腳本
    1.生成單個Proto.bat內容 @rem Copyright 2016, Google Inc. @rem All rights reserved. @rem @rem Redistribution and use in source and binary forms, with or with ...
  • 記一次 .NET某上位機視覺程式 卡死分析
    一：背景 1. 講故事 前段時間有位朋友找到我，說他的窗體程式在客戶這邊出現了卡死，讓我幫忙看下怎麼回事？dump也生成了，既然有dump了那就上 windbg 分析吧。 二：WinDbg 分析 1. 為什麼會卡死 窗體程式的卡死，入口門檻很低，後續往下分析就不一定了，不管怎麼說先用 !clrsta ...
  • 醫學DICOM文件與PACS系統進行數據傳輸
    前言 人工智慧時代，人臉識別技術已成為安全驗證、身份識別和用戶交互的關鍵工具。 給大家推薦一款.NET 開源提供了強大的人臉識別 API，工具不僅易於集成，還具備高效處理能力。 本文將介紹一款如何利用這些API，為我們的項目添加智能識別的亮點。 項目介紹 GitHub 上擁有 1.2k 星標的 C# ...
所有分類