@Data 注解的主要作用是提高代碼的簡潔猖凛,使用這個注解可以省去代碼中大量的get()、 set()、 toString()等方法;
引入lombok
要使用 @Data 注解要先引入lombok钠怯,lombok 是什么,它是一個工具類庫氧骤,可以用簡單的注解形式來簡化代碼,提高開發(fā)效率吃引。
- 在maven中添加依賴
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.18.4</version>
<scope>provided</scope>
</dependency>
- 在編譯器中添加插件
這里以IDEA為例筹陵,在setting的plugin里搜索lombok plugin
,安裝插件镊尺。
使用
直接在相應的實體類上加上@Data注解即可朦佩;
比如一個簡單的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;
}
自動生成相關的方法:
常用的幾個注解:
@Data : 注在類上庐氮,提供類的get语稠、set、equals弄砍、hashCode仙畦、canEqual、toString方法
@AllArgsConstructor : 注在類上音婶,提供類的全參構(gòu)造
@NoArgsConstructor : 注在類上慨畸,提供類的無參構(gòu)造
@Setter : 注在屬性上,提供 set 方法
@Getter : 注在屬性上衣式,提供 get 方法
@EqualsAndHashCode : 注在類上寸士,提供對應的 equals 和 hashCode 方法
@Log4j/@Slf4j : 注在類上,提供對應的 Logger 對象碴卧,變量名為 log
原理
Lombok本質(zhì)上就是一個實現(xiàn)了“JSR 269 API”的程序弱卡。在使用javac的過程中,它產(chǎn)生作用的具體流程如下:
- javac對源代碼進行分析住册,生成了一棵抽象語法樹(AST)
- 運行過程中調(diào)用實現(xiàn)了“JSR 269 API”的Lombok程序
- 此時Lombok就對第一步驟得到的AST進行處理婶博,找到@Data注解所在類對應的語法樹(AST),然后修改該語法樹(AST)荧飞,增加getter和setter方法定義的相應樹節(jié)點
- javac使用修改后的抽象語法樹(AST)生成字節(jié)碼文件凡蜻,即給class增加新的節(jié)點(代碼塊)
優(yōu)缺點
優(yōu)點:
- 能通過注解的形式自動生成構(gòu)造器搭综、getter/setter、equals划栓、hashcode兑巾、toString等方法,提高了一定的開發(fā)效率
- 讓代碼變得簡潔忠荞,不用過多的去關注相應的方法
- 屬性做修改時蒋歌,也簡化了維護為這些屬性所生成的getter/setter方法等
缺點:
- 不支持多種參數(shù)構(gòu)造器的重載
- 雖然省去了手動創(chuàng)建getter/setter方法的麻煩,但大大降低了源代碼的可讀性和完整性委煤,降低了閱讀源代碼的舒適度
像 lombok 這種插件堂油,已經(jīng)不僅僅是插件了,它在編譯器編譯時通過操作AST(抽象語法樹)改變字節(jié)碼生成碧绞,變相的說它就是在改變java語法府框,它改變了你編寫源碼的方式,它不像 spring 的依賴注入一樣是運行時的特性讥邻,而是編譯時的特性迫靖。如果一個項目有非常多這樣的插件,會極大的降低閱讀源代碼的舒適度兴使。
lombok 只是省去了一些人工生成代碼的麻煩系宜,但是這些getter/setter等等的方法,用IDE的快捷鍵也可很方便的生成发魄。況且盹牧,有時通過給getter/setter加一點點業(yè)務代碼(但通常不建議這么加),能極大的簡化某些業(yè)務場景的代碼励幼。
用還是不用汰寓,這中間如何取舍,自然是要看項目的需要苹粟,靈活運用踩寇。