Java 实体代码生成器 lombok 的使用

前言

在Java中,封装是一个非常好的机制,最常见的封装莫过于get,set方法了,无论是Intellij idea 还是 Eclipse ，都提供了快速生成get,set方法的快捷键,使用起来很是方便，其实,我们还有更方便的办法,就是使用 Lombok 的注解生成这些公有方法。

Lombok是一个通过注解以达到减少代码的Java库,如通过注解的方式减少get,set方法,构造方法等。

安装 lombok

引入依赖

<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <version>1.16.12</version>
</dependency>

idea 用户需要在插件商店里边下载 lombok 插件，这样编译的时候才能生效。

如何使用 lombok

Lombok提供注解方式来提高代码的简洁性,常用注解有:

@Data
@Setter @Getter
@NonNull
@Synchronized
@ToString
@EqualsAndHashCode
@Cleanup
@SneakyThrows
详细解释如下：

@Data

作用与类上

该注解相当于同时加上以下注解
@Setter @Getter,@ToString,@EqualsAndHashCode

@Getter@Setter

作用于属性上,自动生成get,set方法

@NonNull

该注解快速判断是否为空,作用与字段上，如果为空,则抛出java.lang.NullPointerException 异常。

@Synchronized

该注解自动添加到同步机制,有趣的是,生成的代码并不是直接锁方法,而是锁代码块，作用范围是方法上
使用方法:

private DateFormat format = new SimpleDateFormat("MM-dd-YYYY");
 
@Synchronized
public String synchronizedFormat(Date date) {
    return format.format(date);
}

等价源码：

private final java.lang.Object $lock = new java.lang.Object[0];
private DateFormat format = new SimpleDateFormat("MM-dd-YYYY");
 
public String synchronizedFormat(Date date) {
    synchronized ($lock) {
        return format.format(date);
    }
}

@ToString

作用与类上，但需要注意的是:@ToString有多个属性可以进一步设置:

callSuper 是否输出父类的toString方法,默认为false
includeFieldNames 是否包含字段名称,默认为true
exclude 排除生成tostring的字段
使用方法：

@ToString(callSuper = true,exclude ={"name"})
public class Person {
    private String name;
    private String address;
}

@NoArgsConstructor

为类生成无参的构造函数

@AllArgsConstructor

为类中的每个字段生成对应参数的构造函数。标有 @NonNull 的字段会导致对这些参数进行空检查

@Value

使用位置：类
是@Data的不可变形式，相当于为属性添加final声明，只提供getter方法，而不提供setter方法。

作者：dreamChaser的博客
出处：https://www.wenjing.xin/archives/
版权：本文是原创文章，采用 CC BY-NC-ND 4.0 协议
转载：需经过作者同意进行转载，并保留此段声明；必须在文章中给出原文连接；否则必究法律责任
作者邮箱：wb3368316006@outlook.com

微风静语