Lombok使用指南（一）

原创 已于 2025-10-17 10:10:21 修改 · 956 阅读 · 30 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#Lombok

于 2025-10-15 21:25:20 首次发布

1、Lombok简介

根据官网（https://projectlombok.org）的介绍：Project Lombok 是一个 Java 库，它能自动与您的编辑器和构建工具集成，为您的 Java 代码增添活力。从此再也不用编写 getter 或 equals 方法，只需一个注解，您的类就能拥有功能完备的构建器，自动处理日志变量等等。

简而言之，Lombok 能以简单的注解形式来简化java代码，提高开发人员的开发效率。特别是开发中有大量的实体类，VO，DTO等。

不过在实际开发中，Lombok的使用也存在一定的争议。可以说其优缺点并存。

优点包括：

  • 通过注解的形式自动

  • 生成构造器、getter/setter、equals、hashCode、toString等方法，提高了一定的开发效率

  • 让代码变得简洁，不用过多的去关注相应的方法

  • 属性做修改时，也简化了维护为这些属性所生成的getter/setter方法等

缺点包括：

  • 虽然省去了手动创建getter/setter等方法的麻烦，但降低了源代码的可读性和完整性，降低了阅读源代码的舒适度

  • 不支持多种参数构造器的重载

我将Lombok提供的注解大致为分为一下几类：

  • 通用方法产生：比如 setter与getter方法，Object类中的toString，eauals，hashCode方法
  • 对象创建：构造方法，构建器模式创建对象，withXxx，ofXxx模式，资源清理等
  • 异常处理：自动产生try-catch结构，自动在finally子句中释放资源
  • 线程：在方法体内加锁
  • 日志：自动在类中增加不同日志记录的对象
  • 其他

2、搭建测试环境

本文的测试环境为Windows 11，IntelliJ IDEA 2025.2.2 (Community Edition)，JDK 25，Maven 3.9.6，Lombok 1.18.42。

IDEA自2023版本就默认支持，开发中引入依赖即可，如果是早期版本，需要单独安装Lombok插件。

在IDEA创建Maven项目，增加Lombok依赖：

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

本文下面针对每个注解及重要属性进行介绍。

Lombok本身是操作class文件，既不会修改源文件，也不会产生新的源文件。

本文针对每个注解产生的源码，是由编译之后的 class 反编译而成，仅供学习时理解其基本原理。

3、通用方法相关注解

3.1、Setter注解

Setter注解用于修饰类或其属性。

  • 修饰类，为类中的非 final，非 static 且未使用 @Setter 的属性产生 setter 方法
  • 修饰非 final 非 static 属性，为该属性产生对应的 setter 方法

Setter注解的属性：

  • value：用于指定访问控制修饰符，类型是 lombok.AccessLevel 枚举，其可选值有：PUBLIC, MODULE, PROTECTED, PACKAGE, PRIVATE, NONE；默认是.PUBLIC。

AccessLevel 枚举在其他注解中也有使用，使用时可以类比，其源码如下，：

public enum AccessLevel {
	PUBLIC,                        // 产生pblic修饰的setter方法
	@Deprecated MODULE,            // 弃用，与PACKAGE效果一样
	PROTECTED,                     // 产生protected修饰的setter方法
	PACKAGE,                       // 产生包内私有的setter方法（没有关键字修饰）
	PRIVATE,                       // 产生private修饰的setter方法
	NONE;                          // 不产生setter方法
}

用于修饰类的示例：

@Setter
public class User {
    private int id;
    private String name;
    private final int num = 0;
    public static String desc;
}

通过反编译得到的源码：

public class User {
    private int id;
    private String name;
    private final int num = 0;
    public static String desc;

    @Generated
    public void setId(int id) {
        this.id = id;
    }

    @Generated
    public void setName(String name) {
        this.name = name;
    }
}

可以看到 Lombok 帮我们产生了两个setter方法，都是针对非 final，非 static属性的。

@Generated是Lombok自动为它产生的元素加上的注解，可以不用关心。

当然也可以在属性上使用@Setter注解，那么只会对其修饰的属性产生setter方法，优先级比类上的注解高。

  • onMethod：为Setter方法增加指定的注解
  • onParam：为Setter方法的参数增加指定的注解

onMethod 与 onParam 使用示例如下，注意使用时属性结尾有下划线：

@Setter
public class User {
    @Setter(onMethod_ = @MyAnnotation)
    private int id;
    @Setter(onMethod_ = {@MyAnnotation, @Deprecated})
    private String name;
    private int num;
    @Setter(onParam_ = @MyAnnotation)
    public String desc;
}

产生的源码如下：

public class User {
    private int id;
    private String name;
    private int num;
    public String desc;

    @Generated
    public void setNum(int num) {
        this.num = num;
    }

    @MyAnnotation
    @Generated
    public void setId(int id) {
        this.id = id;
    }

    /** @deprecated */
    @Deprecated
    @MyAnnotation
    @Generated
    public void setName(String name) {
        this.name = name;
    }

    @Generated
    public void setDesc(@MyAnnotation String desc) {
        this.desc = desc;
    }
}

可以看到每一个方法或参数都按照@Setter 中指定的信息产生了指定的代码。

上面使用的注解 @Deprecated 是JDK自带的，而 @MyAnnotation 是自已定义的：

@Retention(RetentionPolicy.CLASS)
@Target({ElementType.METHOD,ElementType.PARAMETER})
public @interface MyAnnotation {
}

3.2、Getter注解

Getter 注解用于修饰类或其属性。用法与Setter很类似，不同点在于该注解可以为 final 属性产生getter方法。

  • 修饰类，为类中的非 static 且未使用 @Getter 的属性产生 getter 方法

  • 修饰非 static 属性，为该属性产生对应的 getter 方法

Getter注解的属性：

  • value：与Setter的属性value相同，用于指定产生getter方法的访问控制修饰符，就不赘述了

  • onMethod：与Setter的属性onMethod相同，用于在产生的getter方法上产生指定的注解

  • lazy：用于修饰private final 成员的注解上，产生一个线程安全的取值方法

使用示例：

@Getter
public class User {
    private int id;
    private String name;
    private final int num = 0;
}

没有特别指定属性 lazy，默认就是false，产生的源码如下：

public class User {
    private int id;
    private String name;
    private final int num = 0;

    @Generated
    public int getId() {
        return this.id;
    }

    @Generated
    public String getName() {
        return this.name;
    }

    @Generated
    public int getNum() {
        Objects.requireNonNull(this);
        return 0;
    }
}

对于fnal属性，仅仅做了一个非空校验。如果设置 lazy 为 true：

@Getter
public class User {
    private int id;
    private String name;
    @Getter(lazy = true)
    private final int num = 0;
}

产生的源码如下：

import java.util.concurrent.atomic.AtomicReference;
import lombok.Generated;

public class User {
    private int id;
    private String name;
    private final AtomicReference<Object> num = new AtomicReference();

    @Generated
    public int getId() {
        return this.id;
    }

    @Generated
    public String getName() {
        return this.name;
    }

    @Generated
    public int getNum() {
        // 通过this.num.get()获取当前值并存储在$value变量中
        Object $value = this.num.get(); 
        // 第一次检查$value是否为null（双重检查锁的第一次检查）
        if ($value == null) {
            //如果为null，进入同步块（使用this.num作为锁对象）
            synchronized(this.num) {
                $value = this.num.get();
                // 在同步块内再次检查$value是否为null（双重检查锁的第二次检查）
                if ($value == null) {
                    //如果仍然为null，则初始化值为 0，将其赋值给$value并通过this.num.set($value)设置到原子引用中
                    int actualValue = 0;
                    $value = 0;
                    this.num.set($value);
                }
            }
        }
        // 最后将$value强制转换为Integer并返回
        return (Integer)$value;
    }
}

这段代码中的getNum()方法实现了一个线程安全的 “懒加载” 初始化逻辑，用于获取num变量的值。这是 “双重检查锁定”(Double-Checked Locking) 设计模式的实现，目的是在多线程环境下保证num只会被初始化一次，既保证了线程安全，又避免了每次获取值时都进入同步块带来的性能损耗。这种实现方式在需要延迟初始化且有线程安全要求的场景中比较常见。

3.3、ToString注解

ToString注解只能修饰类，用于为类产生 toString 方法。不指定该注解的任何属性，会将类中的所有属性直接拼接到返回的字符串结果中。如果属性有对应的getter方法，则使用getter方法获取值，没有对应的getter方法，直接使用属性值。如下面类中的属性是没有对应getter方法的：

@ToString
public class User {
    private int id;
    private String name;
    private Address address;   // 另一个类
}

最终产生的toString如下，获取属性的值直接就是属性：

public String toString() {
	return "User(id=" + this.id + ", name=" + this.name + ", address=" + this.address + ")";
}

如果在类上使用了Getter注解，产生的toString方法如下：

public String toString() {
    return "User(id=" + this.getId() + ", name=" + this.getName() + ", address=" + this.getAddress() + ")";
}

ToString注解的属性：

  • includeFieldNames：返回的字符串信息中是否使用包含成员属性名，默认是 true，如果设置为false，产生的toString方法如下：
public String toString() {
    return "User(" + this.getId() + ", " + this.getName() + ", " + this.getAddress() + ")";
}
  • exclude：排除不出现在返回字符串结果中的成员属性名
@ToString(exclude = {"id","address"})     // 排除属性 id 与 address
public class User {
    private int id;
    private String name;
    private Address address;
}

结果为：

public String toString() {
    return "User(name=" + this.getName() + ")";
}

不过该属性很快会被弃用，官方推荐使用@ToString.Exclude ：

@Getter
@ToString
public class User {
    @ToString.Exclude
    private int id;
    private String name;
    @ToString.Exclude
    private Address address;
}
  • callSuper：设置是否包含父类的toString实现，默认是false；设置为true，则产生的toStirng为：
public String toString() {
    return "User(super=" + super.toString() + ", id=" + this.getId() + ", name=" + this.getName() + ", address=" + this.getAddress() + ")";
}
  • doNotUseGetters：设置是否不使用 getter 方法获取属性的值，默认是 false，如果设置为 true，则toStirng方法为：
public String toString() {
    return "User(id=" + this.id + ", name=" + this.name + ", address=" + this.address + ")";
}
  • of：指定toString返回的字符串中要包含的属性
@Getter
@ToString(of={"name"})
public class User {
    private int id;
    private String name;
    private Address address;
}

产生的toString方法为：

public String toString() {
    return "User(name=" + this.getName() + ")";
}

返回的字符串只包含of属性中指定的name属性。该属性也很快会被弃用，官方推荐使用@ToString.Include注解，与onlyExplicitlyIncluded=true一起使用。

  • onlyExplicitlyIncluded：设置是否只包含使用了ToString.Include修饰的属性，默认为false；如果设置为true，如下所示：
@Getter
@ToString(onlyExplicitlyIncluded = true)
public class User {
    private int id;
    @ToString.Include
    private String name;
    private Address address;
}

产生的toString为：

public String toString() {
    return "User(name=" + this.getName() + ")";
}

可以看到toString返回的字符串中只包含了name属性的值。

3.4、EqualsAndHashCode注解

EqualsAndHashCode修饰类，用于产生equals方法和hashCode方法。例如：

@Getter
@EqualsAndHashCode
public class User {
    private int id;
    private String name;
}

产生的源码如下：

public class User {
    private int id;
    private String name;

    @Generated
    public int getId() {
        return this.id;
    }

    @Generated
    public String getName() {
        return this.name;
    }

    @Generated
    public boolean equals(Object o) {
        if (o == this) {
            return true;
        } else if (!(o instanceof User)) {
            return false;
        } else {
            User other = (User)o;
            if (!other.canEqual(this)) {
                return false;
            } else if (this.getId() != other.getId()) {
                return false;
            } else {
                Object this$name = this.getName();
                Object other$name = other.getName();
                if (this$name == null) {
                    if (other$name != null) {
                        return false;
                    }
                } else if (!this$name.equals(other$name)) {
                    return false;
                }
                return true;
            }
        }
    }

    @Generated
    protected boolean canEqual(Object other) {
        return other instanceof User;
    }

    @Generated
    public int hashCode() {
        int PRIME = 59;
        int result = 1;
        result = result * 59 + this.getId();
        Object $name = this.getName();
        result = result * 59 + ($name == null ? 43 : $name.hashCode());
        return result;
    }
}

EqualsAndHashCode注解的属性：

  • exclude：指定排除参与equals方法与hashCode方法的属性，很快被弃用，官方推荐使用@EqualsAndHashCode.Exclude，与 @ToString 的 exclude 属性类似，就不再演示了

  • of：指定参与equals方法与hashCode方法的属性，很快被弃用，官方推荐使用@EqualsAndHashCode…Include，与 onlyExplicitlyIncluded=true一起使用，就不再演示了

  • onlyExplicitlyIncluded：设置是否值显式包含 @EqualsAndHashCode.Include 修饰的属性

  • callSuper：产生equals与hashCode方法时是否调用父类的对应方法，默认为false；与@ToString中的callSuper属性类似，不再赘述

  • doNotUseGetters：与@ToString中的doNotUseGetters属性类似，就不赘述了。

  • onParam：在产生的equals方法中参数前增加该属性指定的注解，与Setter注解中的onParam类似。

  • cacheStrategy：设置hashCode的缓存策略，CacheStrategy 枚举类型，只有 NEVER 与 LAZY 两个值，默认值是CacheStrategy.NEVER，即不缓存类如㝉设置为true，则 hashCode 方法如下：

private transient int $hashCodeCache;

public int hashCode() {
    if (this.$hashCodeCache != 0) {
        return this.$hashCodeCache;
    } else {
        int PRIME = 59;
        int result = 1;
        result = result * 59 + this.id;
        Object $name = this.name;
        result = result * 59 + ($name == null ? 43 : $name.hashCode());
        if (result == 0) {
            result = Integer.MIN_VALUE;
        }

        this.$hashCodeCache = result;
        return result;
    }
}

可以看到，在类中增加了一个私有属性，用于缓存产生的 hash 值。

【好用的工具】lombok 使用指南
天天新知
03-27 504
Lombok 是一种 Java 实用工具，可用来帮助开发人员消除 Java 的冗长，尤其是对于简单的 Java 对象（POJO）。它通过注释实现这一目的。通过在开发环境中实现 Lombok，开发人员可以节省构建诸如 hashCode() 和 equals() 这样的方法以及以往用来分类各种 accessor 和 mutator 的大量时间。
Java开发之Lombok指南
08-25
Lombok 是一个强大的 Java 开发工具，它通过注解的方式帮助开发者简化代码，避免编写大量重复的样板代码，如 getter、setter、equals、hashCode、构造函数等。Lombok 不依赖于运行时反射，而是在编译阶段就自动生成...
Lombok使用指南
最新发布
weixin_74417835的博客
04-05 2595
Lombok是一个Java库，它通过注解的方式，帮助开发者减少样板代码的编写，如getter、setter、构造方法、equals、hashCode等方法。Lombok在编译时自动生成这些代码，使Java代码更加简洁、易读。@Data@Builder@Entity@Id@Column@Data@Builder@NotBlank(message = "用户名不能为空")@NotBlank(message = "密码不能为空")
@lombok从源码层面学习
withoutdarkcolor的博客
05-13 2031
概述 lombok我们主要用来减少get、set和空参和全参的重复性代码，本文希望深入学习来理解其原理和避免一些坑。本文涉及到的所有代码均放在了我的码云上，有兴趣的可以点个star。其官网描述1为： Project Lombok aims to reduce the prevalence of some of the worst offenders by replacing them with a simple set of annotations. （Project Lombok 旨在通过用一组简单的注
lombok常见注解的用法
gongsl
06-05 993
lombok一些注解的用法
Lombok使用手册
HongYu012的博客
02-21 601
一、序言 对于 Lombok 的使用是有争议的，作者对 Lombok 的态度是强烈推荐，甚至认为应当将部分常用功能直接以 JDK 的形式集成。 在构建实体类过程中写一堆Set/Get方法毫无意义；默认继承Object类的toString方法官方建议重写，每个实体类为了表达具象的实体信息而重写toString方法，操作繁琐。 二、常用注解解析 （一）实体类注解 下面讨论的注解是添加到实体类上面的。 public class XUser { private Integer user...
lombok详细使用文档
03-08
lombok详细说明文档， 包含插件的使用以及插件注解的使用
Android Studio中Lombok使用指南及问题解决
本指南记录了在Android Studio 1.2.2及1.3 beta版本中集成和使用Lombok的具体步骤。 **1. 添加Lombok到项目依赖** 要在Android Studio项目中使用Lombok，首先需要将其添加到项目的Gradle依赖中。这通常涉及到修改...
Lombok库压缩包使用指南
资源摘要信息: "Lombok-Jar包使用与配置指南" 知识点一：Lombok概述 Lombok是一个Java库，它通过注解的方式自动生成那些繁琐且重复性的代码，如getter和setter方法、equals和hashCode方法、toString方法等。通过...
提升开发效率：IntelliJ IDEA Lombok插件使用指南
标题："Lombok Idea插件" 知识点一：Lombok介绍 Lombok是一个Java库，旨在通过注解的方式简化Java代码的编写。...同时，这个名称也可能表示一个指南或教程的文件名，用于指导开发者如何安装Lombok。
Lombok使用详解
热门推荐
划不出的界限
04-22 5万+
Lombok使用详解 前言 在Java中,封装是一个非常好的机制,最常见的封装莫过于get,set方法了,无论是Intellij idea 还是Eclipse，都提供了快速生成get,set方法的快捷键,使用起来很是方便，其实,我们还有更方便的办法,就是今天的主角-Lombok Lombok是什么? Lombok是一个通过注解以达到减少代码的Java库,如通过注解的方式减少
lombok使用基础教程
jamieblue1的博客
08-19 1799
一、前言 lombok是一个编译级别的插件，它可以在项目编译的时候生成一些代码。在很多工具类的项目中都有这个功能。比如dagger。 通俗的说，lombok可以通过注解来标识生成getter settter等代码。我们自然可以通过编译器比如IDEA的Generate生成，为啥要用这个？ 在项目开发阶段，一个class的属性是一直变化的，今天可能增加一个字段，明天可能删除一个字段。每次变化都需要修改...
lombok使用手册
qq_37889636的博客
10-15 432
将lombok.jar放到某盘 例如D: 运行这个jar 弹出下边这个界面 点击Specify location.. 选择当前使用的java开发工具的exe文件后 Install （注意路径不能有中文） 执行完毕点击Quit关闭 到开发工具exe文件目录，打开ini文件查看最后一行lombok是否是这样。是的话就是添加成功了 最后一步到项目的pom中添加lo...
Lombok 操作手册(一)
wjsshhx的专栏
03-18 3246
这里介绍一款工具，用来某种程度上解释下为啥我在 GitHub 上 号召代码整洁。 具体优点不在这里赘述，核心就是能少些代码完成同样的功能 这款工具的名字叫做 Lombok 官网地址 安装教程我以及怎样在项目中引用 我就不写了，具体去看官网视频，但是关于安装有两点注意事项要说下 建议下载下来jar自己双击安装，选择Eclipse路径时候选到exlipse.ini 所在的那一级目录
Lombok的使用教程
JackiAndroid的专栏
02-11 948
一、Lombok简介 Lombok项目是一个Java库，它会自动插入您的编辑器和构建工具中，从而为您的Java增光添彩。 永远不要再编写另一个getter或equals方法，一个带有注释的类将具有功能全面的生成器，自动执行日志记录变量等等。 简而言之，就是自动帮您生成setter和getter，toString、equals等方法。 二、Lombok插件安装 1.1 下载Intellij Ide...
Lombok介绍、使用方法和总结
张晨光老师的播客
01-31 676
1 Lombok背景介绍 官方介绍如下： Project Lombok makes java a spicier language by adding 'handlers' that know how to build and compile simple, boilerplate-free, not-quite-java code. 大致意思是Lombok通过增加一些“处理程序”，可以让...
Lombok 使用完全指南
YellowStar5
08-10 229
为什么要使用lombok。 1.普通的 POJO 需要写或是用IDEA等集成开发环境生成大量gettter, setter方法 2.普通的 POJO 对于 equals 和 hashCode 等方法，也需要自己维护。特别你写接口的时候，如果添加了 一个字段忘了维护，可能会导致一些bug。 3.普通的 POJO 没有 builder 的支持，得自己实现该模式。 … 总之，lombok 极大地简化你...
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
表情包 代码片
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值