文档章节

lombok系列2:lombok注解详解

polly
 polly
发布于 2017/05/22 11:25
字数 1910
阅读 91
收藏 0
点赞 1
评论 0

开篇

看到第一篇《初识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

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

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

官方文档:https://projectlombok.org/features/index.html

© 著作权归作者所有

共有 人打赏支持
polly
粉丝 145
博文 56
码字总数 68534
作品 0
海淀
高级程序员
刚了解到的Lombok,记一下

前言: 逛开源社区的时候无意发现的,用了一段时间,觉得还可以,特此推荐一下。 lombok 提供了简单的注解的形式来帮助我们简化消除一些必须有但显得很臃肿的 java 代码。特别是相对于 POJO...

吴海宏 ⋅ 2014/10/21 ⋅ 0

Java代码简化神器-Lombok

一、背景   前段时间在开源社区中发现了一个比较牛逼的简化Java代码的神器-Lombok,接着自己写了demo进行测试和练习,感觉真的很不错,特此分享给需要的小伙伴们~ 二、开发之前的准备   1...

hafiz.zhang ⋅ 2016/05/21 ⋅ 0

Lombok学习笔记— 消除冗余java代码

lombok官网:http://projectlombok.org/ lombok开源中国连接:http://www.oschina.net/p/lombok lombok安装: 使用lombok之前是需要进行安装的,否则IDE无法解析lombok注释。安装lombok首先当...

Elven_Xu ⋅ 2016/11/20 ⋅ 0

Lombok 安装、入门 - 消除冗长的 java 代码

前言: 逛开源社区的时候无意发现的,用了一段时间,觉得还可以,特此推荐一下。 lombok 提供了简单的注解的形式来帮助我们简化消除一些必须有但显得很臃肿的 java 代码。特别是相对于 POJO...

AnyLiem ⋅ 2015/07/10 ⋅ 0

Lombok-极度精简Java代码的工具

官网主页 lombok极大的精简了Java pojo,使pojo只含有所需属性即可,不再需要getter/setter、toString()、Constructor等 直接上代码 未使用lombok 使用lombok 如何使用? 1、安装lombok插件(...

开源中国刘德华 ⋅ 2016/03/29 ⋅ 0

Lombok 安装、入门

前言: 逛开源社区的时候无意发现的,用了一段时间,觉得还可以,特此推荐一下。 lombok 提供了简单的注解的形式来帮助我们简化消除一些必须有但显得很臃肿的 java 代码。特别是相对于 POJO...

qqli ⋅ 2012/12/27 ⋅ 0

Intellij IDEA 安装lombok及使用详解

项目中经常使用bean,entity等类,绝大部分数据类类中都需要get、set、toString、equals和hashCode方法,虽然eclipse和idea开发环境下都有自动生成的快捷方式,但自动生成这些代码后,如果b...

zhglance ⋅ 2017/11/16 ⋅ 0

lombok cookbook 消除冗长的 java 代码

lombok 提供了简单的注解的形式来帮助我们简化消除一些必须有但显得很臃肿的 java 代码。特别是相对于 POJO, 官网上有 lombok 三分四十九秒的视频讲解,里面讲的也很清楚了,而且还有文档可...

squanchao ⋅ 2016/04/08 ⋅ 0

lombok 介绍及基本使用方法

lombok 提供了简单的注解的形式来帮助我们简化消除一些必须有但显得很臃肿的 java 代码。特别是相对于 POJO,光说不做不是我的风格,先来看看吧。 lombok 的官方网址:http://projectlombok....

glen_xu ⋅ 2015/12/24 ⋅ 0

log lombok eclipse

介绍一个不错的Eclipse插件Lambok,实现自动生成Java代码 该插件对Log4j简化的代码,因为不大,所以jar包也存在呢! 使用 lombok 注解的时候记得要导入 lombok.jar 包到工程lombok注解: 介绍...

林伟琨 ⋅ 2016/08/01 ⋅ 0

没有更多内容

加载失败,请刷新页面

加载更多

下一页

到底会改名吗?微软GVFS 改名之争

微软去年透露了 Git Virtual File System(GVFS)项目,GVFS 是 Git 版本控制系统的一个开源插件,允许 Git 处理 TB 规模的代码库,比如 270 GB 的 Windows 代码库。该项目公布之初就引发了争...

linux-tao ⋅ 31分钟前 ⋅ 0

笔试题之Java基础部分【简】【二】

1.静态变量和实例变量的区别 在语法定义上的区别:静态变量前要加static关键字,而实例变量前则不加。在程序运行时的区别:实例变量属于某个对象的属性,必须创建了实例对象,其中的实例变...

anlve ⋅ 48分钟前 ⋅ 0

Lombok简单介绍及使用

官网 通过简单注解来精简代码达到消除冗长代码的目的 优点 提高编程效率 使代码更简洁 消除冗长代码 避免修改字段名字时忘记修改方法名 4.idea中安装lombnok pom.xml引入 <dependency> <grou...

to_ln ⋅ 今天 ⋅ 0

【转】JS浮点数运算Bug的解决办法

37.5*5.5=206.08 (JS算出来是这样的一个结果,我四舍五入取两位小数) 我先怀疑是四舍五入的问题,就直接用JS算了一个结果为:206.08499999999998 怎么会这样,两个只有一位小数的数字相乘,怎...

NickSoki ⋅ 今天 ⋅ 0

table eg

user_id user_name full_name 1 zhangsan 张三 2 lisi 李四 `` ™ [========] 2018-06-18 09:42:06 星期一½ gdsgagagagdsgasgagadsgdasgagsa...

qwfys ⋅ 今天 ⋅ 0

一个有趣的Java问题

先来看看源码: public class TestDemo { public static void main(String[] args) { Integer a = 10; Integer b = 20; swap(a, b); System.out......

linxyz ⋅ 今天 ⋅ 0

十五周二次课

十五周二次课 17.1mysql主从介绍 17.2准备工作 17.3配置主 17.4配置从 17.5测试主从同步 17.1mysql主从介绍 MySQL主从介绍 MySQL主从又叫做Replication、AB复制。简单讲就是A和B两台机器做主...

河图再现 ⋅ 今天 ⋅ 0

docker安装snmp rrdtool环境

以Ubuntu16:04作为基础版本 docker pull ubuntu:16.04 启动一个容器 docker run -d -i -t --name flow_mete ubuntu:16.04 bash 进入容器 docker exec -it flow_mete bash cd ~ 安装基本软件 ......

messud4312 ⋅ 今天 ⋅ 0

OSChina 周一乱弹 —— 快别开心了,你还没有女友呢。

Osc乱弹歌单(2018)请戳(这里) 【今日歌曲】 @莱布妮子 :分享吴彤的单曲《好春光》 《好春光》- 吴彤 手机党少年们想听歌,请使劲儿戳(这里) @clouddyy :小萝莉街上乱跑,误把我认错成...

小小编辑 ⋅ 今天 ⋅ 9

Java 开发者不容错过的 12 种高效工具

Java 开发者常常都会想办法如何更快地编写 Java 代码,让编程变得更加轻松。目前,市面上涌现出越来越多的高效编程工具。所以,以下总结了一系列工具列表,其中包含了大多数开发人员已经使用...

jason_kiss ⋅ 昨天 ⋅ 0

没有更多内容

加载失败,请刷新页面

加载更多

下一页

返回顶部
顶部