# Lombok ## 簡介 `Lombok`是一種`Java?`實用工具，可用來幫助開發人員消除 Java 的冗長，尤其是對于簡單的 Java 對象（POJO）。它通過注解實現這一目的。 ## 插件安裝 * 由于`Lombok`采取注解形式，在編譯后，自動生成相應的方法，所以需要下載插件來支持它。 * 以 idea 為例：查找插件`lombok plugin`安裝即可。 ## 引入依賴 ~~~ <dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> <version>${lombok.version}</version> <scope>provided</scope> </dependency> ~~~ ## Lombok注解一覽 * @Setter * @Getter * @Data * @Log(這是一個泛型注解，具體有很多種形式) * @AllArgsConstructor * @NoArgsConstructor * @EqualsAndHashCode * @NonNull * @Cleanup * @ToString * @RequiredArgsConstructor * @Value * @SneakyThrows * @Synchronized ## 常用注解介紹 * @Getter和@Setter ：該注解可以使用在類上也可以使用在屬性上。生成的getter遵循布爾屬性的約定。在使用該注解時，會默認生成一個無參構造。和對應的`getter`、`setter`方法 ~~~ @Getter @Setter public class Notice { private Integer id; private String title; private Boolean isDeleted; } ~~~ 編譯后將會轉化為 ~~~ public class Notice { private Integer id; private String title; private Boolean isDeleted; public Notice() {} public Integer getId() { return id; } public void setId(Integer id) { this.id = id; } public String getTitle() { return title; } public void setTitle(String title) { this.title = title; } public Boolean getDeleted() { return isDeleted; } public void setDeleted(Boolean deleted) { isDeleted = deleted; } } ~~~ * @ToString ：該注解使用在**類**上，編譯后toString方法返回將會以字段的名稱-值的形式輸出 * @EqualsAndHashCode ：該注解使用在**類**上，同時生成`equals`和`hashCode`。 * @AllArgsConstructor ：該注解使用在**類**上，提供全參數的構造方法，默認不提供無參構造。 * @NoArgsConstructor ：該注解使用在**類**上，提供無參構造 * @Data ：使用`@Data`注解就可以有下面幾個注解的功能：`@ToString`、`@Getter`、`@Setter`、`@EqualsAndHashCode`、`@NoArgsConstructor`。 需要注意的是：同時使用`@Data`和`@AllArgsConstructor`后 ，默認的無參構造函數失效，如果需要它，要重新設置`@NoArgsConstructor` * @Slf4j ：在類上注解后，可直接調用log ~~~ log.info(xxxx); ~~~ * @Builder：bulder 模式構建對象。 * @Cleanup：自動化關閉流，相當于`try with resource` ~~~ @Cleanup InputStream in = new FileInputStream(args[0]); @Cleanup OutputStream out = new FileOutputStream(args[1]); ~~~ * @NonNull ：增加不為空判斷 ~~~ public NonNullExample(@NonNull Person person) { this.name = person.getName(); } ~~~ 轉換為： ~~~ public NonNullExample(@NonNull Person person) { if (person == null) { throw new NullPointerException("person"); } this.name = person.getName(); } ~~~ * @SneakyThrows ：當我們需要拋出異常，在當前方法上調用，不用顯示的在方法名后面寫 throw ~~~ @SneakyThrows(Exception.class) ~~~ * @Synchronized ：方法中所有的代碼都加入到一個代碼塊中，默認靜態方法使用的是全局鎖，普通方法使用的是對象鎖，當然也可以指定鎖的對象。 ~~~ private final Object lock = new Object(); @Synchronized("lock") public void foo() { // Do something } ~~~