简介

Lombok是一种Java实用工具，可用来帮助开发人员消除Java的代码冗余，尤其是对于简单的Java对象（POJO）。它通过注释实现这一目的。通过在开发环境中实现 Lombok，开发人员可以节省构建诸如 hashCode() 和 equals() 这样的方法以及以往用来分类各种 accessor 和 mutator 的大量时间。

安装

• 由于Lombok采用注解的形式，在编译后自动生成相应的方法，所以需要下载插件来支持它。
• 以IDEA为例：查找插件lombok plugin安装即可。

Lombok插件安装示例

引入依赖

使用前需要在pom.xml文件中引入Lombok的依赖包：

<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<scope>provided</scope>
</dependency>

注解大全

注解目录

常用注解介绍

• @Getter和@Setter：该注解可以使用在类上也可以使用在属性上，生成的getter遵循布尔属性的约定。在使用该注解时，会默认生成一个无参构造和对应的get、set方法。

示例代码如下：

@Getter
@Setter
public class User implements Serializable {
private static final long serialVersionUID = -7916580688752749714L;
private Long id;
private String userName;
private Boolean isDeleted;
}

• @ToString ：该注解使用在类上，编译后toString方法返回将会以字段的名称-值的形式输出。
• @EqualsAndHashCode ：该注解使用在类上，同时生成 equals 和 hashCode。
• @AllArgsConstructor ：该注解使用在类上，提供全参数的构造方法，默认不提供无参构造。
• @NoArgsConstructor ：该注解使用在类上，提供无参构造。
• @Data ：使用该注解就相对于同时聚合了以下几个注解的功能（@ToString 、 @Getter 、@Setter、@EqualsAndHashCode 、 @NoArgsConstructor）。

需要注意的是：同时使用 @Data 和 @AllArgsConstructor 后 ，默认的无参构造函数失效，如果需要它，要重新设置 @NoArgsConstructor。

• @Slf4j ：在类上注解后，可直接调用log。

log.info(\"xxx\");
log.error(\"xxx\");
log.debug(\"xxx\");
log.trace(\"xxx\");
log.warn(\"xxx\");

• @Builder：bulder 模式构建对象。
• @Cleanup：自动化关闭流。

@Cleanup
InputStream in = new FileInputStream(args[0]);
@Cleanup
OutputStream out = new FileOutputStream(args[1]);

• @NonNull ：增加不为空判断。

public NonNullDemo(@NonNull User user) {
this.userName = user.getUserName();
}

• @SneakyThrows ：当我们需要抛出异常，在当前方法上调用，不用显示的在方法名后面写 throw。

@SneakyThrows(Exception.class)

• @Synchronized ：方法中所有的代码都加入到一个代码块中，默认静态方法使用的是全局锁，普通方法使用的是对象锁，当然也可以指定锁的对象。

private final Object lock = new Object();
@Synchronized(\"lock\")
public void doing() {
// todo:
}