4 使用@Data注解 與 lombok，告別Java屬性的set和get方法

@Data 注解的主要作用是提高代碼的簡潔，使用這個注解可以省去代碼中大量的get()、 set()、 toString()等方法；

引入lombok

要使用 @Data 注解要先引入lombok，lombok 是什么，它是一個工具類庫，可以用簡單的注解形式來簡化代碼，提高開發效率。

• 在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類，用常規的寫法：

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

自動生成相關的方法：

 

Person.png

常用的幾個注解：
@Data ： 注在類上，提供類的get、set、equals、hashCode、canEqual、toString方法
@AllArgsConstructor ： 注在類上，提供類的全參構造
@NoArgsConstructor ： 注在類上，提供類的無參構造
@Setter ： 注在屬性上，提供 set 方法
@Getter ： 注在屬性上，提供 get 方法
@EqualsAndHashCode ： 注在類上，提供對應的 equals 和 hashCode 方法
@Log4j/@Slf4j ： 注在類上，提供對應的 Logger 對象，變量名為 log

原理

Lombok本質上就是一個實現了“JSR 269 API”的程序。在使用javac的過程中，它產生作用的具體流程如下：

• javac對源代碼進行分析，生成了一棵抽象語法樹（AST）
• 運行過程中調用實現了“JSR 269 API”的Lombok程序
• 此時Lombok就對第一步驟得到的AST進行處理，找到@Data注解所在類對應的語法樹（AST），然后修改該語法樹（AST），增加getter和setter方法定義的相應樹節點
• javac使用修改后的抽象語法樹（AST）生成字節碼文件，即給class增加新的節點（代碼塊）

優缺點

優點：

• 能通過注解的形式自動生成構造器、getter/setter、equals、hashcode、toString等方法，提高了一定的開發效率
• 讓代碼變得簡潔，不用過多的去關注相應的方法
• 屬性做修改時，也簡化了維護為這些屬性所生成的getter/setter方法等

缺點：

• 不支持多種參數構造器的重載
• 雖然省去了手動創建getter/setter方法的麻煩，但大大降低了源代碼的可讀性和完整性，降低了閱讀源代碼的舒適度

像 lombok 這種插件，已經不僅僅是插件了，它在編譯器編譯時通過操作AST（抽象語法樹）改變字節碼生成，變相的說它就是在改變java語法，它改變了你編寫源碼的方式，它不像 spring 的依賴注入一樣是運行時的特性，而是編譯時的特性。如果一個項目有非常多這樣的插件，會極大的降低閱讀源代碼的舒適度。

lombok 只是省去了一些人工生成代碼的麻煩，但是這些getter/setter等等的方法，用IDE的快捷鍵也可很方便的生成。況且，有時通過給getter/setter加一點點業務代碼（但通常不建議這么加），能極大的簡化某些業務場景的代碼。

用還是不用，這中間如何取舍，自然是要看項目的需要，靈活運用。

作者：Jason_M_Ho
鏈接：https://www.jianshu.com/p/c1ee7e4247bf
來源：簡書
著作權歸作者所有。商業轉載請聯系作者獲得授權，非商業轉載請注明出處。