lombok注解介紹
lombok注解文檔
lombok官網下載
lombok是一個可以幫助我們簡化java代碼編寫的工具類，尤其是簡化javabean的編寫，即通過采用注解的方式，消除代碼中的構造方法，getter/setter等代碼，使我們寫的類更加簡潔，當然，這帶來的副作用就是不易閱讀…不過，還是能看得懂吧，廢話不多說，先看一下lombok支持的一些常見的注解。
@NonNull
這個注解可以用在成員方法或者構造方法的參數前面，會自動產生一個關于此參數的非空檢查，如果參數為空，則拋出一個空指針異常，舉個例子來看看：
//成員方法參數加上@NonNull注解public String getName(@NonNull Person p){ return p.getName();}實際效果相當于：
public String getName(@NonNull Person p){ if(p==null){ throw new NullPointerException("person"); } return p.getName();}用在構造方法的參數上效果類似，就不再舉例子了。
@Cleanup
這個注解用在變量前面，可以保證此變量代表的資源會被自動關閉，默認是調用資源的close()方法，如果該資源有其它關閉方法，可使用@Cleanup(“methodName”)來指定要調用的方法，就用輸入輸出流來舉個例子吧：
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); } }實際效果相當于：
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
這一對注解從名字上就很好理解，用在成員變量前面，相當于為成員變量生成對應的get和set方法，同時還可以為生成的方法指定訪問修飾符，當然，默認為public，直接來看下面的簡單的例子：
public class Programmer{ @Getter @Setter private String name; @Setter(AccessLevel.PROTECTED) private int age; @Getter(AccessLevel.PUBLIC) private String language;}實際效果相當于：
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; }}這兩個注解還可以直接用在類上，可以為此類里的所有非靜態成員變量生成對應的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
這三個注解都是用在類上的，第一個和第三個都很好理解，就是為該類產生無參的構造方法和包含所有參數的構造方法，第二個注解則使用類中所有帶有@NonNull注解的或者帶有final修飾的成員變量生成對應的構造方法，當然，和前面幾個注解一樣，成員變量都是非靜態的，另外，如果類中含有final修飾的成員變量，是無法使用@NoArgsConstructor注解的。
三個注解都可以指定生成的構造方法的訪問權限，同時，第二個注解還可以用@RequiredArgsConstructor(staticName=”methodName”)的形式生成一個指定名稱的靜態方法，返回一個調用相應的構造方法產生的對象，下面來看一個生動鮮活的例子：
@RequiredArgsConstructor(staticName = "sunsfan")@AllArgsConstructor(access = AccessLevel.PROTECTED)@NoArgsConstructorpublic class Shape { private int x; @NonNull private double y; @NonNull private String name;}實際效果相當于：
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”)來生成一個靜態方法，返回一個調用相應的構造方法產生的對象。這個例子就也省略了吧…
@Value注解和@Data類似，區別在于它會把所有成員變量默認定義為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(); }}實際效果相當于：
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
這個注解用在類方法或者實例方法上，效果和synchronized關鍵字相同，區別在于鎖對象不同，對于類方法和實例方法，synchronized關鍵字的鎖對象分別是類的class對象和this對象，而@Synchronized得鎖對象分別是私有靜態final對象LOCK和私有final對象LOCK和私有final對象lock，當然，也可以自己指定鎖對象，例子也很簡單，往下看：
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"); }}實際效果相當于：
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
這個注解用在類上，可以省去從日志工廠生成日志對象這一步，直接進行日志記錄，具體注解根據日志工具的不同而不同，同時，可以在注解中使用topic來指定生成log對象時的類名。不同的日志注解總結如下(上面是注解，下面是實際作用)：
@CommonsLogprivate static final org.apache.commons.logging.Log log = org.apache.commons.logging.LogFactory.getLog(LogExample.class);@JBossLogprivate static final org.jboss.logging.Logger log = org.jboss.logging.Logger.getLogger(LogExample.class);@Logprivate static final java.util.logging.Logger log = java.util.logging.Logger.getLogger(LogExample.class.getName());@Log4jprivate static final org.apache.log4j.Logger log = org.apache.log4j.Logger.getLogger(LogExample.class);@Log4j2private static final org.apache.logging.log4j.Logger log = org.apache.logging.log4j.LogManager.getLogger(LogExample.class);@Slf4jprivate static final org.slf4j.Logger log = org.slf4j.LoggerFactory.getLogger(LogExample.class);@XSlf4jprivate static final org.slf4j.ext.XLogger log = org.slf4j.ext.XLoggerFactory.getXLogger(LogExample.class);
關于lombok的注解先寫到這里，當然，還有其他一些注解需要大家自己去摸索，同時lombok一直在擴展，將來肯定會加入更多的注解元素，拭目以待了。
以上就是本文的全部內容，希望對大家的學習有所幫助，也希望大家多多支持VeVb武林網。
新聞熱點
疑難解答
圖片精選
