当前位置：首页 > news >正文

掌握lombok简化Java编码完成后端提效

news 文章来源：https://blog.csdn.net/qq_46033586/article/details/129186653 2025/4/20 3:40:48

Lombok安装

–>添加依赖

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

scope=provided，说明它只在编译阶段生效，不需要打入包中，Lombok在编译期将带Lombok注解的Java文件正确编译为完整的Class文件

–>安装插件
在这里插入图片描述

–>IDEA配置
在这里插入图片描述

–>重启IDEA

编写实体类，不写setter/getter方法

public class user {private Integer id;private String name;private String email;private String createName;private Date createTime;
}

使用mvn compile进行编译，可以看到target中生成的实体类文件：

在这里插入图片描述

Lombok原理

Lombok实际上是JSR 269插件化注解处理
JSR（Java Specification Requests） 269 ：Pluggable Annotation Processing API 实现在Javac编译阶段利用“Annotation Processor”对自定义的注解进行预处理后生成真正在JVM上面执行的“Class文件”

Javac 解析成AST抽象语法树后，Lombok根据自己编写的注解处理器，动态地修改 AST增加新的节点（即Lombok自定义注解所需要生成的代码），最终生成JVM可执行的字节码Class文件，可以看编译后的在target目录下的class⽂件

常用注解

@Setter/@Getter

@Setter
@Getter

作用在类上，生成所有成员变量的getter/setter方法；
作用于成员变量上，生成该成员变量的getter/setter方法

作用在类上时，可以在成员变量上单独添加：
@Getter(AccessLevel.NONE)该变量不想生成get方法，set使用相同
@Getter(AccessLevel.PROTECTED)：控制该变量的get方法访问权限，set使用相同；

注：final类型成员变量只会生成get方法，static类型变量不会生成set/get方法

@NonNull非空判断

作用于方法上或者属性，⽤于非空判断，如果为空则抛异常

public void test(@NonNull String email){this.email = email;
}

编译后：

public void test(@NonNull String email) {if (email == null) {throw new NullPointerException("email is marked non-null but is null");} else {this.email = email;}
}

@NoArgsConstructor

⽣成无参构造函数

@AllArgsConstructor

生成全参构造函数，但不会生成final、static、static final的成员变量的构造函数参数

@RequiredArgsConstructor

指定参数的构造函数，有以下的特征的字段：

final类型未被初始化的属性；
标记了@NonNull的属性；

注：@NoArgsConstructor不能加

@ToString

作用在类上，覆盖默认的toString()方法

@ToString(exclude = {"age"})：不包括某个字段
@ToString(of = {"name"})：只输出某个字段

@EqualsAndHashCode

作用于类，覆盖默认的equals和hashCode作用于全部属性

不包括某个属性：@EqualsAndHashCode(exclude = {"age"})
只输出某个属性：@EqualsAndHashCode(of = {"name"})

多注解集合配置

@Data

定义⼀个干净的类，作用于类上，是以下注解的集合：
@ToString、@EqualsAndHashCode、@Getter、@Setter、@RequiredArgsConstructor

@Builder建造者模式

构造者模式又称为建造者模式，当⼀个bean类重载了多个构造方法时，并且参数随机使用时，考虑使用构造者模式
谷歌的开源的protobuf协议生产的java bean赋值就是采用建造者模式

@Builder
作用在类上

User studentDO = User.builder().id(1).createName("794666918@qq").build();
System.out.println(studentDO);