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

1 簡介

2 IntelliJ安裝Lombok

通過IntelliJ的插件中心安裝

十分鐘搞懂Lombok使用與原理
Install Plugin

十分鐘搞懂Lombok使用與原理
最後需要注意的是，在使用lombok注解的時候記得要導入lombok.jar包到工程，如果使用的是Maven Project，要在pom.xml中添加依賴。

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

3 Lombok用法

3.1 Lombok注解說明

val ：用在局部變量前面，相當于将變量聲明為final
@NonNull ：給方法參數增加這個注解會自動在方法内對該參數進行是否為空的校驗，如果為空，則抛出NPE（NullPointerException）
@Cleanup ：自動管理資源，用在局部變量之前，在目前變量範圍内即将執行完畢退出之前會自動清理資源，自動生成try-finally這樣的代碼來關閉流
@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);

3.2 Lombok代碼示例

val示例

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<>();
}

@NonNull示例

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

@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();
            }
        }
    }
}

@Getter/@Setter示例

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

@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());
    }
}

@EqualsAndHashCode示例

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

@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);
    }
}

@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;
}

@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;
    }
    ...
}

@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();
    }
}

@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();
    }
}

@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");
        }
    }
}

@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;
    }
}

4 Lombok注解原理

說道 Lombok，我們就得去提到 JSR 269: Pluggable Annotation Processing API (www.jcp.org/en/jsr/deta…) 。JSR 269 之前我們也有注解這樣的神器，可是我們比如想要做什麼必須使用反射，反射的方法局限性較大。首先，它必須定義@Retention為RetentionPolicy.RUNTIME，隻能在運作時通過反射來擷取注解值，使得運作時代碼效率降低。其次，如果想在編譯階段利用注解來進行一些檢查，對使用者的某些不合理代碼給出錯誤報告，反射的使用方法就無能為力了。而 JSR 269 之後我們可以在 Javac的編譯期利用注解做這些事情。是以我們發現核心的區分是在運作期還是編譯期。

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

上圖是 Lombok 處理流程，在Javac 解析成抽象文法樹之後(AST), Lombok 根據自己的注解處理器，動态的修改 AST，增加新的節點(所謂代碼)，最終通過分析和生成位元組碼。

自從Java 6起，javac就支援“JSR 269 Pluggable Annotation Processing API”規範，隻要程式實作了該API，就能在javac運作的時候得到調用。

常用的項目管理工具Maven所使用的java編譯工具來源于配置的第三方工具，如果我們配置這個第三方工具為Oracle javac的話，那麼Maven也就直接支援lombok了;

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"。

5 自定義支援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
    }
}

十分鐘搞懂Lombok使用與原理

1 簡介

2 IntelliJ安裝Lombok

3 Lombok用法

3.1 Lombok注解說明

3.2 Lombok代碼示例

4 Lombok注解原理

5 自定義支援JSR269的注解

繼續閱讀

關于Gradle配置的小結

Java小案例——随機數猜測随機數猜測

nginx location中斜線的位置的重要性

27 Best Free Eclipse Plug-ins for Java Developer to be ProductiveCode Quality PluginsText Editor PluginsDependency ManagementVersion Control Integration PluginsFramework Development Continuous Integration Related PluginsOther Utility Plugins

Java String.format方法的簡單使用

neo4j之cypher使用文檔

GitHub連夜封殺！這份阿裡 10W 字内部 Java 字面試手冊到底有多強？

spark/scala關于【資源檔案】加載方法概述外部檔案加載方案測試資源檔案打包入jar包中小結

mybatis_入門程式Mybatis入門

AOP程式設計_Android優雅權限架構(1)概念基礎，2021金三銀四前言正文大綱正文

Effective Java 8:通用程式設計

OOM三種類型

工廠模式-三種類型

【遞歸】高效率求2的n次幂

win10本地scala和spark安裝安裝scala安裝spark

scala (3) Function 和 Method