lombok構造模式

lombok常用註解

@Getter / @Setter
可以作用在類上和屬性上,放在類上,會對所有的非靜態(non-static)屬性生成Getter/Setter方法,放在屬性上,會對該屬性生成Getter/Setter方法。並可以指定Getter/Setter方法的訪問級別。
@EqualsAndHashCode
默認情況下,會使用所有非瞬態(non-transient)和非靜態(non-static)字段來生成equals和hascode方法,也可以指定具體使用哪些屬性。
@ToString
生成toString方法,默認情況下,會輸出類名、所有屬性,屬性會按照順序輸出,以逗號分割。
@NoArgsConstructor, @RequiredArgsConstructor and @AllArgsConstructor
無參構造器、部分參數構造器、全參構造器,當我們需要重載多個構造器的時候,Lombok就無能爲力了。
@Data:包含@ToString, @EqualsAndHashCode, 所有屬性的@Getter, 所有non-final屬性的@Setter和@RequiredArgsConstructor的組合,通常情況下,基本上使用這些註解就足夠了。

lombok註解大全

@Data註解:在JavaBean或類JavaBean中使用,這個註解包含範圍最廣,它包含getter、setter、NoArgsConstructor、equals、canEqual、hashCode、toString 註解,即當使用當前註解時,會自動生成包含的所有方法;

@getter註解:在JavaBean或類JavaBean中使用,使用此註解會生成對應的getter方法;

@setter註解:在JavaBean或類JavaBean中使用,使用此註解會生成對應的setter方法;

@NoArgsConstructor註解:在JavaBean或類JavaBean中使用,使用此註解會生成對應的無參構造方法;

@AllArgsConstructor註解:在JavaBean或類JavaBean中使用,使用此註解會生成對應的有參構造方法;

@ToString註解:在JavaBean或類JavaBean中使用,使用此註解會自動重寫對應的toStirng方法;

@EqualsAndHashCode註解:在JavaBean或類JavaBean中使用,使用此註解會自動重寫對應的equals方法和hashCode方法;

@Slf4j:在需要打印日誌的類中使用,當項目中使用了slf4j打印日誌框架時使用該註解,會簡化日誌的打印流程,只需調用info方法即可;

@Log4j:在需要打印日誌的類中使用,當項目中使用了log4j打印日誌框架時使用該註解,會簡化日誌的打印流程,只需調用info方法即可;

@ToString:用在類上,可以自動覆寫toString方法,當然還可以加其他參數,例如@ToString(exclude=”id”)排除id屬性,或者@ToString(callSuper=true, includeFieldNames=true)調用父類的toString方法,包含所有屬性;

在使用以上註解需要處理參數時,處理方法如下(以@ToString註解爲例,其他註解同@ToString註解):

@ToString(exclude="column")排除column列所對應的元素,即在生成toString方法時不包含column參數;

@ToString(exclude={"column1","column2"})排除多個column列所對應的元素,其中間用英文狀態下的逗號進行分割,即在生成toString方法時不包含多個column參數;

@ToString(of="column")只生成包含column列所對應的元素的參數的toString方法,即在生成toString方法時只包含column參數;;

@ToString(of={"column1","column2"})只生成包含多個column列所對應的元素的參數的toString方法,其中間用英文狀態下的逗號進行分割,即在生成toString方法時只包含多個column參數;

@Value:用在類上,是@Data的不可變形式,相當於爲屬性添加final聲明,只提供getter方法,而不提供setter方法

@NotNull:這個註解可以用在成員方法或者構造方法的參數前面,會自動產生一個關於此參數的非空檢查,如果參數爲空,則拋出一個空指針異常;

@Cleanup:這個註解用在變量前面,可以保證此變量代表的資源會被自動關閉,自動生成try-finally這樣的代碼來關閉流,默認是調用資源的close()方法,如果該資源有其它關閉方法,可使用@Cleanup(“methodName”)來指定要調用的方法

@Builder:用在類、構造器、方法上,爲你提供複雜的builder APIs,讓你可以像如下方式一樣調用Person.builder().name("Adam Savage").city("San Francisco").job("Mythbusters").job("Unchained Reaction").build();

@SneakyThrows:這個註解用在方法上,可以將方法中的代碼用try-catch語句包裹起來,捕獲異常並在catch中用Lombok.sneakyThrow(e)把異常拋出,可以使用@SneakyThrows(Exception.class)的形式指定拋出哪種異常;

@Synchronized:這個註解用在類方法或者實例方法上,效果和synchronized關鍵字相同,將方法聲明爲同步的,並自動加鎖,區別在於鎖對象不同,對於類方法和實例方法,synchronized關鍵字的鎖對象分別是類的class對象和this對象,而@Synchronized得鎖對象分別是私有靜態final對象LOCK和私有final對象LOCK和私有final對象lock,當然,也可以自己指定鎖對象而鎖對象是一個私有的屬性$lock$LOCK,而java中的synchronized關鍵字鎖對象是this,鎖在this或者自己的類對象上存在副作用,就是你不能阻止非受控代碼去鎖this或者類對象,這可能會導致競爭條件或者其它線程錯誤;

@NoArgsConstructor, @RequiredArgsConstructor and @AllArgsConstructor:用在類上,自動生成無參構造和使用所有參數的構造函數以及把所有@NonNull屬性作爲參數的構造函數,如果指定staticName = “of”參數,同時還會生成一個返回類對象的靜態工廠方法,比使用構造函數方便很多

@Log:根據不同的註解生成不同類型的log對象,但是實例名稱都是log,有六種可選實現類

@CommonsLog Creates log = org.apache.commons.logging.LogFactory.getLog(LogExample.class);

@Log Creates log = java.util.logging.Logger.getLogger(LogExample.class.getName());

@Log4j Creates log = org.apache.log4j.Logger.getLogger(LogExample.class);

@Log4j2 Creates log = org.apache.logging.log4j.LogManager.getLogger(LogExample.class);

@Slf4j Creates log = org.slf4j.LoggerFactory.getLogger(LogExample.class);

@XSlf4j Creates log = org.slf4j.ext.XLoggerFactory.getXLogger(LogExample.class);

 

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章