Java效率工具Lombok使用及原理

時間 2019-11-08

標籤 java 效率工具 lombok 使用原理欄目 Java 简体版

原文原文鏈接

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

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

首先說明一下：任何技術的出現都是爲了解決某一類問題的，若是在此基礎上再創建奇技淫巧，不如迴歸Java自己。應該保持合理使用而不濫用。bash

Lombok的使用很是簡單，下面咱們一塊兒來看下：eclipse

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文件。maven

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

IDEA中引入Lombok支持以下：點擊File-- Settings設置界面，安裝Lombok插件：ide

點擊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類經常使用註解：ui

@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;
        }
    }
}
複製代碼