lombok注解介紹小結(jié)
lombok注解介紹
lombok是一個可以幫助我們簡化java代碼編寫的工具類,尤其是簡化javabean的編寫,即通過采用注解的方式,消除代碼中的構(gòu)造方法,getter/setter等代碼,使我們寫的類更加簡潔,當(dāng)然,這帶來的副作用就是不易閱讀…不過,還是能看得懂吧,廢話不多說,先看一下lombok支持的一些常見的注解。
- @NonNull
- @Cleanup
- @Getter/@Setter
- @ToString
- @EqualsAndHashCode
- @NoArgsConstructor/@RequiredArgsConstructor /@AllArgsConstructor
- @Data
- @Value
- @SneakyThrows
- @Synchronized
- @Log
@NonNull
這個注解可以用在成員方法或者構(gòu)造方法的參數(shù)前面,會自動產(chǎn)生一個關(guān)于此參數(shù)的非空檢查,如果參數(shù)為空,則拋出一個空指針異常,舉個例子來看看:
//成員方法參數(shù)加上@NonNull注解 public String getName(@NonNull Person p){ return p.getName(); }
實(shí)際效果相當(dāng)于:
public String getName(@NonNull Person p){ if(p==null){ throw new NullPointerException("person"); } return p.getName(); }
用在構(gòu)造方法的參數(shù)上效果類似,就不再舉例子了。
@Cleanup
這個注解用在變量前面,可以保證此變量代表的資源會被自動關(guān)閉,默認(rèn)是調(diào)用資源的close()方法,如果該資源有其它關(guān)閉方法,可使用@Cleanup(“methodName”)來指定要調(diào)用的方法,就用輸入輸出流來舉個例子吧:
public static void main(String[] args) throws IOException { @Cleanup InputStream in = new FileInputStream(args[0]); @Cleanup OutputStream out = new FileOutputStream(args[1]); byte[] b = new byte[1024]; while (true) { int r = in.read(b); if (r == -1) break; out.write(b, 0, r); } }
實(shí)際效果相當(dāng)于:
public static void main(String[] args) throws IOException { InputStream in = new FileInputStream(args[0]); try { OutputStream out = new FileOutputStream(args[1]); try { byte[] b = new byte[10000]; while (true) { int r = in.read(b); if (r == -1) break; out.write(b, 0, r); } } finally { if (out != null) { out.close(); } } } finally { if (in != null) { in.close(); } } }
是不是簡化了很多。
@Getter/@Setter
這一對注解從名字上就很好理解,用在成員變量前面,相當(dāng)于為成員變量生成對應(yīng)的get和set方法,同時還可以為生成的方法指定訪問修飾符,當(dāng)然,默認(rèn)為public,直接來看下面的簡單的例子:
public class Programmer{ @Getter @Setter private String name; @Setter(AccessLevel.PROTECTED) private int age; @Getter(AccessLevel.PUBLIC) private String language; }
實(shí)際效果相當(dāng)于:
public class Programmer{ private String name; private int age; private String language; public void setName(String name){ this.name = name; } public String getName(){ return name; } protected void setAge(int age){ this.age = age; } public String getLanguage(){ return language; } }
這兩個注解還可以直接用在類上,可以為此類里的所有非靜態(tài)成員變量生成對應(yīng)的get和set方法。
@ToString/@EqualsAndHashCode
這兩個注解也比較好理解,就是生成toString,equals和hashcode方法,同時后者還會生成一個canEqual方法,用于判斷某個對象是否是當(dāng)前類的實(shí)例,生成方法時只會使用類中的非靜態(tài)和非transient成員變量,這些都比較好理解,就不舉例子了。
當(dāng)然,這兩個注解也可以添加限制條件,例如用@ToString(exclude={“param1”,“param2”})來排除param1和param2兩個成員變量,或者用@ToString(of={“param1”,“param2”})來指定使用param1和param2兩個成員變量,@EqualsAndHashCode注解也有同樣的用法。
@NoArgsConstructor/@RequiredArgsConstructor /@AllArgsConstructor
這三個注解都是用在類上的,第一個和第三個都很好理解,就是為該類產(chǎn)生無參的構(gòu)造方法和包含所有參數(shù)的構(gòu)造方法,第二個注解則使用類中所有帶有@NonNull注解的或者帶有final修飾的成員變量生成對應(yīng)的構(gòu)造方法,當(dāng)然,和前面幾個注解一樣,成員變量都是非靜態(tài)的,另外,如果類中含有final修飾的成員變量,是無法使用@NoArgsConstructor注解的。
三個注解都可以指定生成的構(gòu)造方法的訪問權(quán)限,同時,第二個注解還可以用@RequiredArgsConstructor(staticName=”methodName”)的形式生成一個指定名稱的靜態(tài)方法,返回一個調(diào)用相應(yīng)的構(gòu)造方法產(chǎn)生的對象,下面來看一個生動鮮活的例子:
@RequiredArgsConstructor(staticName = "sunsfan") @AllArgsConstructor(access = AccessLevel.PROTECTED) @NoArgsConstructor public class Shape { private int x; @NonNull private double y; @NonNull private String name; }
實(shí)際效果相當(dāng)于:
public class Shape { private int x; private double y; private String name; public Shape(){ } protected Shape(int x,double y,String name){ this.x = x; this.y = y; this.name = name; } public Shape(double y,String name){ this.y = y; this.name = name; } public static Shape sunsfan(double y,String name){ return new Shape(y,name); } }
@Data/@Value
呃!!
@Data注解綜合了3,4,5和6里面的@RequiredArgsConstructor注解,其中@RequiredArgsConstructor使用了類中的帶有@NonNull注解的或者final修飾的成員變量,它可以使用@Data(staticConstructor=”methodName”)來生成一個靜態(tài)方法,返回一個調(diào)用相應(yīng)的構(gòu)造方法產(chǎn)生的對象。這個例子就也省略了吧…
@Value注解和@Data類似,區(qū)別在于它會把所有成員變量默認(rèn)定義為private final修飾,并且不會生成set方法。
@SneakyThrows
這個注解用在方法上,可以將方法中的代碼用try-catch語句包裹起來,捕獲異常并在catch中用Lombok.sneakyThrow(e)把異常拋出,可以使用@SneakyThrows(Exception.class)的形式指定拋出哪種異常,很簡單的注解,直接看個例子:
public class SneakyThrows implements Runnable { @SneakyThrows(UnsupportedEncodingException.class) public String utf8ToString(byte[] bytes) { return new String(bytes, "UTF-8"); } @SneakyThrows public void run() { throw new Throwable(); } }
實(shí)際效果相當(dāng)于:
public class SneakyThrows implements Runnable { @SneakyThrows(UnsupportedEncodingException.class) public String utf8ToString(byte[] bytes) { try{ return new String(bytes, "UTF-8"); }catch(UnsupportedEncodingException uee){ throw Lombok.sneakyThrow(uee); } } @SneakyThrows public void run() { try{ throw new Throwable(); }catch(Throwable t){ throw Lombok.sneakyThrow(t); } } }
@Synchronized
這個注解用在類方法或者實(shí)例方法上,效果和synchronized關(guān)鍵字相同,區(qū)別在于鎖對象不同,對于類方法和實(shí)例方法,synchronized關(guān)鍵字的鎖對象分別是類的class對象和this對象,而@Synchronized得鎖對象分別是私有靜態(tài)final對象LOCK和私有final對象LOCK和私有final對象lock,當(dāng)然,也可以自己指定鎖對象,例子也很簡單,往下看:
public class Synchronized { private final Object readLock = new Object(); @Synchronized public static void hello() { System.out.println("world"); } @Synchronized public int answerToLife() { return 42; } @Synchronized("readLock") public void foo() { System.out.println("bar"); } }
實(shí)際效果相當(dāng)于:
public class Synchronized { private static final Object $LOCK = new Object[0]; private final Object $lock = new Object[0]; private final Object readLock = new Object(); public static void hello() { synchronized($LOCK) { System.out.println("world"); } } public int answerToLife() { synchronized($lock) { return 42; } } public void foo() { synchronized(readLock) { System.out.println("bar"); } } }
@Log
這個注解用在類上,可以省去從日志工廠生成日志對象這一步,直接進(jìn)行日志記錄,具體注解根據(jù)日志工具的不同而不同,同時,可以在注解中使用topic來指定生成log對象時的類名。不同的日志注解總結(jié)如下(上面是注解,下面是實(shí)際作用):
@CommonsLog private static final org.apache.commons.logging.Log log = org.apache.commons.logging.LogFactory.getLog(LogExample.class); @JBossLog private static final org.jboss.logging.Logger log = org.jboss.logging.Logger.getLogger(LogExample.class); @Log private static final java.util.logging.Logger log = java.util.logging.Logger.getLogger(LogExample.class.getName()); @Log4j private static final org.apache.log4j.Logger log = org.apache.log4j.Logger.getLogger(LogExample.class); @Log4j2 private static final org.apache.logging.log4j.Logger log = org.apache.logging.log4j.LogManager.getLogger(LogExample.class); @Slf4j private static final org.slf4j.Logger log = org.slf4j.LoggerFactory.getLogger(LogExample.class); @XSlf4j private static final org.slf4j.ext.XLogger log = org.slf4j.ext.XLoggerFactory.getXLogger(LogExample.class);
關(guān)于lombok的注解先寫到這里,當(dāng)然,還有其他一些注解需要大家自己去摸索,同時lombok一直在擴(kuò)展,將來肯定會加入更多的注解元素,拭目以待了。
以上就是本文的全部內(nèi)容,希望對大家的學(xué)習(xí)有所幫助,也希望大家多多支持腳本之家。
相關(guān)文章
Java使用自動化部署工具Gradle中的任務(wù)設(shè)定教程
Grandle使用同樣運(yùn)行于JVM上的Groovy語言編寫,本文會對此進(jìn)行初步夠用的講解,接下來我們就一起來看一下Java使用自動化部署工具Gradle中的任務(wù)設(shè)定教程:2016-06-06spring Profile如何為不同環(huán)境提供不同的配置支持
這篇文章主要介紹了spring Profile如何為不同環(huán)境提供不同的配置支持,文中通過示例代碼介紹的非常詳細(xì),對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下2019-08-08Java 實(shí)現(xiàn)Redis存儲復(fù)雜json格式數(shù)據(jù)并返回給前端
這篇文章主要介紹了Java 實(shí)現(xiàn)Redis存儲復(fù)雜json格式數(shù)據(jù)并返回給前端操作,具有很好的參考價(jià)值,希望對大家有所幫助。一起跟隨小編過來看看吧2020-07-07深入淺出Java mvc_動力節(jié)點(diǎn)Java學(xué)院整理
這篇文章主要為大家詳細(xì)介紹了MVC的基礎(chǔ)知識,MVC是一個框架模式,它強(qiáng)制性的使應(yīng)用程序的輸入、處理和輸出分開,具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下2017-08-08springboot 獲取訪問接口的請求的IP地址的實(shí)現(xiàn)
本文主要介紹了springboot獲取訪問接口的請求的IP地址的實(shí)現(xiàn),文中通過示例代碼介紹的非常詳細(xì),具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下2021-07-07SpringBoot3+SpringSecurity6前后端分離的項(xiàng)目實(shí)踐
SpringSecurity6 的用法和以前版本的有較大差別,本文主要介紹了SpringBoot3+SpringSecurity6前后端分離的項(xiàng)目實(shí)踐,具有一定的參考價(jià)值,感興趣的可以了解一下2023-12-12Java語言實(shí)現(xiàn)對MySql數(shù)據(jù)庫中數(shù)據(jù)的增刪改查操作的代碼
這篇文章主要介紹了Java語言實(shí)現(xiàn)對MySql數(shù)據(jù)庫中數(shù)據(jù)的增刪改查操作的代碼,實(shí)現(xiàn)了連接數(shù)據(jù)庫,和數(shù)據(jù)庫的增刪改查操作,有興趣的可以了解一下。2016-12-12