lombok是一個可以幫助我們簡化java代碼編寫的工具類,尤其是簡化javabean的編寫,即通過采用注解的方式,消除代碼中的構造方法,getter/setter等代碼,使我們寫的類更加簡潔,當然,這帶來的副作用就是不易閱讀…不過,還是能看得懂吧,廢話不多說,先看一下lombok支持的一些常見的注解。
@NonNull
這個注解可以用在成員方法或者構造方法的參數前面,會自動產生一個關於此參數的非空檢查,如果參數為空,則拋出一個空指針異常
@Cleanup
這個注解用在變量前面,可以保證此變量代表的資源會被自動關閉,默認是調用資源的close()方法,如果該資源有其它關閉方法,可使用@Cleanup(“methodName”)來指定要調用的方法
@Getter/@Setter
這一對注解從名字上就很好理解,用在成員變量前面,相當於為成員變量生成對應的get和set方法,同時還可以為生成的方法指定訪問修飾符,當然,默認為public。
這兩個注解還可以直接用在類上,可以為此類里的所有非靜態成員變量生成對應的get和set方法
@ToString/@EqualsAndHashCode
這兩個注解也比較好理解,就是生成toString,equals和hashcode方法,同時后者還會生成一個canEqual方法,用於判斷某個對象是否是當前類的實例,生成方法時只會使用類中的非靜態和非transient成員變量,這些都比較好理解,就不舉例子了。
當然,這兩個注解也可以添加限制條件,例如用@ToString(exclude={“param1”,“param2”})來排除param1和param2兩個成員變量,或者用@ToString(of={“param1”,“param2”})來指定使用param1和param2兩個成員變量,@EqualsAndHashCode注解也有同樣的用法。
@NoArgsConstructor/@RequiredArgsConstructor /@AllArgsConstructor
這三個注解都是用在類上的,第一個和第三個都很好理解,就是為該類產生無參的構造方法和包含所有參數的構造方法,第二個注解則使用類中所有帶有@NotNull注解的或者帶有final修飾的成員變量生成對應的構造方法,當然,和前面幾個注解一樣,成員變量都是非靜態的,另外,如果類中含有final修飾的成員變量,是無法使用@NoArgsConstructor注解的。
三個注解都可以指定生成的構造方法的訪問權限,同時,第二個注解還可以用@RequiredArgsConstructor(staticName=”methodName”)的形式生成一個指定名稱的靜態方法,返回一個調用相應的構造方法產生的對象,生成的構造方法是私有的private,這里來個例子:
@Data/@Value
Data注解綜合了3,4,5和6里面的@RequiredArgsConstructor注解,其中@RequiredArgsConstructor使用了類中的帶有@NonNull注解的或者final修飾的成員變量,它可以使用@Data(staticConstructor=”methodName”)來生成一個靜態方法,返回一個調用相應的構造方法產生的對象
Value注解和Data類似,區別在於它會把所有成員變量默認定義為private final修飾,並且不會生成set方法。
@SneakyThrows
這個注解用在方法上,可以將方法中的代碼用try-catch語句包裹起來,捕獲異常並在catch中用Lombok.sneakyThrow(e)把異常拋出,可以使用@SneakyThrows(Exception.class)的形式指定拋出哪種異常。
@Synchronized
這個注解用在類方法或者實例方法上,效果和synchronized關鍵字相同,區別在於鎖對象不同,對於類方法和實例方法,synchronized關鍵字的鎖對象分別是類的class對象和this對象,而@Synchronized得鎖對象分別是私有靜態final對象LOCK和私有final對象LOCK和私有final對象lock,當然,也可以自己指定鎖對象。
@Log
這個注解用在類上,可以省去從日志工廠生成日志對象這一步,直接進行日志記錄,具體注解根據日志工具的不同而不同,同時,可以在注解中使用topic來指定生成log對象時的類名。
————————————————————————————————————————————————————————————————————————————————————
本文大部分來源:
https://blog.csdn.net/sunsfan/article/details/53542374