转自:https://www.imooc.com/article/18157

开篇

看到第一篇《初识lombok》你可能意犹未尽,本文我们按照场景来介绍一下常用的注解。

未特别说明,均标注在类级别。

lombok.Data

最常用的注解,编译时自动添加Setter、Getter、toString()、equals()和hashCode()。

 package com.pollyduan;

 import java.util.Date;

 import lombok.Data;

 @Data
public class User {
private Integer id;
private String userName;
private String password;
private String email;
private Integer age;
private Date signupTime;
public static void main(String[] args) {
User user=new User();
user.setId(1001);
user.setUserName("pollyduan");
user.setPassword("123456");
user.setEmail("pollyduan@pollyduan.com");
user.setAge(30);
user.setSignupTime(new Date());
System.out.println(user);
System.out.println(user.getUserName());
System.out.println(user.hashCode());
}
}

使用场景:

POJO类、hibernate的实体类、json或jaxb的实体类。

lombok.Value

如果我们需要一个不可变的对象类,那么就用该注解。它在编译是自动添加Getter、toString()、equals()、hashCode()以及一个全参的构造器。

注:没有无参构造器。如果需要,自己添加一个,或者增加一个后面介绍的lombok.NoArgsConstructor注解。

 package com.pollyduan;

 import java.util.Date;

 import lombok.Value;

 @Value
public class User {
private Integer id;
private String userName;
private String password;
private String email;
private Integer age;
private Date signupTime; public static void main(String[] args) {
/*
* User user=new User();//The constructor User() is undefined
* user.setId(1001);//The method setId(int) is undefined for the type
* User
*/
User user = new User(1001, "pollyduan", "123456", "pollyduan@pollyduan.com", 30, new Date());
System.out.println(user);
System.out.println(user.getUserName());
System.out.println(user.hashCode());
}
}

如果自定义了自动生成的方法,以自己定义的为准。

lombok.Builder

它把我们的Bean类包装为一个构建者模式,编译时增加了一个Builder内部类和全字段的构造器。

注:没有Getter、Setter、toString()。如需其他方法,可以自己实现或者配合其他注解。

 package com.pollyduan;

 import java.util.Date;

 import lombok.Builder;
import lombok.Data; @Builder
public class User {
private Integer id;
private String userName;
private String password;
private String email;
private Integer age;
private Date signupTime; public static void main(String[] args) {
/*
* User user=new User();//The constructor User() is undefined
*/
User user = new User(1001, "pollyduan", "123456", "pollyduan@pollyduan.com", 30, new Date());
//或者
user=User.builder()
.age(30)
.userName("pollyduan")
.build();
System.out.println(user);
}
}

构造器注解

提供了三个构造器注解,分别为:

lombok.AllArgsConstructor 增加全参构造器

lombok.NoArgsConstructor 增加无参构造

lombok.RequiredArgsConstructor 增加必选参数构造器

该注解可同时标注,以增加不同的构造器。

可以使用access属性定制访问级别,如:”access = AccessLevel.PROTECTED”

前两个比较简单,必选参数构造器需要配合 lombok.NonNull 注解使用,只有标记了 NonNull 注解的字段才会被纳入 RequiredArgsConstructor 构造器中。

 package com.pollyduan;

 import java.util.Date;

 import lombok.NonNull;
import lombok.RequiredArgsConstructor; @RequiredArgsConstructor
public class User {
@NonNull
private Integer id;
@NonNull
private String userName;
@NonNull
private String password;
private String email;
private Integer age;
private Date signupTime; public static void main(String[] args) {
/*
* User user=new User();
* User user = new User(1001, "pollyduan", "123456", "pollyduan@pollyduan.com", 30, new Date());
* //The constructor User() is undefined
*/
User user=new User(1001, "pollyduan", "123456");//ok
System.out.println(user);
}
}

定制单个方法

lombok.ToString 这个简单,就是增加toString()方法。

类似的还有:

lombok.EqualsAndHashCode 增加equals() 和 hashCode()。

lombok.Getter 增加Getter方法

lombok.Setter 增加Setter方法

lombok.Cleanup

该注解的对象,如Stream对象,如果有close()方法,那么在该对象作用域离开时会自动关闭。

 package com.pollyduan;

 import lombok.Cleanup;

 public class MyStream {
public void close() {
System.out.println("close.");
} public static void main(String[] args) {
System.out.println("new a mystream object.");
@Cleanup
MyStream ms=new MyStream();
System.out.println("bye.");
//退出前会自动调用close()
}
}

执行后输出:

new a mystream object.

bye.

close.

日志相关注解

lombok提供了一组日志相关注解,标注的类会隐式的定一个了一个名为log的日志对象。如:

 package com.pollyduan;

 import lombok.extern.java.Log;

 @Log
public class User {
public static void main(String[] args) {
System.out.println(log.getClass());
log.info("app log.");
}
}

输出:

class java.util.logging.Logger

五月 19, 2017 1:32:58 下午 com.pollyduan.User main

信息: app log.

该组注解包括:

 @CommonsLog
Creates private static final org.apache.commons.logging.Log log = org.apache.commons.logging.LogFactory.getLog(LogExample.class); @JBossLog
Creates private static final org.jboss.logging.Logger log = org.jboss.logging.Logger.getLogger(LogExample.class); @Log
Creates private static final java.util.logging.Logger log = java.util.logging.Logger.getLogger(LogExample.class.getName()); @Log4j
Creates private static final org.apache.log4j.Logger log = org.apache.log4j.Logger.getLogger(LogExample.class); @Log4j2
Creates private static final org.apache.logging.log4j.Logger log = org.apache.logging.log4j.LogManager.getLogger(LogExample.class); @Slf4j
Creates private static final org.slf4j.Logger log = org.slf4j.LoggerFactory.getLogger(LogExample.class); @XSlf4j
Creates private static final org.slf4j.ext.XLogger log = org.slf4j.ext.XLoggerFactory.getXLogger(LogExample.class);

注:常用的日志处理器都在,一般我们使用log4j或slf4j。

没有logback,请使用slf4j代理logback。

Getter(lazy=true) 懒加载

如果Bean的一个字段的初始化是代价比较高的操作,比如加载大量的数据;同时这个字段并不是必定使用的。那么使用懒加载机制,可以保证节省资源。

懒加载机制,是对象初始化时,该字段并不会真正的初始化;而是第一次访问该字段时才进行初始化字段的操作。

一言不合贴代码:

 package com.pollyduan;

 import lombok.Data;
import lombok.Getter; @Data
public class GetterLazyExample {
@Getter(lazy = true)
private final int[] cached = expensive();
private Integer id; private int[] expensive() {
int[] result = new int[100];
for (int i = 0; i < result.length; i++) {
result[i] = i;
System.out.println(i);
}
System.out.println("cached 初始化完成。");
return result;
}
public static void main(String[] args) {
GetterLazyExample obj=new GetterLazyExample();
obj.setId(1001);
System.out.println("打印id:"+obj.getId());
System.out.println("cached 还没有初始化哟。");
// obj.getCached();
}
}

运行就会发现,cached这个字段并没有初始化,虽然看起来它是final的,并直接赋值使用expensive()进行初始化。

打印id:1001 cached

还没有初始化哟。



打开obj.getCached();的注释,获取这个字段的值,你就会发现它真的初始化了。

打印id:1001

cached 还没有初始化哟。

0 1 ... 97 98 99

cached 初始化完成。

Synchronized

同步方法注解。添加了该注解的方法,其方法体都会自动包含在一个synchronize块中。如:

 package com.pollyduan;

 import java.util.concurrent.BlockingQueue;

 import lombok.AllArgsConstructor;
import lombok.Synchronized; @AllArgsConstructor
public class SynchronizedExample {
private BlockingQueue<String> queue; @Synchronized("queue")
public void sync1() throws Exception {
System.out.println("sync1.");
} @Synchronized("queue")
public void sync2() throws Exception {
System.out.println("sync2.");
} @Synchronized
public void sync3() throws Exception {
System.out.println("sync3.");
}
}

如果直接指定了value=queue,其中queue为类的一个成员,那么该方法使用该成员queue作为加锁对象,放在同步块中执行。那么本例中,sync1和sync2是互斥的,sync1没有执行完之前,sync2会被挂起,等待sync1执行完成之后才可以执行。

sync3,没有指定注解属性,这时lombok会自动创建一个对象作为锁,这样的结果是sync3自身互斥,多线程中两个线程不能同时执行sync3方法。

sync3等同于:

 private final Object $lock = new Object[0];//lombok添加的
public void sync3() throws Exception {
synchronized($lock){
System.out.println("sync3.");
}
}

注:因为sync3与sync1使用的不是同一个锁,那么他们没有互斥关系,sync2也一样。

一定要理清楚锁的关系,否则不要轻易使用该注解。

SneakyThrows 隐藏异常

自动捕获检查异常。

我们知道,java对于检查异常,需要在编码时进行捕获,或者throws抛出。

该注解的作用是将检查异常包装为运行时异常,那么编码时就无需处理异常了。

提示:不过这并不是友好的编码方式,因为你编写的api的使用者,不能显式的获知需要处理检查异常。

 package com.pollyduan;

 import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.UnsupportedEncodingException; import lombok.SneakyThrows; public class SneakyThrowsExample {
@SneakyThrows({UnsupportedEncodingException.class})
public void test(byte[] bytes) {
String str = new String(bytes, "UTF8");
}
@SneakyThrows({UnsupportedEncodingException.class,FileNotFoundException.class})
public void test2(byte[] bytes) {
FileInputStream file=new FileInputStream("no_texists.txt");
String str=new String(bytes, "UTF8");
}
@SneakyThrows
public void test3(byte[] bytes) {
FileInputStream file=new FileInputStream("no_texists.txt");
String str=new String(bytes, "UTF8");
} }

注解接受一个class数组的value属性,如果未指定value属性,默认捕获所有异常。

以上代码相当于:

 package com.pollyduan;

 import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.UnsupportedEncodingException; import lombok.SneakyThrows; public class SneakyThrowsExample {
public void test(byte[] bytes) {
try {
String str = new String(bytes, "UTF8");
} catch (UnsupportedEncodingException e) {
e.printStackTrace();
}
}
public void test2(byte[] bytes) {
try {
FileInputStream file=new FileInputStream("no_texists.txt");
} catch (FileNotFoundException e) {
e.printStackTrace();
}
try {
String str=new String(bytes, "UTF8");
} catch (UnsupportedEncodingException e) {
e.printStackTrace();
}
}
public void test3(byte[] bytes) {
try {
FileInputStream file=new FileInputStream("no_texists.txt");
String str=new String(bytes, "UTF8");
} catch (Throwable e) {
e.printStackTrace();
}
} }

注:个人建议,了解即可,非必要不要使用。隐藏了异常细节,你的使用者会骂死你。

辅助注解

lombok.NonNull

前面已经使用过了,标记在字段上,表示非空字段。

也可以标注在方法参数上,会在第一次使用该参数是判断是否为空。

2.lombok系列2:lombok注解详解的更多相关文章

  1. Spring系列20:注解详解和Spring注解增强(基础内功)

    有部分小伙伴反馈说前面基于注解的Spring中大量使用注解,由于对Java的注解不熟悉,有点难受.建议总结一篇的Java注解的基础知识,那么,它来了! 本文内容 什么是注解? 如何定义注解 如何使用注 ...

  2. Spring IoC 公共注解详解

    前言 本系列全部基于 Spring 5.2.2.BUILD-SNAPSHOT 版本.因为 Spring 整个体系太过于庞大,所以只会进行关键部分的源码解析. 什么是公共注解?公共注解就是常见的Java ...

  3. @RequestBody, @ResponseBody 注解详解(转)

    原文地址: https://www.cnblogs.com/qq78292959/p/3760651.html @RequestBody, @ResponseBody 注解详解(转) 引言: 接上一篇 ...

  4. @ModelAttribute注解详解

    @ModelAttribute注解详解 1.@ModelAttribute定义: 被该注解定义的方法,会在该方法所在的controller的任何目标方法执行之前执行 2.@ModelAttribute ...

  5. SpringMVC 常用注解 详解

    SpringMVC 常用注解 详解 SpringMVC 常用注解 1.@RequestMapping                                      路径映射 2.@Requ ...

  6. 【转】@RequestParam @RequestBody @PathVariable 等参数绑定注解详解

    @RequestParam @RequestBody @PathVariable 等参数绑定注解详解 2014-06-02 11:24 23683人阅读 评论(2) 收藏 举报 目录(?)[+] 引言 ...

  7. Java基础13:反射与注解详解

    Java基础13:反射与注解详解 什么是反射? 反射(Reflection)是Java 程序开发语言的特征之一,它允许运行中的 Java 程序获取自身的信息,并且可以操作类或对象的内部属性. Orac ...

  8. @PathVariable @RequestParam @RequestBody等参数绑定注解详解

    一.分类 handler method 参数绑定常用的注解,我们根据他们处理的Request的内容不同分为四类: 处理request uri 部分的注解:   @PathVariable;(这里指ur ...

  9. java中的注解详解和自定义注解

    一.java中的注解详解 1.什么是注解 用一个词就可以描述注解,那就是元数据,即一种描述数据的数据.所以,可以说注解就是源代码的元数据.比如,下面这段代码: @Override public Str ...

  10. ASP.NET MVC深入浅出系列(持续更新) ORM系列之Entity FrameWork详解(持续更新) 第十六节:语法总结(3)(C#6.0和C#7.0新语法) 第三节:深度剖析各类数据结构(Array、List、Queue、Stack)及线程安全问题和yeild关键字 各种通讯连接方式 设计模式篇 第十二节: 总结Quartz.Net几种部署模式(IIS、Exe、服务部署【借

    ASP.NET MVC深入浅出系列(持续更新)   一. ASP.NET体系 从事.Net开发以来,最先接触的Web开发框架是Asp.Net WebForm,该框架高度封装,为了隐藏Http的无状态模 ...

随机推荐

  1. Docker -- 2 -- 利用docker部署网站和数据库

    在Docker – 系统整洁之道 – 1中已经对Docker的一些命令和Docker镜像的使用及操作做了记录. 这次就利用docker进行一次真正的实例使用,使用docker搭建一个简单的答题系统,这 ...

  2. 使用powerdesigner建模时设置主键自增的问题

    研究了一下,其实只要双击表,选择columns,再双击在你所要设为自增型的键上(比如你的id)或者右键选择Properties,弹出一个ColumnProperties 对话框,我们看到有标识 ide ...

  3. Semi-Prime(半素数)

    http://acm.zju.edu.cn/onlinejudge/showProblem.do?problemCode=2723 Semi-Prime Time Limit: 2 Seconds   ...

  4. ajax的几个面试题

    一.什么是AJAX(请谈一下你对Ajax的认识)AJAX是“Asynchronous JavaScript and XML”的缩写.他是指一种创建交互式网页应用的网页开发技术.Ajax包含下列技术:基 ...

  5. 【Codeforces Round #460 (Div. 2) A】 Supermarket

    [链接] 我是链接,点我呀:) [题意] 在这里输入题意 [题解] 就是让你求m*(ai/bb)的最小值 [代码] #include <bits/stdc++.h> #define dou ...

  6. 洛谷 P3486 [POI2009]KON-Ticket Inspector

    P3486 [POI2009]KON-Ticket Inspector 题目描述 Byteasar works as a ticket inspector in a Byteotian Nationa ...

  7. Android中SQLite应用具体解释

    如今的主流移动设备像Android.iPhone等都使用SQLite作为复杂数据的存储引擎,在我们为移动设备开发应用程序时,或许就要使用到SQLite来存储我们大量的数据,所以我们就须要掌握移动设备上 ...

  8. vue (v-if show 问题)

    vue中的显示和隐藏有两种方式 1.v-if   ( 相当于动态创建的标签,在html 结构中,是不存在的. ) 2. v-show(控制的是 html 的css display:none  属性.结 ...

  9. BZOJ 1355 KMP中next数组的应用

    思路: 我们知道 next[i]是失配的i下一步要去哪儿 next[n]就是失配的n要去哪儿 n-next[n]就是答案(即最短周期)啦 //By SiriusRen #include <cst ...

  10. HDU 1716 排列2

    排列2 Time Limit: 1000/1000 MS (Java/Others)    Memory Limit: 32768/32768 K (Java/Others)Total Submiss ...