Java 效率工具之 Lombok

2020 年 3 月 3 日
筆記

點擊上方 好好學java ，選擇星標公眾號重磅資訊、乾貨，第一時間送達今日推薦：用好Java中的枚舉，真的沒有那麼簡單！個人原創+1部落格：點擊前往，查看更多

作者：LiWenD正在掘金  鏈接：https://juejin.im/post/5b00517cf265da0ba0636d4b

還在編寫無聊枯燥又難以維護的POJO嗎？潔癖者的春天在哪裡？請看Lombok！

在過往的Java項目中，充斥著太多不友好的程式碼：POJO的getter/setter/toString；異常處理；I/O流的關閉操作等等，這些樣板程式碼既沒有技術含量，又影響著程式碼的美觀，Lombok應運而生。

首先說明一下：任何技術的出現都是為了解決某一類問題的，如果在此基礎上再建立奇技淫巧，不如回歸Java本身。應該保持合理使用而不濫用。

Lombok的使用非常簡單，下面我們一起來看下：

1）引入相應的maven包：

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

Lombok的scope=provided，說明它只在編譯階段生效，不需要打入包中。事實正是如此，Lombok在編譯期將帶Lombok註解的Java文件正確編譯為完整的Class文件。

2）添加IDE工具對Lombok的支援：

IDEA中引入Lombok支援如下：

點擊File– Settings設置介面，安裝Lombok插件：

點擊File– Settings設置介面，開啟Annocation Processors：

開啟該項是為了讓Lombok註解在編譯階段起到作用。

Eclipse的Lombok插件安裝可以自行百度，也比較簡單，值得一提的是，由於Eclipse內置的編譯器不是Oracle javac，而是eclipse自己實現的Eclipse Compiler for Java (ECJ).要讓ECJ支援Lombok，需要在eclipse.ini配置文件中添加如下兩項內容：

-Xbootclasspath/a:[lombok.jar所在路徑]

-javaagent:[lombok.jar所在路徑]

3）Lombok實現原理：

自從Java 6起，javac就支援「JSR 269 Pluggable Annotation Processing API」規範，只要程式實現了該API，就能在javac運行的時候得到調用。

Lombok就是一個實現了"JSR 269 API"的程式。在使用javac的過程中，它產生作用的具體流程如下：

javac對源程式碼進行分析，生成一棵抽象語法樹(AST)
javac編譯過程中調用實現了JSR 269的Lombok程式
此時Lombok就對第一步驟得到的AST進行處理，找到Lombok註解所在類對應的語法樹(AST)，然後修改該語法樹(AST)，增加Lombok註解定義的相應樹節點
javac使用修改後的抽象語法樹(AST)生成位元組碼文件

4) Lombok註解的使用：

POJO類常用註解：

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

package com.trace;    import lombok.AccessLevel;  import lombok.Getter;  import lombok.Setter;    /**   * Created by Trace on 2018/5/19.<br/>   * 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.trace;    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：**作用於類上，生成日誌變數。針對不同的日誌實現產品，有不同的註解：