lombok的使用

lombok概述

• lombok簡介
  
  Lombok想要解決了的是在咱們實體Bean中大量的Getter/Setter方法，以及toString, hashCode等可能不會用到，可是某些時候仍然須要複寫，以期方便使用的方法；在使用Lombok以後，將由其來自動幫你實現代碼生成，注意，其是 在運行過程當中，幫你自動生成的 。就是說，將極大減小你的代碼總量。

• lombok做用
  
  消除模板代碼
  
  getter、setter、構造器、toString()、equals()
  
  便捷的生成比較複雜的代碼，例如一個POJO要轉化成構建器模式的形式，只須要一個註解。

  SpringBoot中使用lombok

1. 添加依賴

<!-- https://mvnrepository.com/artifact/org.projectlombok/lombok --> <dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> <version>1.16.10</version> </dependency>

1. 編寫一個實體類 User，使用@Data註解

@Data public class User { private String name; private int age; }

1. 編寫測試方法，測試@Data的做用

@Test
public void testUser(){  
  User user = new User(); user.setName("AnyCode"); user.setAge(20); System.err.println(user.toString()); }

lombok的註解介紹

@NonNull : 讓你不在擔心而且愛上NullPointerException

@CleanUp : 自動資源管理：不用再在finally中添加資源的close方法

@Setter/@Getter : 自動生成set和get方法

@ToString : 自動生成toString方法

@EqualsAndHashcode : 從對象的字段中生成hashCode和equals的實現

@NoArgsConstructor/@RequiredArgsConstructor/@AllArgsConstructor
自動生成構造方法

@Data : 自動生成set/get方法，toString方法，equals方法，hashCode方法，不帶參數的構造方法

@Value : 用於註解final類

@Builder : 產生複雜的構建器api類

@SneakyThrows : 異常處理（謹慎使用）

@Synchronized : 同步方法安全的轉化

@Getter(lazy=true) :

@Log : 支持各類logger對象，使用時用對應的註解，如：@Log4j

@Slf4j:同上

推薦使用技巧

• 在 Bean / Entity 類上使用 @Data 註解。
• 須要使用 Log 對象的地方使用 @Log4j（依項目日誌框架決定）。

• 注意：lombok 的註解不能被繼承。

  IDEA中使用lombok

  若是想讓lombok生效咱們還須要針對idea工具進行插件的安裝，下面咱們按照順序打開Idea配置
  
  File > Settings > Plugins > Browse repositories... > 輸入lombok，插件就會被自動檢索出來,以下圖所示：
  
  
  個人工具已經安裝了該插件，全部在右側是沒有任何按鈕的，若是你的工具沒有安裝該插件,
  
  右側會有一個綠色的按鈕，按鈕的內容則是Install，點擊安裝後重啓Idea就能夠了。

  lombok經常使用註解詳解

• @EqualsAndHashCode，@ToString :告訴Lombok來生成 equals, hashCode方法，toString方法
  
  在生成這些方法的時候lombok會使用全部的成員變量。
• ** @AllArgsConstructor** :會自動建立一個包括全部成員的構造器。
• @Getter/@Setter: 註解會爲每個標記的成員變量自動生成對應的方法。
• 用例

package com.jxlg.lance.springbootcorestudy.lombok; import lombok.*; /** * @author lance(ZYH) * @function 測試其餘註解 * @date 2018-03-22 12:27 */ @EqualsAndHashCode @ToString @AllArgsConstructor public class Student { @Setter @Getter private String stuName; @Setter @Getter private Integer stuAge; @Setter @Getter private String stuClass; @Setter @Getter private Integer stuNumber; }

• 若是你不想將註解用在所有的成員變量上，而是僅僅部分變量上，那麼你能夠提供一個指定的哪個成員變量須要
  
  自動生成方法的變量。舉例： 好比在這裏，咱們只想讓stuName,stuAge兩個成員變量出如今 toString 方法裏。

@EqualsAndHashCode @ToString(of = {"stuName","stuAge"}) @AllArgsConstructor public class Student { @Setter @Getter private String stuName; @Setter @Getter private Integer stuAge; @Setter @Getter private String stuClass; @Setter @Getter private Integer stuNumber; }

• 這些代碼已經比咱們一開始要好太多了，可是它任然不夠簡潔。這裏重複了大量的 @Getter 和 @Setter 註解。
  
  若是你只是須要在Class中僅暴露幾個字段，那麼使用它們很是方便，但若是您須要爲全部字段生成訪問器，則會變得煩人又無聊。
  
  爲了使代碼更加簡潔， Lombok永續咱們在類級上使用這些註解。若是這些註解放在類名之上，
  
  那麼lombok會自動爲咱們生成全部字段的訪問方法。

@EqualsAndHashCode @ToString @AllArgsConstructor @Setter @Getter public class Student { private String stuName; private Integer stuAge; private String stuClass; private Integer stuNumber; }

• @Buidler :實例化這個類
• 用例

@EqualsAndHashCode @ToString @AllArgsConstructor @Setter @Getter @Builder public class Student { private String stuName; private Integer stuAge; private String stuClass; private Integer stuNumber; } 測試類： package com.jxlg.lance.springbootcorestudy.lombok; import org.junit.Test; import org.junit.runner.RunWith; import org.junit.runners.JUnit4; import static org.junit.Assert.*; @RunWith(JUnit4.class) public class StudentTest { @Test public void test(){ Student student = Student.builder() .stuName("張三") .stuAge(12) .stuClass("高三") .stuNumber(12222) .build(); System.out.println(student); } } 結果： Student(stuName=張三, stuAge=12, stuClass=高三, stuNumber=12222)

• @Data :簡單的來講全部全部的註解咱們均可以使用一個註解完成.也就是@Data
  
  咱們在定義類的時候 只須要加一個 @Data 註解，其餘的註解咱們都不須要在添加就能夠達到前面所說的全部功能。
• 經過上面介紹的，咱們日常使用Lombok只須要這樣就是就能夠了，以下：

@Data @Builder public class User { private String name; private Integer age