1 簡介
Lombok是一款好用順手的工具铺呵，就像Google Guava一樣，在此予以強烈推薦，每一個Java工程師都應(yīng)該使用它删咱。Lombok是一種Java?實用工具，可用來幫助開發(fā)人員消除Java的冗長代碼豪筝，尤其是對于簡單的Java對象（POJO）痰滋。它通過注釋實現(xiàn)這一目的。通過在開發(fā)環(huán)境中實現(xiàn)Lombok续崖，開發(fā)人員可以節(jié)省構(gòu)建諸如hashCode()和equals()這樣的方法以及以往用來分類各種accessor和mutator的大量時間敲街。
2 IntelliJ安裝Lombok
-
通過IntelliJ的插件中心安裝
-
Install Plugin
最后需要注意的是，在使用lombok注解的時候記得要導(dǎo)入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：用在局部變量前面像吻，相當(dāng)于將變量聲明為final -
@NonNull：給方法參數(shù)增加這個注解會自動在方法內(nèi)對該參數(shù)進(jìn)行是否為空的校驗峻黍，如果為空，則拋出NPE（NullPointerException） -
@Cleanup：自動管理資源拨匆，用在局部變量之前姆涩，在當(dāng)前變量范圍內(nèi)即將執(zhí)行完畢退出之前會自動清理資源，自動生成try-finally這樣的代碼來關(guān)閉流 -
@Getter/@Setter：用在屬性上惭每，再也不用自己手寫setter和getter方法了骨饿，還可以指定訪問范圍 -
@ToString：用在類上，可以自動覆寫toString方法，當(dāng)然還可以加其他參數(shù)样刷，例如@ToString(exclude=”id”)排除id屬性仑扑，或者@ToString(callSuper=true, includeFieldNames=true)調(diào)用父類的toString方法，包含所有屬性 -
@EqualsAndHashCode：用在類上置鼻，自動生成equals方法和hashCode方法 -
@NoArgsConstructor, @RequiredArgsConstructor and @AllArgsConstructor：用在類上镇饮，自動生成無參構(gòu)造和使用所有參數(shù)的構(gòu)造函數(shù)以及把所有@NonNull屬性作為參數(shù)的構(gòu)造函數(shù)，如果指定staticName = “of”參數(shù)箕母，同時還會生成一個返回類對象的靜態(tài)工廠方法储藐，比使用構(gòu)造函數(shù)方便很多 -
@Data：注解在類上，相當(dāng)于同時使用了@ToString嘶是、@EqualsAndHashCode钙勃、@Getter、@Setter和@RequiredArgsConstrutor這些注解聂喇，對于POJO類十分有用 -
@Value：用在類上辖源，是@Data的不可變形式，相當(dāng)于為屬性添加final聲明希太，只提供getter方法克饶，而不提供setter方法 -
@Builder：用在類、構(gòu)造器誊辉、方法上矾湃，為你提供復(fù)雜的builder APIs，讓你可以像如下方式一樣調(diào)用Person.builder().name("Adam Savage").city("San Francisco").job("Mythbusters").job("Unchained Reaction").build();更多說明參考Builder -
@SneakyThrows：自動拋受檢異常堕澄，而無需顯式在方法上使用throws語句 -
@Synchronized：用在方法上邀跃，將方法聲明為同步的，并自動加鎖蛙紫，而鎖對象是一個私有的屬性$lock或$LOCK拍屑，而java中的synchronized關(guān)鍵字鎖對象是this，鎖在this或者自己的類對象上存在副作用惊来，就是你不能阻止非受控代碼去鎖this或者類對象丽涩，這可能會導(dǎo)致競爭條件或者其它線程錯誤 -
@Getter(lazy=true)：可以替代經(jīng)典的Double Check Lock樣板代碼 -
@Log：根據(jù)不同的注解生成不同類型的log對象棺滞，但是實例名稱都是log裁蚁，有六種可選實現(xiàn)類-
@CommonsLogCreates log = org.apache.commons.logging.LogFactory.getLog(LogExample.class); -
@LogCreates log = java.util.logging.Logger.getLogger(LogExample.class.getName()); -
@Log4jCreates log = org.apache.log4j.Logger.getLogger(LogExample.class); -
@Log4j2Creates log = org.apache.logging.log4j.LogManager.getLogger(LogExample.class); -
@Slf4jCreates log = org.slf4j.LoggerFactory.getLogger(LogExample.class); -
@XSlf4jCreates 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>();
//=>相當(dāng)于如下
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();
}
//=>相當(dāng)于
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();
}
//=>相當(dāng)于
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");
//使用靜態(tài)工廠方法
LombokDemo.of(2, "circle");
//無參構(gòu)造
new LombokDemo();
//包含所有參數(shù)
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;
//默認(rèn)閾值
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;
//相當(dāng)于
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();
}
//相當(dāng)于
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");
}
//相當(dāng)于
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;
}
}
// 相當(dāng)于如下所示:
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 (https://www.jcp.org/en/jsr/detail?id=269) 继准。JSR 269 之前我們也有注解這樣的神器枉证，可是我們比如想要做什么必須使用反射，反射的方法局限性較大移必。首先室谚，它必須定義@Retention為RetentionPolicy.RUNTIME，只能在運行時通過反射來獲取注解值，使得運行時代碼效率降低秒赤。其次猪瞬，如果想在編譯階段利用注解來進(jìn)行一些檢查癌蚁，對用戶的某些不合理代碼給出錯誤報告太颤，反射的使用方法就無能為力了。而 JSR 269 之后我們可以在 Javac的編譯期利用注解做這些事情窖式。所以我們發(fā)現(xiàn)核心的區(qū)分是在 運行期 還是 編譯期潮售。
從上圖可知痊项，Annotation Processing 是在解析和生成之間的一個步驟。具體詳細(xì)步驟如下：
上圖是 Lombok 處理流程酥诽，在Javac 解析成抽象語法樹之后(AST), Lombok 根據(jù)自己的注解處理器鞍泉，動態(tài)的修改 AST，增加新的節(jié)點(所謂代碼)肮帐，最終通過分析和生成字節(jié)碼咖驮。
自從Java 6起，javac就支持“JSR 269 Pluggable Annotation Processing API”規(guī)范训枢，只要程序?qū)崿F(xiàn)了該API游沿，就能在javac運行的時候得到調(diào)用。
- 常用的項目管理工具M(jìn)aven所使用的java編譯工具來源于配置的第三方工具肮砾，如果我們配置這個第三方工具為Oracle javac的話诀黍，那么Maven也就直接支持lombok了;
- Intellij Idea配置的編譯工具為Oracle javac的話，也就直接支持lombok了;
IDE工具問題解決：
現(xiàn)在有一個A類仗处，其中有一些字段眯勾，沒有創(chuàng)建它們的setter和getter方法，使用了lombok的@Data注解婆誓，另外有一個B類吃环，它調(diào)用了A類實例的相應(yīng)字段的setter和getter方法
編譯A類和B類所在的項目，并不會報錯洋幻，因為最終生成的A類字節(jié)碼文件中存在相應(yīng)字段的setter和getter方法
但是郁轻，IDE發(fā)現(xiàn)B類源代碼中所使用的A類實例的setter和getter方法在A類源代碼中找不到定義，IDE會認(rèn)為這是錯誤
要解決以上這個不是真正錯誤的錯誤文留，可以下載安裝Intellij Idea中的"Lombok plugin"好唯。
5 自定義支持JSR269的注解
一般javac的編譯過程，java文件首先通過進(jìn)行解析構(gòu)建出一個AST燥翅，然后執(zhí)行注解處理骑篙，最后經(jīng)過分析優(yōu)化生成二進(jìn)制的.class文件。我們能做到的是森书，在注解處理階段進(jìn)行一些相應(yīng)處理靶端。首先我們在META-INF.services下創(chuàng)建如下文件：
文件中指定我們的注解處理器：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
}
}
