lombok系列2：lombok注解详解

最新推荐文章于 2024-05-12 20:56:17 发布
最新推荐文章于 2024-05-12 20:56:17 发布
阅读量301 收藏 1
点赞数
原文链接：https://my.oschina.net/polly/blog/906495
版权

为什么80%的码农都做不了架构师？>>>   hot3.png

开篇

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

转载于:https://my.oschina.net/polly/blog/906495

weixin_33894640
关注
详解Lombok快速上手(安装、使用与注解参数)
08-26
本文将详细介绍 Lombok 的安装、使用和注解参数。 一、Lombok的安装 Lombok 的安装非常简单，只需要在 pom.xml 文件中添加以下依赖项： ```xml <groupId>org.projectlombok <artifactId>lombok <version>...
探索 Lombok自动注入注解 之 @RequiredArgsConstructor ：原理、实践、踩坑及填坑
最新发布
fhey的博客
07-25 7082
注解@RequiredArgsConstructor 是 Lombok 提供的一个注解，其主要作用在于简化@Autowired的书写过程。在编写 Controller 层或 Service 层代码时，常常需要注入众多的 mapper 接口或 service 接口。若每个接口都使用@Autowired进行标注，代码会显得繁琐。而注解能够替代@Autowired注解，但需注意，在类上添加时，需要注入的类必须使用final进行声明。
Lombok注解详解
骑个小蜗牛的博客
05-12 2673
Getter Setter ToString EqualsAndHashCode Data Value NonNull NoArgsConstructor AllArgsConstructor RequiredArgsConstructor Builder Synchronized Cleanup Singular Generated SneakyThrows val var CommonsLog Flogger Log JBossLog Log4j Log4j2 Slf4j
Lombok 常用注解
u014212540的博客
03-09 1623
Lombok 常用注解
Lombok工具 : 常用注解介绍 (全)
Guizy
08-14 9007
Lombok详细介绍, 全
Lombok快速入手：安装、使用与关键注解详解
Lombok提供了一系列注解来帮助简化代码： 1. **@Setter**：当在类或字段上使用时，会在类的所有字段上生成setter方法；如果只应用于特定字段，则只对该字段生成setter。 2. **@Getter**：同理，用于生成getter方法...
使用Lombok优化Java代码：注解详解与示例
"本文主要介绍了如何使用Lombok来简化Java代码，包括安装Lombok插件的方法，以及一系列常用的Lombok注解的详细说明，旨在提高开发效率，减少样板代码。" Lombok是一款非常实用的Java库，它通过注解的方式帮助开发者...
MyBatis注解开发详解：Lombok与Mapper注解实践
- 注解应用：在Java实体类中，可以使用各种Lombok注解，如`@Data`、`@NoArgsConstructor`、`@AllArgsConstructor`和`@Log`等，以减少冗余代码。 2. **MyBatis常用注解** MyBatis的注解主要用于简化SQL操作的声明...
Lombok注解大全
高性价比服务器就选：蓝易云
02-12 396
这些是Lombok中的一些常见注解，它们可以显著减少Java代码中的冗余代码，提高代码的可读性和可维护性。不过，在使用Lombok之前，请确保你的开发环境已经配置好支持Lombok，通常需要安装相应的插件或进行设置以使IDE（如Eclipse、IntelliJ IDEA）能够正确解析Lombok注解。Lombok是一个Java库，它提供了一组注解，用于减少Java代码中的样板代码（boilerplate code）。
lombok注解
第245万个博主
06-27 180
常用注解 @Getter / @Setter   //可以作用在类上和属性上，放在类上，会对所有的非静态(non-static)属性生成Getter/Setter方法，放在属性上，会对该属性生成Getter/Setter方法。 //并可以指定Getter/Setter方法的访问级别。 @EqualsAndHashCode   //默认情况下，会使用所有非瞬态(non-transient...
lombok标签之@Data @AllArgsConstructor @@NoArgsConstructor -如何去除get，set方法。@Data注解和如何使用，lombok...
01-21 605
在代码中我们可以只加上标签@Data 而不用get,set方法； val : 和 scala 中 val 同名, 可以在运行时确定类型; @NonNull : 注解在参数上, 如果该类参数为 null , 就会报出异常, throw new NullPointException(参数名) @Cleanup : 注释在引用变量前, 自动回收资源 默认调用 close()...
lombok实用注解（实战介绍）
weixin_55076626的博客
10-05 4096
lombok是一个开源的代码生成库，能以简单的注解形式来简化Java类中的大量样板代码，提高开发人员的开发效率。例如开发中经常需要写的javabean，都需要花时间去添加相应getter/setter，也许还要去写构造器、equals等方法，而且需要维护，当属性多时会出现大量的getter/setter方法，这些显得很冗长也没有太多技术含量。lombok能通过注解的方式，在编译时自动为属性生成构造器、getter/setter、equals、hashcode、toString方法，使代码看起来更简洁。
lombok常用注解大全
热门推荐
MHGeek的博客
08-30 2万+
lombok可以帮助我们提升日常开发的效率jar包。里面有许多实用的注解。 本文将对lombok的常用注解作使用介绍,对于一些实验性官方不推荐的注解只会简单介绍 实验性注解可能会带来一些风险。 注: 本文基于lombok-1.18.6 本文部分内容机翻自官网 文章目录lombok的引入和安装lombok的基本注解使用变量相关val和var@NonNull实体类相关@Getter and @...
Lombok常用注解学习
make82117的专栏
01-23 126
Lombok常用注解
Lombok注解超详细解析
最难不过坚持，与你共同进步
08-15 1743
Lombok 是一个 Java 库，用于通过注解方式自动化生成 Java 类的常用方法（如 getter、setter、toString 等），从而简化开发流程并减少重复性代码。
Java Lombok不常用注解
菜鸟记录
04-02 1059
⏹Java Lombok不常用注解
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值