Java的Lombok如何使用

本篇內容主要講解“Java的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：作用于類上，生成日志變量。針對不同的日志實現產品，有不同的注解：

其他重要注解：

@Cleanup：自動關閉資源，針對實現了java.io.Closeable接口的對象有效，如：典型的IO流對象

編譯后結果如下：

是不是簡潔了太多。

@SneakyThrows：可以對受檢異常進行捕捉并拋出，可以改寫上述的main方法如下：

@Synchronized：作用于方法級別，可以替換synchronize關鍵字或lock鎖，用處不大。

到此，相信大家對“Java的Lombok如何使用”有了更深的了解，不妨來實際操作一番吧！這里是億速云網站，更多相關內容可以進入相關頻道進行查詢，關注我們，繼續學習！