IDEA 2022 中的Lombok 使用基礎教學

2022-12-25 14:02:50

1.Lombok是什麼

Lombok是使用java編寫的一款開源類庫。其主作用是使用註解來代替一些具有格式固定，沒有過多技術含量的編碼工作。使我們可以僅僅在程式碼中新增一個註解(annotation),就可以起到和編寫一大段程式碼一樣的作用。對於這些格式固定的的程式碼，IDE也提供了自動生成的功能，但是無論是自動生成還是純手動寫，這些程式碼在類中是實實在在的存在，有時候，看到一個類檔案很長，其中卻都是一些，沒有任何技術含量的getter和setter方法。無疑會影響我們的程式碼閱讀。而使用Lombok可以將這些“無用”的程式碼，通過相應的註解替換掉。好了，廢話少說，進入主題：

1.上面說的“註解”具體是哪些註解？

2.這些註解又能代替哪些編碼工作呢？

3.lombok是如何實現以上功能的呢？

1.1 Lombok 是什麼？

官網：https://projectlombok.org/

Lombok 是一個 Java 庫，使用 Lombok 可以通過簡單的註解幫助我們消除 Java 的樣板程式碼，使程式碼更加簡潔清晰。

比如對於簡單的 Java 物件（POJO），很多的程式碼裡充斥著大量的 getter() 和 setter() 方法，樣板程式碼佔用比例高，影響可讀性，引入 Lombok 只需一個註解就能達到相同效果，而且更簡潔。

Lombok 引入

2、POM 中引入依賴

使用 Lombok 註解需要依賴它的庫。

Maven 庫：https://mvnrepository.com/artifact/org.projectlombok/lombok

<dependency>
  <groupId>org.projectlombok</groupId>
  <artifactId>lombok</artifactId>
  <version>1.18.16</version>
</dependency>

系統中如果有引入無需重複引入。

3、IDE 中安裝外掛

為什麼裝外掛？

因為 Lombok 的引入後，java 檔案使用 javac 編譯成的位元組碼檔案中就會包含 getter 和 setter 函數，但是原始碼中找不到定義，IDE 會認為這是錯誤，因此需要安裝一個 Lombok 的外掛，方便本地 IDE 的研發工作。

IDEA 中安裝：

Settings->Plugins->輸入框輸入”lombok”

4. Lombok 使用

比如要針對以下 Java 物件提供 getter() 和 setter() 方法：

public class Mountain {

    private String name;

    private String country;
}

只需要在類上打 @Getter 和 @Setter 註解。

@Getter
@Setter
public class Mountain {

    private String name;

    private String country;
}

然後用 maven 編譯一下：mvn clean compile。

使用的時候就可以正常拿到像 getCountry() 和 setCountry() 這樣的方法。通過 IDE 找方法呼叫處也可以直接鎖定到欄位上，以前要點兩下才能看到欄位明細資訊，使用 Lombok 點一下就能達到效果。

4.1 Lombok 使用注意

不建議直接使用 @Data 這種大而全的方式覆蓋太多的簡化場景。
toString 場景不建議使用 Lombok 的，建議使用系統自定義 ToString 裡的方法。
對外包考慮到接入方也需要引入依賴，如果擔心副作用，可以不引入。
其他註解酌情使用。

5.程式碼案例：

常用註解：@Getter/@Setter: 作用類上，生成所有成員變數的getter/setter方法；作用於成員變數上，生成該成員變數的getter/setter方法。可以設定存取許可權及是否懶載入等。

package com.libin;

import lombok.AccessLevel;
import lombok.Getter;
import lombok.Setter;

/**
 * Created by  libin
 * DESC: 測試類
 */
@SuppressWarnings("unused")
public class TestClass {

    public static void main(String[] args) {

    }
    @Getter(value = AccessLevel.PUBLIC)
    @Setter(value = AccessLevel.PUBLIC)
    public static class Person {
        private String name;
        private int age;
        private boolean friendly;
    }
    public static class Animal {
        private String name;
        private int age;
        @Getter @Setter private boolean funny;
    }
    
}

在Structure檢視中，可以看到已經生成了getter/setter等方法。

編譯後的程式碼如下：這也是傳統Java程式設計需要編寫的樣板程式碼。

//
// Source code recreated from a .class file by IntelliJ IDEA
// (powered by Fernflower decompiler)
//

package com.libin;

public class TestClass {
    public TestClass() {
    }

    public static void main(String[] args) {
    }

    public static class Animal {
        private String name;
        private int age;
        private boolean funny;

        public Animal() {
        }

        public boolean isFunny() {
            return this.funny;
        }

        public void setFunny(boolean funny) {
            this.funny = funny;
        }
    }

    public static class Person {
        private String name;
        private int age;
        private boolean friendly;

        public Person() {
        }

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

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

        public boolean isFriendly() {
            return this.friendly;
        }

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

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

        public void setFriendly(boolean friendly) {
            this.friendly = friendly;
        }
    }
}

@ToString：作用於類，覆蓋預設的toString()方法，可以通過of屬性限定顯示某些欄位，通過exclude屬性排除某些欄位。

@EqualsAndHashCode：作用於類，覆蓋預設的equals和hashCode

@NonNull：主要作用於成員變數和引數中，標識不能為空，否則丟擲空指標異常。

@NoArgsConstructor, @RequiredArgsConstructor, @AllArgsConstructor：作用於類上，用於生成建構函式。有staticName、access等屬性。

staticName屬性一旦設定，將採用靜態方法的方式生成範例，access屬性可以限定存取許可權。

@NoArgsConstructor：生成無參構造器；

@RequiredArgsConstructor：生成包含final和@NonNull註解的成員變數的構造器；

@AllArgsConstructor：生成全參構造器。

編譯後結果：

public static class Person {
    @NonNull
    private String name;
    private int age;
    private boolean friendly;

    public String toString() {
        return "TestClass.Person(name=" + this.getName() + ", age=" + this.getAge() + ")";
    }

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

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

    public boolean isFriendly() {
        return this.friendly;
    }

    public void setName(@NonNull String name) {
        if(name == null) {
            throw new NullPointerException("name");
        } else {
            this.name = name;
        }
    }

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

    public void setFriendly(boolean friendly) {
        this.friendly = friendly;
    }

    private Person() {
    }

    private static TestClass.Person of() {
        return new TestClass.Person();
    }

    @ConstructorProperties({"name"})
    Person(@NonNull String name) {
        if(name == null) {
            throw new NullPointerException("name");
        } else {
            this.name = name;
        }
    }

    @ConstructorProperties({"name", "age", "friendly"})
    public Person(@NonNull String name, int age, boolean friendly) {
        if(name == null) {
            throw new NullPointerException("name");
        } else {
            this.name = name;
            this.age = age;
            this.friendly = friendly;
        }
    }
}

@Data：作用於類上，是以下註解的集合：

@ToString @EqualsAndHashCode @Getter @Setter @RequiredArgsConstructor

@Builder：作用於類上，將類轉變為建造者模式

@Log：作用於類上，生成紀錄檔變數。針對不同的紀錄檔實現產品，有不同的註解：