溫馨提示×
您好，登錄后才能下訂單哦！
點擊 登錄注冊 即表示同意《億速云用戶服務(wù)條款》
您好，登錄后才能下訂單哦！
本篇內(nèi)容介紹了“Lombok的作用和使用方法”的有關(guān)知識，在實際案例的操作過程中，不少人都會遇到這樣的困境，接下來就讓小編帶領(lǐng)大家學(xué)習(xí)一下如何處理這些情況吧！希望大家仔細閱讀，能夠?qū)W有所成！
Lombok能以簡單的注解形式來簡化java代碼，提高開發(fā)人員的開發(fā)效率。例如開發(fā)中經(jīng)常需要寫的javabean，都需要花時間去添加相應(yīng)的getter/setter，也許還要去寫構(gòu)造器、equals等方法，而且需要維護，當屬性多時會出現(xiàn)大量的getter/setter方法，這些顯得很冗長也沒有太多技術(shù)含量，一旦修改屬性，就容易出現(xiàn)忘記修改對應(yīng)方法的失誤。
Lombok能通過注解的方式，在編譯時自動為屬性生成構(gòu)造器、getter/setter、equals、hashcode、toString方法。出現(xiàn)的神奇就是在源碼中沒有g(shù)etter和setter方法，但是在編譯生成的字節(jié)碼文件中有g(shù)etter和setter方法。這樣就省去了手動重建這些代碼的麻煩，使代碼看起來更簡潔些。
Lombok的使用跟引用jar包一樣，可以在官網(wǎng)（https://projectlombok.org/download）下載jar包，也可以使用maven添加依賴：
<dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> <version>1.16.20</version> <scope>provided</scope> </dependency>
@Data注解在類上，會為類的所有屬性自動生成setter/getter、equals、canEqual、hashCode、toString方法，如為final屬性，則不會為該屬性生成setter方法。
import lombok.AccessLevel;
import lombok.Setter;
import lombok.Data;
import lombok.ToString;
@Data public class DataExample {
private final String name;
@Setter(AccessLevel.PACKAGE) private int age;
private double score;
private String[] tags;
@ToString(includeFieldNames=true)
@Data(staticConstructor="of")
public static class Exercise<T> {
private final String name;
private final T value;
}
}如不使用Lombok，則實現(xiàn)如下：
import java.util.Arrays;
public class DataExample {
private final String name;
private int age;
private double score;
private String[] tags;
public DataExample(String name) {
this.name = name;
}
public String getName() {
return this.name;
}
void setAge(int age) {
this.age = age;
}
public int getAge() {
return this.age;
}
public void setScore(double score) {
this.score = score;
}
public double getScore() {
return this.score;
}
public String[] getTags() {
return this.tags;
}
public void setTags(String[] tags) {
this.tags = tags;
}
@Override public String toString() {
return "DataExample(" + this.getName() + ", " + this.getAge() + ", " + this.getScore() + ", " + Arrays.deepToString(this.getTags()) + ")";
}
protected boolean canEqual(Object other) {
return other instanceof DataExample;
}
@Override public boolean equals(Object o) {
if (o == this) return true;
if (!(o instanceof DataExample)) return false;
DataExample other = (DataExample) o;
if (!other.canEqual((Object)this)) return false;
if (this.getName() == null ? other.getName() != null : !this.getName().equals(other.getName())) return false;
if (this.getAge() != other.getAge()) return false;
if (Double.compare(this.getScore(), other.getScore()) != 0) return false;
if (!Arrays.deepEquals(this.getTags(), other.getTags())) return false;
return true;
}
@Override public int hashCode() {
final int PRIME = 59;
int result = 1;
final long temp1 = Double.doubleToLongBits(this.getScore());
result = (result*PRIME) + (this.getName() == null ? 43 : this.getName().hashCode());
result = (result*PRIME) + this.getAge();
result = (result*PRIME) + (int)(temp1 ^ (temp1 >>> 32));
result = (result*PRIME) + Arrays.deepHashCode(this.getTags());
return result;
}
public static class Exercise<T> {
private final String name;
private final T value;
private Exercise(String name, T value) {
this.name = name;
this.value = value;
}
public static <T> Exercise<T> of(String name, T value) {
return new Exercise<T>(name, value);
}
public String getName() {
return this.name;
}
public T getValue() {
return this.value;
}
@Override public String toString() {
return "Exercise(name=" + this.getName() + ", value=" + this.getValue() + ")";
}
protected boolean canEqual(Object other) {
return other instanceof Exercise;
}
@Override public boolean equals(Object o) {
if (o == this) return true;
if (!(o instanceof Exercise)) return false;
Exercise<?> other = (Exercise<?>) o;
if (!other.canEqual((Object)this)) return false;
if (this.getName() == null ? other.getValue() != null : !this.getName().equals(other.getName())) return false;
if (this.getValue() == null ? other.getValue() != null : !this.getValue().equals(other.getValue())) return false;
return true;
}
@Override public int hashCode() {
final int PRIME = 59;
int result = 1;
result = (result*PRIME) + (this.getName() == null ? 43 : this.getName().hashCode());
result = (result*PRIME) + (this.getValue() == null ? 43 : this.getValue().hashCode());
return result;
}
}
}如果覺得@Data太過殘暴（因為@Data集合了@ToString、@EqualsAndHashCode、@Getter/@Setter、@RequiredArgsConstructor的所有特性）不夠精細，可以使用@Getter/@Setter注解，此注解在屬性上，可以為相應(yīng)的屬性自動生成Getter/Setter方法，示例如下：
import lombok.AccessLevel;
import lombok.Getter;
import lombok.Setter;
public class GetterSetterExample {
@Getter @Setter private int age = 10;
@Setter(AccessLevel.PROTECTED) private String name;
@Override public String toString() {
return String.format("%s (age: %d)", name, age);
}
}如果不使用Lombok：
public class GetterSetterExample {
private int age = 10;
private String name;
@Override public String toString() {
return String.format("%s (age: %d)", name, age);
}
public int getAge() {
return age;
}
public void setAge(int age) {
this.age = age;
}
protected void setName(String name) {
this.name = name;
}
}該注解用在屬性或構(gòu)造器上，Lombok會生成一個非空的聲明，可用于校驗參數(shù)，能幫助避免空指針。
import lombok.NonNull;
public class NonNullExample extends Something {
private String name;
public NonNullExample(@NonNull Person person) {
super("Hello");
this.name = person.getName();
}
}不使用Lombok：
import lombok.NonNull;
public class NonNullExample extends Something {
private String name;
public NonNullExample(@NonNull Person person) {
super("Hello");
if (person == null) {
throw new NullPointerException("person");
}
this.name = person.getName();
}
}該注解能幫助我們自動調(diào)用close()方法，很大的簡化了代碼。
示例如下：
import lombok.Cleanup;
import java.io.*;
public class CleanupExample {
public static void main(String[] args) throws IOException {
@Cleanup InputStream in = new FileInputStream(args[0]);
@Cleanup OutputStream out = new FileOutputStream(args[1]);
byte[] b = new byte[10000];
while (true) {
int r = in.read(b);
if (r == -1) break;
out.write(b, 0, r);
}
}
}如不使用Lombok，則需如下：
import java.io.*;
public class CleanupExample {
public static void main(String[] args) throws IOException {
InputStream in = new FileInputStream(args[0]);
try {
OutputStream out = new FileOutputStream(args[1]);
try {
byte[] b = new byte[10000];
while (true) {
int r = in.read(b);
if (r == -1) break;
out.write(b, 0, r);
}
} finally {
if (out != null) {
out.close();
}
}
} finally {
if (in != null) {
in.close();
}
}
}
}默認情況下，會使用所有非靜態(tài)（non-static）和非瞬態(tài)（non-transient）屬性來生成equals和hasCode，也能通過exclude注解來排除一些屬性。
import lombok.EqualsAndHashCode;
@EqualsAndHashCode(exclude={"id", "shape"})
public class EqualsAndHashCodeExample {
private transient int transientVar = 10;
private String name;
private double score;
private Shape shape = new Square(5, 10);
private String[] tags;
private int id;
public String getName() {
return this.name;
}
@EqualsAndHashCode(callSuper=true)
public static class Square extends Shape {
private final int width, height;
public Square(int width, int height) {
this.width = width;
this.height = height;
}
}
}類使用@ToString注解，Lombok會生成一個toString()方法，默認情況下，會輸出類名、所有屬性（會按照屬性定義順序），用逗號來分割。
通過將includeFieldNames參數(shù)設(shè)為true，就能明確的輸出toString()屬性。這一點是不是有點繞口，通過代碼來看會更清晰些。
import lombok.ToString;
@ToString(exclude="id")
public class ToStringExample {
private static final int STATIC_VAR = 10;
private String name;
private Shape shape = new Square(5, 10);
private String[] tags;
private int id;
public String getName() {
return this.getName();
}
@ToString(callSuper=true, includeFieldNames=true)
public static class Square extends Shape {
private final int width, height;
public Square(int width, int height) {
this.width = width;
this.height = height;
}
}
}不使用Lombok的示例如下：
import java.util.Arrays;
public class ToStringExample {
private static final int STATIC_VAR = 10;
private String name;
private Shape shape = new Square(5, 10);
private String[] tags;
private int id;
public String getName() {
return this.getName();
}
public static class Square extends Shape {
private final int width, height;
public Square(int width, int height) {
this.width = width;
this.height = height;
}
@Override public String toString() {
return "Square(super=" + super.toString() + ", width=" + this.width + ", height=" + this.height + ")";
}
}
@Override public String toString() {
return "ToStringExample(" + this.getName() + ", " + this.shape + ", " + Arrays.deepToString(this.tags) + ")";
}
}無參構(gòu)造器、部分參數(shù)構(gòu)造器、全參構(gòu)造器。Lombok沒法實現(xiàn)多種參數(shù)構(gòu)造器的重載。
import lombok.AccessLevel;
import lombok.RequiredArgsConstructor;
import lombok.AllArgsConstructor;
import lombok.NonNull;
@RequiredArgsConstructor(staticName = "of")
@AllArgsConstructor(access = AccessLevel.PROTECTED)
public class ConstructorExample<T> {
private int x, y;
@NonNull private T description;
@NoArgsConstructor
public static class NoArgsExample {
@NonNull private String field;
}
}不使用Lombok的示例如下：
public class ConstructorExample<T> {
private int x, y;
@NonNull private T description;
private ConstructorExample(T description) {
if (description == null) throw new NullPointerException("description");
this.description = description;
}
public static <T> ConstructorExample<T> of(T description) {
return new ConstructorExample<T>(description);
}
@java.beans.ConstructorProperties({"x", "y", "description"})
protected ConstructorExample(int x, int y, T description) {
if (description == null) throw new NullPointerException("description");
this.x = x;
this.y = y;
this.description = description;
}
public static class NoArgsExample {
@NonNull private String field;
public NoArgsExample() {
}
}
}會發(fā)現(xiàn)在Lombok使用的過程中，只需要添加相應(yīng)的注解，無需再為此寫任何代碼。自動生成的代碼到底是如何產(chǎn)生的呢？
核心之處就是對于注解的解析上。JDK5引入了注解的同時，也提供了兩種解析方式。
運行時解析
運行時能夠解析的注解，必須將@Retention設(shè)置為RUNTIME，這樣就可以通過反射拿到該注解。java.lang,reflect反射包中提供了一個接口AnnotatedElement，該接口定義了獲取注解信息的幾個方法，Class、Constructor、Field、Method、Package等都實現(xiàn)了該接口，對反射熟悉的朋友應(yīng)該都會很熟悉這種解析方式。
編譯時解析
編譯時解析有兩種機制，分別簡單描述下：
1）Annotation Processing Tool
apt自JDK5產(chǎn)生，JDK7已標記為過期，不推薦使用，JDK8中已徹底刪除，自JDK6開始，可以使用Pluggable Annotation Processing API來替換它，apt被替換主要有2點原因：
api都在com.sun.mirror非標準包下
沒有集成到j(luò)avac中，需要額外運行
2）Pluggable Annotation Processing API
JSR 269自JDK6加入，作為apt的替代方案，它解決了apt的兩個問題，javac在執(zhí)行的時候會調(diào)用實現(xiàn)了該API的程序，這樣我們就可以對編譯器做一些增強，這時javac執(zhí)行的過程如下：
Lombok本質(zhì)上就是一個實現(xiàn)了“JSR 269 API”的程序。在使用javac的過程中，它產(chǎn)生作用的具體流程如下：
javac對源代碼進行分析，生成了一棵抽象語法樹（AST）
運行過程中調(diào)用實現(xiàn)了“JSR 269 API”的Lombok程序
此時Lombok就對第一步驟得到的AST進行處理，找到@Data注解所在類對應(yīng)的語法樹（AST），然后修改該語法樹（AST），增加getter和setter方法定義的相應(yīng)樹節(jié)點
javac使用修改后的抽象語法樹（AST）生成字節(jié)碼文件，即給class增加新的節(jié)點（代碼塊）
拜讀了Lombok源碼，對應(yīng)注解的實現(xiàn)都在HandleXXX中，比如@Getter注解的實現(xiàn)時HandleGetter.handle()。還有一些其它類庫使用這種方式實現(xiàn)，比如Google Auto、Dagger等等。
優(yōu)點：
能通過注解的形式自動生成構(gòu)造器、getter/setter、equals、hashcode、toString等方法，提高了一定的開發(fā)效率
讓代碼變得簡潔，不用過多的去關(guān)注相應(yīng)的方法
屬性做修改時，也簡化了維護為這些屬性所生成的getter/setter方法等
缺點：
不支持多種參數(shù)構(gòu)造器的重載
雖然省去了手動創(chuàng)建getter/setter方法的麻煩，但大大降低了源代碼的可讀性和完整性，降低了閱讀源代碼的舒適度
Lombok雖然有很多優(yōu)點，但Lombok更類似于一種IDE插件，項目也需要依賴相應(yīng)的jar包。Lombok依賴jar包是因為編譯時要用它的注解，為什么說它又類似插件？因為在使用時，eclipse或IntelliJ IDEA都需要安裝相應(yīng)的插件，在編譯器編譯時通過操作AST（抽象語法樹）改變字節(jié)碼生成，變向的就是說它在改變java語法。它不像spring的依賴注入或者mybatis的ORM一樣是運行時的特性，而是編譯時的特性。這里我個人最感覺不爽的地方就是對插件的依賴！因為Lombok只是省去了一些人工生成代碼的麻煩，但IDE都有快捷鍵來協(xié)助生成getter/setter等方法，也非常方便。
“Lombok的作用和使用方法”的內(nèi)容就介紹到這里了，感謝大家的閱讀。如果想了解更多行業(yè)相關(guān)的知識可以關(guān)注億速云網(wǎng)站，小編將為大家輸出更多高質(zhì)量的實用文章！
免責(zé)聲明：本站發(fā)布的內(nèi)容（圖片、視頻和文字）以原創(chuàng)、轉(zhuǎn)載和分享為主，文章觀點不代表本網(wǎng)站立場，如果涉及侵權(quán)請聯(lián)系站長郵箱：is@yisu.com進行舉報，并提供相關(guān)證據(jù)，一經(jīng)查實，將立刻刪除涉嫌侵權(quán)內(nèi)容。
億速云公眾號
手機網(wǎng)站二維碼
