lombok的学习和使用

最新推荐文章于 2024-08-20 10:34:34 发布

m0_63550220

最新推荐文章于 2024-08-20 10:34:34 发布

阅读量698

点赞数 14

文章标签：学习

本文链接：https://blog.csdn.net/m0_63550220/article/details/141324401

版权

一、Lombok的基本概念和特点

定义：

Lombok是一个Java库，它通过注解的方式自动生成getter、setter、equals、hashCode、toString等常用方法，从而减少开发人员的重复劳动。

特点：

简化代码：自动生成常见代码，减少手动编写的工作量。
提高开发效率：开发人员可以更专注于业务逻辑的实现，而不是编写重复的代码。
减少错误：手动编写重复代码容易出现错误，而Lombok可以自动生成正确的代码，减少错误的发生。
支持多种IDE：Lombok支持Eclipse、IntelliJ IDEA等多种主流的Java集成开发环境。

二、Lombok的使用方法

安装Lombok插件：

在IDE（如IntelliJ IDEA或Eclipse）中安装Lombok插件。
安装插件后，IDE将能够识别Lombok的注解，并在编译时自动生成相应的代码。

添加Lombok依赖：

在项目的构建工具（如Maven或Gradle）中添加Lombok的依赖。
例如，在Maven项目中，可以在pom.xml文件中添加如下依赖：

<dependency>  
    <groupId>org.projectlombok</groupId>  
    <artifactId>lombok</artifactId>  
    <version>最新版本号</version>  
    <scope>provided</scope>  
</dependency>

使用Lombok注解：

在Java类中使用Lombok提供的注解，如@Data、@Getter、@Setter、@EqualsAndHashCode、@ToString等。
这些注解会告诉Lombok在编译时自动生成相应的代码。

三、Lombok的常用注解

@Getter和@Setter：
功能：自动生成属性的getter和setter方法。
使用场景：用于访问和修改类的私有字段。
特点：可以应用于类级别或字段级别，为类中的所有字段或特定字段生成getter和setter方法。
@ToString：
功能：自动生成toString方法。
使用场景：用于生成包含类名和字段值的字符串表示。
特点：可以通过参数自定义包含哪些字段，例如排除某些字段。
@EqualsAndHashCode：
功能：自动生成equals和hashCode方法。
使用场景：用于比较两个对象是否相等，以及生成对象的哈希码值。
特点：支持自定义比较哪些字段，以及是否调用父类的equals和hashCode方法。
@NoArgsConstructor：
功能：自动生成无参构造方法。
使用场景：当类中没有需要特殊处理的字段时，自动生成一个无参构造函数。
@AllArgsConstructor：
功能：自动生成全参构造方法。
使用场景：为类中的所有字段生成一个包含所有参数的构造函数。
@RequiredArgsConstructor：
功能：自动生成带有必需参数的构造方法。
使用场景：为类中所有标有final修饰符或@NonNull注解的成员变量生成一个构造函数。
@Data：
功能：自动生成所有属性的getter、setter、equals、hashCode和toString方法。
使用场景：适用于简单的POJO（Plain Old Java Objects）和bean类。
特点：相当于同时使用了@ToString、@EqualsAndHashCode、@Getter、@Setter和@RequiredArgsConstructor注解。
@Builder：
功能：提供链式调用的构建器模式。
使用场景：当类有多个字段，且某些字段是可选的时，使用构建器模式可以更方便地创建对象。
@NonNull：
功能：指示一个参数、返回值或字段不能为null。
使用场景：用于字段、方法参数或返回值，确保它们在使用前不为null。
特点：如果尝试将null值赋给标有@NonNull注解的字段或参数，Lombok将自动生成校验代码抛出异常。
@Value：
功能：用于创建不可变类。
使用场景：将所有字段设为私有和final，并为这些字段生成getter方法，但不生成setter方法。
特点：同时生成@ToString、@EqualsAndHashCode和@AllArgsConstructor注解的功能。

四、Lombok的工作原理

Lombok在编译时通过注解处理器扫描Java源代码中的注解，并对注解所标注的类进行抽象语法树（AST）的解析和操作。根据注解的定义和规则，Lombok注解处理器生成相应的代码片段，如getter和setter方法、构造函数等，并将这些代码片段插入到编译结果中的相应位置。最终，编译器将生成的代码和手动编写的代码一起编译为最终的字节码文件。