@Data 注解的主要作用是提高代碼的簡(jiǎn)潔,使用這個(gè)注解可以省去代碼中大量的get()、 set()、 toString()等方法;
引入lombok
要使用 @Data 注解要先引入lombok,lombok 是什么,它是一個(gè)工具類庫(kù),可以用簡(jiǎn)單的注解形式來(lái)簡(jiǎn)化代碼,提高開(kāi)發(fā)效率。
- 在maven中添加依賴
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.18.4</version>
<scope>provided</scope>
</dependency>
- 在編譯器中添加插件
這里以IDEA為例,在setting的plugin里搜索lombok plugin,安裝插件。
使用
直接在相應(yīng)的實(shí)體類上加上@Data注解即可;
比如一個(gè)簡(jiǎn)單的Person類,用常規(guī)的寫法:
public class Person {
private String name;
private String address;
private Integer age;
private String hobbit;
private String phone;
public Person() {
}
public Person(String name, String address, Integer age, String hobbit, String phone) {
this.name = name;
this.address = address;
this.age = age;
this.hobbit = hobbit;
this.phone = phone;
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public String getAddress() {
return address;
}
public void setAddress(String address) {
this.address = address;
}
public Integer getAge() {
return age;
}
public void setAge(Integer age) {
this.age = age;
}
public String getHobbit() {
return hobbit;
}
public void setHobbit(String hobbit) {
this.hobbit = hobbit;
}
public String getPhone() {
return phone;
}
public void setPhone(String phone) {
this.phone = phone;
}
@Override
public String toString() {
return "Person{" +
"name='" + name + '\'' +
", address='" + address + '\'' +
", age=" + age +
", hobbit='" + hobbit + '\'' +
", phone='" + phone + '\'' +
'}';
}
}
用@Data的寫法:
@Data
@AllArgsConstructor
@NoArgsConstructor
public class Person {
private String name;
private String address;
private Integer age;
private String hobbit;
private String phone;
}
自動(dòng)生成相關(guān)的方法:

常用的幾個(gè)注解:
@Data : 注在類上,提供類的get、set、equals、hashCode、canEqual、toString方法
@AllArgsConstructor : 注在類上,提供類的全參構(gòu)造
@NoArgsConstructor : 注在類上,提供類的無(wú)參構(gòu)造
@Setter : 注在屬性上,提供 set 方法
@Getter : 注在屬性上,提供 get 方法
@EqualsAndHashCode : 注在類上,提供對(duì)應(yīng)的 equals 和 hashCode 方法
@Log4j/@Slf4j : 注在類上,提供對(duì)應(yīng)的 Logger 對(duì)象,變量名為 log
原理
Lombok本質(zhì)上就是一個(gè)實(shí)現(xiàn)了“JSR 269 API”的程序。在使用javac的過(guò)程中,它產(chǎn)生作用的具體流程如下:
- javac對(duì)源代碼進(jìn)行分析,生成了一棵抽象語(yǔ)法樹(shù)(AST)
- 運(yùn)行過(guò)程中調(diào)用實(shí)現(xiàn)了“JSR 269 API”的Lombok程序
- 此時(shí)Lombok就對(duì)第一步驟得到的AST進(jìn)行處理,找到@Data注解所在類對(duì)應(yīng)的語(yǔ)法樹(shù)(AST),然后修改該語(yǔ)法樹(shù)(AST),增加getter和setter方法定義的相應(yīng)樹(shù)節(jié)點(diǎn)
- javac使用修改后的抽象語(yǔ)法樹(shù)(AST)生成字節(jié)碼文件,即給class增加新的節(jié)點(diǎn)(代碼塊)
優(yōu)缺點(diǎn)
優(yōu)點(diǎn):
- 能通過(guò)注解的形式自動(dòng)生成構(gòu)造器、getter/setter、equals、hashcode、toString等方法,提高了一定的開(kāi)發(fā)效率
- 讓代碼變得簡(jiǎn)潔,不用過(guò)多的去關(guān)注相應(yīng)的方法
- 屬性做修改時(shí),也簡(jiǎn)化了維護(hù)為這些屬性所生成的getter/setter方法等
缺點(diǎn):
- 不支持多種參數(shù)構(gòu)造器的重載
- 雖然省去了手動(dòng)創(chuàng)建getter/setter方法的麻煩,但大大降低了源代碼的可讀性和完整性,降低了閱讀源代碼的舒適度
像 lombok 這種插件,已經(jīng)不僅僅是插件了,它在編譯器編譯時(shí)通過(guò)操作AST(抽象語(yǔ)法樹(shù))改變字節(jié)碼生成,變相的說(shuō)它就是在改變java語(yǔ)法,它改變了你編寫源碼的方式,它不像 spring 的依賴注入一樣是運(yùn)行時(shí)的特性,而是編譯時(shí)的特性。如果一個(gè)項(xiàng)目有非常多這樣的插件,會(huì)極大的降低閱讀源代碼的舒適度。
lombok 只是省去了一些人工生成代碼的麻煩,但是這些getter/setter等等的方法,用IDE的快捷鍵也可很方便的生成。況且,有時(shí)通過(guò)給getter/setter加一點(diǎn)點(diǎn)業(yè)務(wù)代碼(但通常不建議這么加),能極大的簡(jiǎn)化某些業(yè)務(wù)場(chǎng)景的代碼。
用還是不用,這中間如何取舍,自然是要看項(xiàng)目的需要,靈活運(yùn)用。