Java效率工具Lombok使用與原理

時間  2019-11-13
標籤 java 效率 工具 lombok 使用 原理 欄目 Java 简体版
原文   原文鏈接

Java效率工具Lombok使用與原理

我我的以爲 Lombok是一個優化Java代碼以及提高開發效率不錯的工具。Lombok 的Github地址爲：https://github.com/rzwitserloot/lombok ，目前已經有7.9k star。Lombok主要爲Java提供了很多語法糖，其中不少的設計都符合《Effective Java》所描述的Java編程最佳實踐。Lombok 的學習成本很低，幾乎能夠直接上手，可是在團隊開發的時候要注意，若是團隊開發要使用這種工具必定要溝通好，團隊其它人不必定裝了這個插件。總的來講，Lombok 是每個 Java 開發人員值得嘗試的一個工具。這篇文章是我當初學習 Lombok 以爲很是不錯的一篇文章，原文地址：Java效率工具之Lombok。java

簡介

Lombok 是一款好用順手的工具，就像 Google Guava 同樣，在此予以強烈推薦，每個Java工程師都應該使用它。Lombok 是一種 Java 實用工具，可用來幫助開發人員消除Java的冗長代碼，尤爲是對於簡單的Java對象（POJO）。它經過註釋實現這一目的。經過在開發環境中實現 Lombok，開發人員能夠節省構建諸如hashCode()和equals()這樣的方法以及以往用來分類各類accessor和mutator的大量時間。git

IntelliJ安裝Lombok

  1. 第一步：經過IntelliJ的插件中心安裝github

    IntelliJ IDEA Plugins

  2. 第二步：安裝插件apache

    安裝插件

  3. 最後須要注意的是，在使用lombok註解的時候記得要導入lombok.jar包到工程，若是使用的是Maven Project，要在pom.xml中添加依賴。編程

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

Lombok用法

Lombok註解說明

  • val：用在局部變量前面，至關於將變量聲明爲final
  • @NonNull：給方法參數增長這個註解會自動在方法內對該參數進行是否爲空的校驗，若是爲空，則拋出NPE（NullPointerException）
  • @Cleanup：自動管理資源，用在局部變量以前，在當前變量範圍內即將執行完畢退出以前會自動清理資源，自動生成try-finally這樣的代碼來關閉流。雖然自JDK7以來，原生引入了try--with--resource結構，但仍是不如@Cleanup來的簡潔。
  • @Getter/@Setter：用在屬性上，不再用本身手寫setter和getter方法了，還能夠指定訪問範圍
  • @ToString：用在類上，能夠自動覆寫toString方法，固然還能夠加其餘參數，例如@ToString(exclude=」id」)排除id屬性，或者@ToString(callSuper=true, includeFieldNames=true)調用父類的toString方法，包含全部屬性
  • @EqualsAndHashCode：用在類上，自動生成equals方法和hashCode方法
  • @NoArgsConstructor, @RequiredArgsConstructor and @AllArgsConstructor：用在類上，自動生成無參構造和使用全部參數的構造函數以及把全部@NonNull屬性做爲參數的構造函數，若是指定staticName = 「of」參數，同時還會生成一個返回類對象的靜態工廠方法，比使用構造函數方便不少
  • @Data：註解在類上，至關於同時使用了@ToString、@EqualsAndHashCode、@Getter、@Setter和@RequiredArgsConstrutor這些註解，對於POJO類十分有用
  • @Value：用在類上，是@Data的不可變形式，至關於爲屬性添加final聲明，只提供getter方法，而不提供setter方法
  • @Builder：用在類、構造器、方法上，爲你提供複雜的builder APIs，讓你能夠像以下方式同樣調用Person.builder().name("Adam Savage").city("San Francisco").job("Mythbusters").job("Unchained Reaction").build();更多說明參考Builder
  • @SneakyThrows：自動拋受檢異常，而無需顯式在方法上使用throws語句
  • @Synchronized：用在方法上，將方法聲明爲同步的，並自動加鎖，而鎖對象是一個私有的屬性$lock或$LOCK，而java中的synchronized關鍵字鎖對象是this，鎖在this或者本身的類對象上存在反作用，就是你不能阻止非受控代碼去鎖this或者類對象，這可能會致使競爭條件或者其它線程錯誤
  • @Getter(lazy=true)：能夠替代經典的Double Check Lock樣板代碼
  • @Log：根據不一樣的註解生成不一樣類型的log對象，可是實例名稱都是log，有六種可選實現類
  • @CommonsLog Creates log = org.apache.commons.logging.LogFactory.getLog(LogExample.class);
  • @Log Creates log = java.util.logging.Logger.getLogger(LogExample.class.getName());
  • @Log4j Creates log = org.apache.log4j.Logger.getLogger(LogExample.class);
  • @Log4j2 Creates log = org.apache.logging.log4j.LogManager.getLogger(LogExample.class);
  • @Slf4j Creates log = org.slf4j.LoggerFactory.getLogger(LogExample.class);
  • @XSlf4j Creates log = org.slf4j.ext.XLoggerFactory.getXLogger(LogExample.class);

Lombok代碼示例

  1. val 示例ide

    public static void main(String[] args) {
     val sets = new HashSet<String>();
     val lists = new ArrayList<String>();
     val maps = new HashMap<String, String>();
     //=>至關於以下
     final Set<String> sets2 = new HashSet<>();
     final List<String> lists2 = new ArrayList<>();
     final Map<String, String> maps2 = new HashMap<>();
 }

  2. @NonNull示例函數

    public void notNullExample(@NonNull String string) {
     string.length();
 }
 //=>至關於
 public void notNullExample(String string) {
     if (string != null) {
         string.length();
     } else {
         throw new NullPointerException("null");
     }
 }

  3. @Cleanup示例工具

    public static void main(String[] args) {
     try {
         @Cleanup InputStream inputStream = new FileInputStream(args[0]);
     } catch (FileNotFoundException e) {
         e.printStackTrace();
     }
     //=>至關於
     InputStream inputStream = null;
     try {
         inputStream = new FileInputStream(args[0]);
     } catch (FileNotFoundException e) {
         e.printStackTrace();
     } finally {
         if (inputStream != null) {
             try {
                 inputStream.close();
             } catch (IOException e) {
                 e.printStackTrace();
             }
         }
     }
 }

  4. @Getter/@Setter示例post

    @Setter(AccessLevel.PUBLIC)
 @Getter(AccessLevel.PROTECTED)
 private int id;
 private String shap;

  5. @ToString示例學習

    @ToString(exclude = "id", callSuper = true, includeFieldNames = true)
 public class LombokDemo {
     private int id;
     private String name;
     private int age;
     public static void main(String[] args) {
         //輸出LombokDemo(super=LombokDemo@48524010, name=null, age=0)
         System.out.println(new LombokDemo());
     }
 }

  6. @EqualsAndHashCode示例

    @EqualsAndHashCode(exclude = {"id", "shape"}, callSuper = false)
 public class LombokDemo {
     private int id;
     private String shap;
 }

  7. @NoArgsConstructor, @RequiredArgsConstructor and @AllArgsConstructor示例

    @NoArgsConstructor
 @RequiredArgsConstructor(staticName = "of")
 @AllArgsConstructor
 public class LombokDemo {
     @NonNull
     private int id;
     @NonNull
     private String shap;
     private int age;
     public static void main(String[] args) {
         new LombokDemo(1, "circle");
         //使用靜態工廠方法
         LombokDemo.of(2, "circle");
         //無參構造
         new LombokDemo();
         //包含全部參數
         new LombokDemo(1, "circle", 2);
     }
 }

  8. @Data示例

    import lombok.Data;
 @Data
 public class Menu {
     private String shopId;
     private String skuMenuId;
     private String skuName;
     private String normalizeSkuName;
     private String dishMenuId;
     private String dishName;
     private String dishNum;
     //默認閾值
     private float thresHold = 0;
     //新閾值
     private float newThresHold = 0;
     //總得分
     private float totalScore = 0;
 }

  9. @Value示例

    @Value
 public class LombokDemo {
     @NonNull
     private int id;
     @NonNull
     private String shap;
     private int age;
     //至關於
     private final int id;
     public int getId() {
         return this.id;
     }
     ...
 }

  10. @Builder示例

    @Builder
 public class BuilderExample {
     private String name;
     private int age;
     @Singular
     private Set<String> occupations;
     public static void main(String[] args) {
         BuilderExample test = BuilderExample.builder().age(11).name("test").build();
     }
 }

  11. @SneakyThrows示例

    import lombok.SneakyThrows;
 import java.io.FileInputStream;
 import java.io.FileNotFoundException;
 import java.io.InputStream;
 import java.io.UnsupportedEncodingException;
 public class Test {
     @SneakyThrows()
     public void read() {
         InputStream inputStream = new FileInputStream("");
     }
     @SneakyThrows
     public void write() {
         throw new UnsupportedEncodingException();
     }
     //至關於
     public void read() throws FileNotFoundException {
         InputStream inputStream = new FileInputStream("");
     }
     public void write() throws UnsupportedEncodingException {
         throw new UnsupportedEncodingException();
     }
 }

  12. @Synchronized示例

    public class SynchronizedDemo {
     @Synchronized
     public static void hello() {
         System.out.println("world");
     }
     //至關於
     private static final Object $LOCK = new Object[0];
     public static void hello() {
         synchronized ($LOCK) {
             System.out.println("world");
         }
     }
 }

  13. @Getter(lazy = true)

    public class GetterLazyExample {
     @Getter(lazy = true)
     private final double[] cached = expensive();
     private double[] expensive() {
         double[] result = new double[1000000];
         for (int i = 0; i < result.length; i++) {
             result[i] = Math.asin(i);
         }
         return result;
     }
 }

 // 至關於以下所示: 
 import java.util.concurrent.atomic.AtomicReference;
 public class GetterLazyExample {
     private final AtomicReference<java.lang.Object> cached = new AtomicReference<>();
     public double[] getCached() {
         java.lang.Object value = this.cached.get();
         if (value == null) {
             synchronized (this.cached) {
                 value = this.cached.get();
                 if (value == null) {
                     final double[] actualValue = expensive();
                     value = actualValue == null ? this.cached : actualValue;
                     this.cached.set(value);
                 }
             }
         }
         return (double[]) (value == this.cached ? null : value);
     }
     private double[] expensive() {
         double[] result = new double[1000000];
         for (int i = 0; i < result.length; i++) {
             result[i] = Math.asin(i);
         }
         return result;
     }
 }

Lombok註解原理

說到 Lombok，咱們就得去提到 JSR 269: Pluggable Annotation Processing API (www.jcp.org/en/jsr/deta…) 。JSR 269 以前咱們也有註解這樣的神器，但是咱們好比想要作什麼必須使用反射，反射的方法侷限性較大。首先，它必須定義@Retention爲RetentionPolicy.RUNTIME，只能在運行時經過反射來獲取註解值，使得運行時代碼效率下降。其次，若是想在編譯階段利用註解來進行一些檢查，對用戶的某些不合理代碼給出錯誤報告，反射的使用方法就無能爲力了。而 JSR 269 以後咱們能夠在 Javac的編譯期利用註解作這些事情。因此咱們發現核心的區分是在 運行期 仍是 編譯期。

JSR 269

從上圖可知，Annotation Processing 是在解析和生成之間的一個步驟。具體詳細步驟以下：

上圖是 Lombok 處理流程，在Javac 解析成抽象語法樹以後(AST), Lombok 根據本身的註解處理器，動態的修改 AST，增長新的節點(所謂代碼)，最終經過分析和生成字節碼。

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

  1. 經常使用的項目管理工具Maven所使用的java編譯工具來源於配置的第三方工具，若是咱們配置這個第三方工具爲Oracle javac的話，那麼Maven也就直接支持lombok了;
  2. Intellij Idea配置的編譯工具爲Oracle javac的話，也就直接支持lombok了;

IDE工具問題解決：

如今有一個A類，其中有一些字段，沒有建立它們的setter和getter方法，使用了lombok的@Data註解，另外有一個B類，它調用了A類實例的相應字段的setter和getter方法

編譯A類和B類所在的項目，並不會報錯，由於最終生成的A類字節碼文件中存在相應字段的setter和getter方法

可是，IDE發現B類源代碼中所使用的A類實例的setter和getter方法在A類源代碼中找不到定義，IDE會認爲這是錯誤

要解決以上這個不是真正錯誤的錯誤，能夠下載安裝Intellij Idea中的"Lombok plugin"。

自定義支持JSR269的註解

通常javac的編譯過程，java文件首先經過進行解析構建出一個AST，而後執行註解處理，最後通過分析優化生成二進制的.class文件。咱們能作到的是，在註解處理階段進行一些相應處理。首先咱們在META-INF.services下建立以下文件：

文件中指定咱們的註解處理器：com.alipay.kris.other.lombok.MyAnnotaionProcessor，而後咱們接能夠編寫本身的註解處理器，一個簡單的實例代碼以下：

@SupportedSourceVersion(SourceVersion.RELEASE_8)
@SupportedAnnotationTypes("com.alipay.kris.other.lombok.*")
public class MyAnnotaionProcessor extends AbstractProcessor {
    public MyAnnotaionProcessor() {
        super();
    }
    @Override
    public boolean process(Set<? extends TypeElement> annotations,RoundEnvironment roundEnv) {
        for (Element elem : roundEnv.getElementsAnnotatedWith(MyAnnotation.class)) {
            MyAnnotation annotation = elem.getAnnotation(MyAnnotation.class);
            String message = "annotation found in " + elem.getSimpleName()
                + " with  " + annotation.value();
            addToString(elem);
            processingEnv.getMessager().printMessage(Diagnostic.Kind.NOTE, message);
        }
        return true; // no further processing of this annotation type
    }
}
相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程