重新認識Lombok

阿新 • • 發佈：2020-11-05

Lombok外掛

簡介

那麼lombok到底是個什麼呢，lombok是一個可以通過簡單的註解的形式來幫助我們簡化消除一些必須有但顯得很臃腫的 Java 程式碼的工具，簡單來說，比如我們新建了一個類，然後在其中寫了幾個欄位，然後通常情況下我們需要手動去建立getter和setter方法啊，建構函式啊之類的，lombok的作用就是為了省去我們手動建立這些程式碼的麻煩，它能夠在我們編譯原始碼的時候自動幫我們生成這些方法。

lombok能夠達到的效果就是在原始碼中不需要寫一些通用的方法，但是在編譯生成的位元組碼檔案中會幫我們生成這些方法，這就是lombok的神奇作用。

雖然有人可能會說IDE裡面都自帶自動生成這些方法的功能，但是使用lombok會使你的程式碼看起來更加簡潔，寫起來也更加方便。

安裝

一、idea下載安裝外掛

開啟 IDEA 的 Settings 面板，並選擇 Plugins 選項，然後點選 “Browse repositories”

在輸入框輸入”lombok”，得到搜尋結果，點選安裝，然後安裝提示重啟 IDEA，安裝成功;

二、引入依賴

在自己的專案裡新增 lombok 的編譯支援，在 pom 檔案裡面新增 dependency

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

三、簡單使用

在實體類上引入相關的註解即可！

Lombok實現原理

要講 Lombok 的實現原理，在此之前就需要來說下註解的兩種解析方式：執行時註解和編譯時註解
首先來看下執行時解析，比如 Spring 配置的 AOP 切面這些註解都是在程式執行的時候通過反射來獲取的註解值，但是隻有在程式執行時才能獲取到這些註解值，導致執行時程式碼效率很低，並且如果想在編譯階段利用這些註解來進行檢查，比如對使用者的不合理程式碼作出錯誤報告，反射的方法就行不通了。
這就引出了第二種在編譯時解析，Lombok 工具就是執行在編譯時解析的
那如何把註解與 Java 編譯器結合使用呢？Java 也提供了兩種解決方案：第一種方案是註解處理器（Annotation Processing Tool）

，它最早是在 JDK 1.5 與註解（Annotation） 一起引入的，它是一個命令列工具，能夠提供構建時基於原始碼對程式結構的讀取功能，能夠通過執行註解處理器來生成新的中間檔案，進而影響編譯過程，不過它在 JDK 1.8 中被移除了，取而代之的是** JSR 269 插入式註解處理器（Pluggable Annotation Processing API）**，它是實現了 JSR 269 的機制，作為註解處理器的替代方案。

我們通過一個流程圖來進一步說明註解處理器的工作原理：

常用註解

1. @getter / @setter :自動生成getter/setter方法

import lombok.AccessLevel;
    import lombok.Getter;
    import lombok.Setter;
    public class GetterSetterExample {
        @Getter @Setter private int age = 10;
        @Setter(AccessLevel.PROTECTED) private String name;
    }

2. @NoArgsConstructor:自動生成無參建構函式
3. @AllArgsConstructor:自動生成全參建構函式
4. @Date : 自動為所有欄位新增@ToString,@EqualsAndHashCode,@Getter,方法為非final修飾的欄位新增@Setter,@RequiredArgsConstructor方法
5. @NonNull :校驗引數，避免空指標,給方法引數增加這個註解會自動在方法內對該引數進行是否為空的校驗，如果為空，則丟擲 NPE（NullPointerException）

import lombok.NonNull;
    public class NonNullExample extends Something {
        private String name;  
        public NonNullExample(@NonNull Person person) {
        super("Hello");
        this.name = person.getName();
    }
}

6.@Cleanup:自動呼叫close()方法,自動管理資源，用在區域性變數之前，在當前變數範圍內即將執行完畢退出之前會自動清理資源，自動生成 ty-finally 這樣的程式碼來關閉流

import lombok.Cleanup;
import java.io.*;
public class CleanupExample {
    public static void main(String[] args) throws IOException {
        @Cleanup InputStream in = new FileInputStream(args[0]);
        @Cleanup OutputStream out = new FileOutputStream(args[1]);
        byte[] b = new byte[10000];
        while (true) {
            int r = in.read(b);
            if (r == -1) break;
            out.write(b, 0, r);
        }
    }
}

7. val：用在區域性變數前面，相當於將變數宣告為final

8. @ToString:用在類上可以自動覆寫 toString 方法，當然還可以加其他引數，例如 @ToString(exclude=”id”) 排除 id 屬性，或者 @ToString(callSuper=true, includeFieldNames=true) 呼叫父類的 toString 方法，包含所有屬性

9. @EqualAndHashCode:用在類上自動生成equals方法和hashCode方法
10. @NoArgsConstructor, @RequiredArgsConstructor and @AllArgsConstructor:用在類上，自動生成無參構造和使用所有引數的建構函式以及把所有 @NonNull 屬性作為引數的建構函式，如果指定 staticName="of" 引數，同時還會生成一個返回類物件的靜態工廠方法，比使用建構函式方便很多
11. @Value:用在類上，是@Date的不可變形式，相當於為屬性新增final宣告，只提供getter方法，而且不提供setter方法
12. @Builder：用在類、構造器、方法上，為你提供複雜的builder APIs，讓你可以像如下方式一樣呼叫

Person.builder().name("xxx").city("xxx").build()

13. @SneakyThrows:自動拋受檢異常，而無需顯式在方法上使用throws語句
14. @Synchronized:用在方法上，將方法宣告為同步的，並自動加鎖，而鎖物件是一個私有的屬性
15. @Getter(lazy=true):可以替代經典的**Double Check Lock **樣板程式碼
16. @Log:根據不同的註解生成不同型別的log物件，但例項名稱都是log，有六中可選實現類

註解使用詳細介紹

一、@Builder註解

1`@Builder`註解在專案中使用

Person.builder()
    .name("Adam Savage")
    .city("San Francisco")
    .job("Mythbusters")
    .job("Unchained Reaction")
    .build();

@Builder註解為你的類生成相對略微複雜的構建器API。@Builder可以讓你以上面顯示的那樣呼叫你的程式碼，來初始化你的例項物件
@Builder可以放在類，建構函式或方法上。放在類上和放在建構函式上這兩種模式是最常見的用例，但@Builder最容易用放在方法的用例來解釋。
使用@Builder註解的方法可以幫助我們完成很多事情：

  一個名為FooBuilder的**內部靜態類**，並具有和實體類形同的屬性（稱為構建器）。
  在構建器中：對於目標類中的所有的屬性和未初始化的final欄位，都會在構建器中建立對應屬性；
  在構建器中：建立一個無參的default建構函式。
  在構建器中：對於實體類中的每個引數，都會對應建立類似於“setter”的方法，只不多方法名與該引數名相同。 並且返回值是構建器本身（便於鏈式呼叫），如上例所示。
  在構建器中：一個build()方法，呼叫此方法，就會根據設定的值進行建立實體物件。
  在構建器中：同時也會生成一個toString()方法。
  在實體類中：會建立一個builder()方法，它的目的是用來建立構建器。

程式碼例項：

@Builder
public class User {
    private String username;
    private String password;
}

// 編譯後：
public class User {
    private String username;
    private String password;
    User(String username, String password) {
        this.username = username; this.password = password;
    }
    public static User.UserBuilder builder() {
        return new User.UserBuilder();
    }

    public static class UserBuilder {
        private String username;
        private String password;
        UserBuilder() {}

        public User.UserBuilder username(String username) {
            this.username = username;
            return this;
        }
        public User.UserBuilder password(String password) {
            this.password = password;
            return this;
        }
        public User build() {
            return new User(this.username, this.password);
        }
        public String toString() {
            return "User.UserBuilder(username=" + this.username + ", password=" + this.password + ")";
        }
    }
}

2. @Builder中使用@Singular 註釋集合

2.1 Singular註解在專案中使用

@Bulider註解也可以為集合型別的引數或欄位生成一種特殊的方法。它採用修改列表中一個元素而不是整個列表的方式，可以是增加一個元素，也可以是刪除一個元素
程式碼示例：

Person.builder()
    .job("Mythbusters")
    .job("Unchained Reaction")
    .build();

這樣就可以輕鬆地將List <String>欄位中包含2個字串。但是想要這樣來操作集合，你需要使用@Singular來註釋欄位或引數。

在使用@Singular註釋一個集合欄位（使用@Builder註釋類），lombok會將該構建器節點視為一個集合，並生成兩個adder方法而不是setter方法

一個向集合新增單個元素
一個將另一個集合的所有元素新增到集合中。

將不生成僅設定集合（替換已新增的任何內容）的setter。還生成了clear方法。這些singular構建器相對而言是有些複雜的，主要是來保證以下特性：

在呼叫build()時，生成的集合將是不可變的。

在呼叫build()之後呼叫其中一個adder方法或clear方法不會修改任何已經生成的物件。如果對集合修改之後，再呼叫build()，則會建立一個基於上一個物件建立的物件實體。

生成的集合將被壓縮到最小的可行格式，同時保持高效。

@Singular只能應用於lombok已知的集合型別。目前，支援的型別有：

java.util:
Iterable, Collection, 和List (一般情況下，由壓縮的不可修改的ArrayList支援).
Set, SortedSet, and NavigableSet (一般情況下，生成可變大小不可修改的HashSet或者TreeSet).
Map, SortedMap, and NavigableMap (一般情況下，生成可變大小不可修改的HashMap或者TreeMap).
Guava’s com.google.common.collect:
ImmutableCollection and ImmutableList
ImmutableSet and ImmutableSortedSet
ImmutableMap, ImmutableBiMap, and ImmutableSortedMap
ImmutableTable

@Singular註解之後的編譯情況：

@Builder
public class User {
    private final Integer id;
    private final String zipCode = "215500";
    private String username;
    private String password;
    @Singular
    private List<String> hobbies;
}

// 編譯後：
public class User {
    private final Integer id;
    private final String zipCode = "215500";
    private String username;
    private String password;
    private List<String> hobbies;
    User(Integer id, String username, String password, List<String> hobbies) {
        this.id = id; this.username = username;
        this.password = password; this.hobbies = hobbies;
    }

    public static User.UserBuilder builder() {return new User.UserBuilder();}

    public static class UserBuilder {
        private Integer id;
        private String username;
        private String password;
        private ArrayList<String> hobbies;
        UserBuilder() {}
        public User.UserBuilder id(Integer id) { this.id = id; return this; }
        public User.UserBuilder username(String username) { this.username = username; return this; }
        public User.UserBuilder password(String password) { this.password = password; return this; }

        public User.UserBuilder hobby(String hobby) {
            if (this.hobbies == null) {
                this.hobbies = new ArrayList();
            }
            this.hobbies.add(hobby);
            return this;
        }

        public User.UserBuilder hobbies(Collection<? extends String> hobbies) {
            if (this.hobbies == null) {
                this.hobbies = new ArrayList();
            }
            this.hobbies.addAll(hobbies);
            return this;
        }

        public User.UserBuilder clearHobbies() {
            if (this.hobbies != null) {
                this.hobbies.clear();
            }
            return this;
        }

        public User build() {
            List hobbies;
            switch(this.hobbies == null ? 0 : this.hobbies.size()) {
            case 0:
                hobbies = Collections.emptyList();
                break;
            case 1:
                hobbies = Collections.singletonList(this.hobbies.get(0));
                break;
            default:
                hobbies = Collections.unmodifiableList(new ArrayList(this.hobbies));
            }
            return new User(this.id, this.username, this.password, hobbies);
        }
        public String toString() {
            return "User.UserBuilder(id=" + this.id + ", username=" + this.username + ", password=" + this.password + ", hobbies=" + this.hobbies + ")";
        }
    }
}

lombok在進行build()來建立例項物件時，並沒有直接使用Collections.unmodifiableList(Collection)此方法來建立例項，而是分為三種情況：
1. 第一種，當集合中沒有元素時，建立一個空list；
2. 第二種情況，當集合中存在一個元素時，建立一個不可變的單元素list；
3. 第三種情況，根據當前集合的元素數量建立對應合適大小的list；

當然我們看編譯生成的程式碼，建立了三個關於集合操作的方法：

hobby(String hobby)：向集合中新增一個元素
hobbies(Collection<? extends String> hobbies)：新增一個集合所有的元素
clearHobbies()：清空當前集合資料

2.2@Singular註解配置詳解

@Singular 註解的詳情：

@Target({FIELD, PARAMETER})
@Retention(SOURCE)
public @interface Singular {
	// 修改新增集合元素的方法名
	String value() default "";
}

測試如何使用註解屬性vlaue

@Builder
public class User {
    private final Integer id;
    private final String zipCode = "215500";
    private String username;
    private String password;
    @Singular(value = "testHobbies")
    private List<String> hobbies;
}

// 測試類
public class BuilderTest {
    public static void main(String[] args) {
        User user = User.builder()
                .testHobbies("reading")
                .testHobbies("chatting")
                .id(1)
                .password("jdkong")
                .username("jdkong")
                .build();
        System.out.println(user);
    }
}

說明，當我們使用了註解屬性value之後，我們在使用新增集合元素時的方法名發生相應的改變。但是，同時生成的新增整個集合的方法名發生改變了嗎？我們再來看看編譯後的程式碼：

// 編譯後：
public class User {
	// 省略部分程式碼，只看關鍵部分
    public static class UserBuilder {
		public User.UserBuilder testHobbies(String testHobbies) {
            if (this.hobbies == null) {
                this.hobbies = new ArrayList();
            }
            this.hobbies.add(testHobbies);
            return this;
        }

        public User.UserBuilder hobbies(Collection<? extends String> hobbies) {
            if (this.hobbies == null) {
                this.hobbies = new ArrayList();
            }
            this.hobbies.addAll(hobbies);
            return this;
        }
        
        public User.UserBuilder clearHobbies() {
            if (this.hobbies != null) {
                this.hobbies.clear();
            }
            return this;
        }
    }
}

可以看到，只有新增一個元素的方法名發生了改變。

2.3 @Builder.Default 使用

比如有這樣一個實體類：

@Builder
@ToString
public class User {
    @Builder.Default
    private final String id = UUID.randomUUID().toString();
    private String username;
    private String password;
    @Builder.Default
    private long insertTime = System.currentTimeMillis();
}

在類中我在id和insertTime上都添加註解@Builder.Default，當我在使用這個實體物件時，我就不需要在為這兩個欄位進行初始化值，如下面這樣：

public class BuilderTest {
    public static void main(String[] args) {
        User user = User.builder()
                .password("jdkong")
                .username("jdkong")
                .build();
        System.out.println(user);
    }
}

// 輸出內容：
User(id=416219e1-bc64-43fd-b2c3-9f8dc109c2e8, username=jdkong, password=jdkong, insertTime=1546869309868)

lombok在例項化物件時就為我們初始化了這兩個欄位值。

當然，你如果再對這兩個欄位進行設值的話，那麼預設定義的值將會被覆蓋掉，如下面這樣：

public class BuilderTest {
    public static void main(String[] args) {
        User user = User.builder()
                .id("jdkong")
                .password("jdkong")
                .username("jdkong")
                .build();
        System.out.println(user);
    }
}
// 輸出內容
User(id=jdkong, username=jdkong, password=jdkong, insertTime=1546869642151)

2.4@Builder 詳細配置

下面我們再來詳細看看@Builder這個註解類地詳細實現：

@Target({TYPE, METHOD, CONSTRUCTOR})
@Retention(SOURCE)
public @interface Builder {
	// 如果@Builder註解在類上，可以使用 @Builder.Default指定初始化表示式
	@Target(FIELD)
	@Retention(SOURCE)
	public @interface Default {}
	// 指定實體類中建立 Builder 的方法的名稱，預設為: builder (個人覺得沒必要修改)
	String builderMethodName() default "builder";
	// 指定 Builder 中用來構件實體類的方法的名稱，預設為：build (個人覺得沒必要修改)
	String buildMethodName() default "build";
	// 指定建立的建造者類的名稱，預設為：實體類名+Builder
	String builderClassName() default "";
	// 使用toBuilder可以實現以一個例項為基礎繼續建立一個物件。（也就是重用原來物件的值）
	boolean toBuilder() default false;
	
	@Target({FIELD, PARAMETER})
	@Retention(SOURCE)
	public @interface ObtainVia {
		// 告訴lombok使用表示式獲取值
		String field() default "";
		// 告訴lombok使用表示式獲取值
		String method() default "";

		boolean isStatic() default false;
	}
}

以上註解屬性，我只測試一個比較常用的toBuilder，因為我們在對實體物件進行操作時，往往會存在對某些實體物件的某個欄位進行二次賦值，這個時候就會用到這一屬性。但是，這會建立一個新的物件，而不是原來的物件，原來的物件屬性是不可變的，除非你自己想要給這個實體類再新增上@Data或者@setter方法（我是這麼幹過，哈哈）。下面就來測試一下：

@Builder(toBuilder = true)
@ToString
public class User {
    private String username;
    private String password;
}
// 測試類
public class BuilderTest {
    public static void main(String[] args) {
        User user1 = User.builder()
                .password("jdkong")
                .username("jdkong")
                .build();
        System.out.println(user1);

        User user2 = user1.toBuilder().username("jdkong2").build();
        // 驗證user2是否是基於user1的現有屬性建立的
        System.out.println(user2);
        // 驗證物件是否是同一物件
        System.out.println(user1 == user2);
    }
}
// 輸出內容
User(username=jdkong, password=jdkong)
User(username=jdkong2, password=jdkong)
false

2.5 @Builder 全域性配置

# 是否禁止使用@Builder
lombok.builder.flagUsage = [warning | error] (default: not set)
#是否使用Guaua
lombok.singular.useGuava = [true | false] (default: false)
# 是否自動使用singular，預設是使用
lombok.singular.auto = [true | false] (default: true)

重新認識Lombok

Lombok外掛

簡介

安裝

一、idea下載安裝外掛

二、引入依賴

三、簡單使用

Lombok實現原理

常用註解

註解使用詳細介紹

一、@Builder註解

1`@Builder`註解在專案中使用

2. @Builder中使用@Singular 註釋集合

2.1 Singular註解在專案中使用

2.2@Singular註解配置詳解

2.3 @Builder.Default 使用

2.4@Builder 詳細配置

2.5 @Builder 全域性配置

重新認識Lombok

重新認識 D語言 —— 基礎篇

來，重新認識一個強大的 Gson！

重新認識ES6中的語法糖

Array,重新認識一下

重新認識資料庫的連結查詢

重新認識C語言

React元件設計：重新認識受控與非受控元件

重新認識HTTP3xx重定向機制

Mariadb 資料庫進階學習一表的重新認識

JVM重新認識（一）oop-kclass模型--HSDB使用驗證

javascript 之資料型別基礎(重新認識運算子) 習題解惑 nan

go 複用ssh 中的session_重新認識SSH（二）

重新認識面向物件(持續更新)

java中如何判斷物件中每一個欄位都為空_重新認識Java的包裝類

重新認識 CSS--BEM核心概念

來重新認識元組吧

【機器學習】重新認識支援向量機（SVM）

重新認識Docker Compose之Sidecar模式

重新學習Android —— （一）重新認識佈局編輯器

重新認識Lombok

Lombok外掛

簡介

安裝

一、idea下載安裝外掛

二、引入依賴

三、簡單使用

Lombok實現原理

常用註解

註解使用詳細介紹

一、@Builder註解

1@Builder註解在專案中使用

2. @Builder中使用@Singular 註釋集合

2.1 Singular註解在專案中使用

2.2@Singular註解配置詳解

2.3 @Builder.Default 使用

2.4@Builder 詳細配置

2.5 @Builder 全域性配置

相關推薦

1`@Builder`註解在專案中使用