Lombok使用

最新推荐文章于 2025-03-14 08:00:00 发布
最新推荐文章于 2025-03-14 08:00:00 发布
阅读量409 收藏
点赞数
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_26386613/article/details/104487306

在一个POJO的定义中，我们往往会用到很多setter和很多的getter，如果这些全部由我们自己手动敲出来，岂不是太浪费时间？
Lombok在这方面起到了很大的作用。

依赖

要使用Lombok，首先我们要将Lombok引入maven

<!-- https://mvnrepository.com/artifact/org.projectlombok/lombok -->
<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <version>1.18.12</version>
    <scope>provided</scope>
</dependency>

安装插件

在IDEA中使用Lombok时仅仅引入时不够的，因为Lombok的生效是在编译阶段，而我们在编写的时候如果不安装插件则会因为代码检测不到相应的setter和getter而报错

插件安装方法：
File — setting – Plugins处搜索Lombok并且下载
在这里插入图片描述

开始使用

注解

@Data
@Setter
@Getter
@Log4j2
@AllArgsConstructor
@NoArgsConstructor
@EqualsAndHashCode
@NonNull
@Cleanup
@ToString
@RequiredArgsConstructor
@Value
@SneakyThrows
@Synchronized

详解

为了比较区别，我使用java源码与编译后的class字节码文件反编译的代码进行比较

@Data

注解在类上；提供类所有属性的 get 和 set 方法，此外还提供了equals、canEqual、hashCode、toString 方法。

//HotNew.java
@Data
public class HotNew {
    private long id;
    private String title;
    private long authorId;
}

//HotNew.class反编译
public class HotNew {
    private long id;
    private String title;
    private long authorId;

    public HotNew() {
    }

    public long getId() {
        return this.id;
    }

    public String getTitle() {
        return this.title;
    }

    public long getAuthorId() {
        return this.authorId;
    }

    public void setId(final long id) {
        this.id = id;
    }

    public void setTitle(final String title) {
        this.title = title;
    }

    public void setAuthorId(final long authorId) {
        this.authorId = authorId;
    }

    public boolean equals(final Object o) {
        if (o == this) {
            return true;
        } else if (!(o instanceof HotNew)) {
            return false;
        } else {
            HotNew other = (HotNew)o;
            if (!other.canEqual(this)) {
                return false;
            } else if (this.getId() != other.getId()) {
                return false;
            } else {
                Object this$title = this.getTitle();
                Object other$title = other.getTitle();
                if (this$title == null) {
                    if (other$title == null) {
                        return this.getAuthorId() == other.getAuthorId();
                    }
                } else if (this$title.equals(other$title)) {
                    return this.getAuthorId() == other.getAuthorId();
                }

                return false;
            }
        }
    }

    protected boolean canEqual(final Object other) {
        return other instanceof HotNew;
    }

    public int hashCode() {
        int PRIME = true;
        int result = 1;
        long $id = this.getId();
        int result = result * 59 + (int)($id >>> 32 ^ $id);
        Object $title = this.getTitle();
        result = result * 59 + ($title == null ? 43 : $title.hashCode());
        long $authorId = this.getAuthorId();
        result = result * 59 + (int)($authorId >>> 32 ^ $authorId);
        return result;
    }

    public String toString() {
        return "HotNew(id=" + this.getId() + ", title=" + this.getTitle() + ", authorId=" + this.getAuthorId() + ")";
    }
}
@Setter

注解在类上，提供类中所有变量的setter； 注解在变量上， 提供单个变量的setter

//注解在类上： HotNew.java
@Setter
public class HotNew {
    private long id;
    private String title;
    private long authorId;
}

//注解在类上： HotNew.class
public class HotNew {
    private long id;
    private String title;
    private long authorId;

    public HotNew() {
    }

    public void setId(final long id) {
        this.id = id;
    }

    public void setTitle(final String title) {
        this.title = title;
    }

    public void setAuthorId(final long authorId) {
        this.authorId = authorId;
    }
}
@Getter

同@Setter用法

//注解在类上： HotNew.java
@Getter
public class HotNew {
    private long id;
    private String title;
    private long authorId;
}

//注解在类上： HotNew.class
public class HotNew {
    private long id;
    private String title;
    private long authorId;

    public HotNew() {
    }

    public long getId() {
        return this.id;
    }

    public String getTitle() {
        return this.title;
    }

    public long getAuthorId() {
        return this.authorId;
    }
}

@Log4j2

注解在类上,为类提供一个 属性名为 log 的 log4j2 日志对象，提供默认构造方法。

//HotNew.java
@Log4j2
public class HotNew {
    private long id;
    private String title;
    private long authorId;
}

//HotNew.class
public class HotNew {
    private static final Logger log = LogManager.getLogger(HotNew.class);
    private long id;
    private String title;
    private long authorId;

    public HotNew() {
    }
}

@AllArgsConstructor

注解在类上，提供一个全参的构造方法，且会移除默认的无参构造方法

//HotNew.java
@AllArgsConstructor
public class HotNew {
    private long id;
    private String title;
    private long authorId;
}

//HotNew.class
public class HotNew {
    private long id;
    private String title;
    private long authorId;

    public HotNew(final long id, final String title, final long authorId) {
        this.id = id;
        this.title = title;
        this.authorId = authorId;
    }
}

@NoArgsConstructor

注解在类上，为类提供一个无参的构造方法

//HotNew.java
@NoArgsConstructor
@AllArgsConstructor
public class HotNew {
    private long id;
    private String title;
    private long authorId;
}

//HotNew.class
public class HotNew {
    private long id;
    private String title;
    private long authorId;

    public HotNew() {
    }

    public HotNew(final long id, final String title, final long authorId) {
        this.id = id;
        this.title = title;
        this.authorId = authorId;
    }
}

@EqualsAndHashCode

注解在类上, 可以生成 equals、canEqual、hashCode 方法。

//HotNew.java
@EqualsAndHashCode
public class HotNew {
    private long id;
    private String title;
    private long authorId;
}

//HotNew.class
public class HotNew {
    private long id;
    private String title;
    private long authorId;

    public HotNew() {
    }

    public boolean equals(final Object o) {
        if (o == this) {
            return true;
        } else if (!(o instanceof HotNew)) {
            return false;
        } else {
            HotNew other = (HotNew)o;
            if (!other.canEqual(this)) {
                return false;
            } else if (this.id != other.id) {
                return false;
            } else {
                Object this$title = this.title;
                Object other$title = other.title;
                if (this$title == null) {
                    if (other$title == null) {
                        return this.authorId == other.authorId;
                    }
                } else if (this$title.equals(other$title)) {
                    return this.authorId == other.authorId;
                }

                return false;
            }
        }
    }

    protected boolean canEqual(final Object other) {
        return other instanceof HotNew;
    }

    public int hashCode() {
        int PRIME = true;
        int result = 1;
        long $id = this.id;
        int result = result * 59 + (int)($id >>> 32 ^ $id);
        Object $title = this.title;
        result = result * 59 + ($title == null ? 43 : $title.hashCode());
        long $authorId = this.authorId;
        result = result * 59 + (int)($authorId >>> 32 ^ $authorId);
        return result;
    }
}

@NonNull

注解在变量上，自动产生改参数的非空检查，参数为空则报空指针

//HotNew.java
public class HotNew {
    @NonNull
    private long id;
    private String title;
    private long authorId;
}

//HotNew.class
public class HotNew {
    @NonNull
    private long id;
    private String title;
    private long authorId;

    public HotNew() {
    }
}

@Cleanup

这个注解用在变量前面，可以保证此变量代表的资源会被自动关闭，默认是调用资源的 close() 方法，如果有其它关闭方法，可使用 @Cleanup(“方法名”) 来指定要调用的方法

//Test.java
public class Test {
    public static void main(String[] args) throws IOException {
        @Cleanup InputStream inputStream = new FileInputStream(args[0]);
    }
}

//Test.class
public class Test {
    public Test() {
    }

    public static void main(String[] args) throws IOException {
        InputStream inputStream = new FileInputStream(args[0]);
        if (Collections.singletonList(inputStream).get(0) != null) {
            inputStream.close();
        }

    }
}

@ToString

这个注解用在类上，生成所有参数的 toString 方法

//HotNew.java
@ToString
public class HotNew {
    private long id;
    private String title;
    private long authorId;
}

//HotNew.class
public class HotNew {
    private long id;
    private String title;
    private long authorId;

    public HotNew() {
    }

    public String toString() {
        return "HotNew(id=" + this.id + ", title=" + this.title + ", authorId=" + this.authorId + ")";
    }
}

@RequiredArgsConstructor

注解到类上，产生类中所有带@NonNull和final修饰的成员变量的构造方法

//HotNew.java
@RequiredArgsConstructor
public class HotNew {
    private long id;
    @NonNull
    private String title;
    private final long authorId;
}

//HotNew.class
public class HotNew {
    private long id;
    @NonNull
    private String title;
    private final long authorId;

    public HotNew(@NonNull final String title, final long authorId) {
        if (title == null) {
            throw new NullPointerException("title is marked non-null but is null");
        } else {
            this.title = title;
            this.authorId = authorId;
        }
    }
}

@Value

注解在类上，产生全参的构造方法，get方法，equals、hasCode、toString方法

//HotNew.java
@Value
public class HotNew {
    private long id;
    private String title;
    private long authorId;
}

//HotNew.class
public final class HotNew {
    private final long id;
    private final String title;
    private final long authorId;

    public HotNew(final long id, final String title, final long authorId) {
        this.id = id;
        this.title = title;
        this.authorId = authorId;
    }

    public long getId() {
        return this.id;
    }

    public String getTitle() {
        return this.title;
    }

    public long getAuthorId() {
        return this.authorId;
    }

    public boolean equals(final Object o) {
        if (o == this) {
            return true;
        } else if (!(o instanceof HotNew)) {
            return false;
        } else {
            HotNew other = (HotNew)o;
            if (this.getId() != other.getId()) {
                return false;
            } else {
                Object this$title = this.getTitle();
                Object other$title = other.getTitle();
                if (this$title == null) {
                    if (other$title == null) {
                        return this.getAuthorId() == other.getAuthorId();
                    }
                } else if (this$title.equals(other$title)) {
                    return this.getAuthorId() == other.getAuthorId();
                }

                return false;
            }
        }
    }

    public int hashCode() {
        int PRIME = true;
        int result = 1;
        long $id = this.getId();
        int result = result * 59 + (int)($id >>> 32 ^ $id);
        Object $title = this.getTitle();
        result = result * 59 + ($title == null ? 43 : $title.hashCode());
        long $authorId = this.getAuthorId();
        result = result * 59 + (int)($authorId >>> 32 ^ $authorId);
        return result;
    }

    public String toString() {
        return "HotNew(id=" + this.getId() + ", title=" + this.getTitle() + ", authorId=" + this.getAuthorId() + ")";
    }
}

@SneakyThrows

注解在方法上，可以将方法中的代码用 try-catch 语句包裹起来，捕获异常并在 catch 中用 把异常抛出，可以使用 @SneakyThrows(Exception.class) 的形式指定抛出哪种异常，也会生成默认的构造方法。

//Test.java
public class Test {
    @SneakyThrows(IOException.class)
    public static void main(String[] args) throws IOException {
        InputStream inputStream = new FileInputStream(args[0]);
    }
}

//Test.class
public class Test {
    public Test() {
    }

    public static void main(String[] args) throws IOException {
        try {
            new FileInputStream(args[0]);
        } catch (IOException var2) {
            throw var2;
        }
    }
}

@Synchronized

这个注解用在类方法或者实例方法 上，效果和 synchronized 关键字相同synchronized 关键字的锁对象分别是类的 class 对象和 this 对象，而 @Synchronized 的锁对象默认是私有静态 final 对象 lock 和 私有 final 对象 lock，当然，也可以自己指定锁对象，此外也提供默认的构造方法。

无参考代码

WAY55
关注
Java基础学习总结（131）——项目开发中真的有必要使用Lombok插件么？
科技D人生
08-11 9625
一、Lombok是什么 Lombok是一个可以通过简单的注解形式来帮助我们简化消除一些必须有但显得很臃肿的Java代码的工具，通过使用对应的注解，可以在编译源码的时候生成对应的方法。简而言之，一句话就是：通过简单的注解来精简代码达到消除冗长代码的目的。Lombok提供注解方式来提高代码的简洁性,常用注解有：@Data，@Setter @Getter，@NonNull，@Synchronized，...
Lombok 使用教程-onX | 为Lombok注解添加自定义注解
smart_an的专栏
08-14 1188
这个功能被认为是 “变通状态”–它的存在是为了让那些没有这个功能就无法工作的lombok用户无论如何都能使用这个功能。如果我们找到一个更好的方法来实现这个功能，或者未来的某个java版本引入了一个替代策略，这个功能可以在没有一个合理的废弃期的情况下消失。另外，这个功能可能在未来的javac版本中无法使用。使用时请自行斟酌。大多数使lombok生成方法或构造函数的注解可以被配置为使lombok在生成的代码中的元素上添加自定义注解。@Getter@Setter和@Wither支持onMethod。
Lombok使用及JavaWeb知识点小结
qq_44495081的博客
02-18 844
一、JavaWeb 1、什么是Javaweb 就是使用 java语言写Web网站 静态网站和动态网站的区别 静态网站：HTML、CSS、JS 动态网站：Servlet/JSP，等和数据库连接 项目中导入依赖的方式 手动导入需要的jar包，然后将jar包添加到项目的依赖中 使用Maven，在https://mvnrepository.com/ 上查找相关的依赖，然后配置到在pom.xml中，项...
lombok.jar
12-04
lombok.jar 工具包 里面包含使用说明 看说明即可
【JavaWeb的从0到1构建知识体系（三）】JDBC和Lombok的使用
Kplusone的博客
11-04 355
JDBC和lombok
Lombok 使用详解，简化 Java 编程
公众号：Java后端
02-18 291
作者 |日拱一兵来源 | 公众号（日拱一兵）在 Java 应用程序中存在许多重复相似的、生成之后几乎不对其做更改的代码，但是我们还不得不花费很多精力编写它们来满足 Java 的编译需...
Lombok 使用教程-@Synchronized | 如何优雅的添加Synchronized锁
smart_an的专栏
08-12 886
是方法修饰语的一个更安全的变体。和一样，该注解只能用于静态和实例方法。它的操作与关键字类似，但它锁定的对象不同。关键字锁定了这个对象，但注解锁定了一个名为$lock的字段，它是私有的。如果你愿意，你可以自己创建这些锁。如果你已经自己创建了$lock和$LOCK字段，当然就不会再生成它们。你也可以选择锁定另一个字段，通过指定它作为注释的参数。在这种用法的变体中，字段不会被自动创建，你必须自己明确地创建它们，否则会发出一个错误。
Lombok 使用教程-@Getter(lazy=true) | Getter 懒加载
smart_an的专栏
08-12 1027
是在中引入的。你可以让lombok生成一个getter，它将在第一次调用这个getter时计算一个值，并从那时起缓存它。如果计算数值需要大量的CPU，或者数值需要大量的内存，这就很有用。要使用这个功能，创建一个变量，用运行成本高的表达式来初始化它，并用来注释你的字段。这个字段将从你的代码的其余部分隐藏起来，并且表达式的评估不会超过一次，即在第一次调用getter的时候。没有神奇的标记值（也就是说，即使你昂贵的计算结果是空的，结果也会被缓存），你昂贵的计算不需要是线程安全的，因为lombok负责锁。
Lombok使用讲解及原理1
08-04
下面我们将深入探讨 Lombok 的主要注解及其使用场景。 首先，Lombok 提供的 `val` 注解允许你声明一个局部变量为 final，这在你需要确保变量值不会被改变的情况下非常有用。 `@NonNull` 注解用于方法参数，当检测...
lombok使用demo
08-13
lombok 使用demo
Lombok
m0_65735686的博客
11-13 1122
Lombok 插件的主要作用是，通过简单的注解，降低 Java 实体类中的冗余代码，使代码看起来更加简洁。@Data//注解在类，生成 set/get、equals、canEqual、hashCode、toString 方法，但不会为 final 属性生成 set 方法。@AllArgsConstructor//注解在类，生成包含所有参数的构造方法。@NoArgsConstructor//注解在类，生成无参构造方法。
JavaWeb——Mybatis-入门(6/6)-lombok工具包介绍（概述与常用注解、在项目中使用 Lombok、Lombok 原理、使用 Lombok 的注意事项）
最新发布
li13437542099的博客
03-14 1112
功能简介Lombok 是一个实用的 Java 库，通过简单注解自动生成实体类中常用方法，如构造器、getset方法、equalshashCode方法、toString方法等，还能自动生成日志变量，简化 Java 开发过程，提高开发效率。常用注解介绍注解作用为所有的属性提供get/set方法@ToString会给类自动生成易阅读的toString方法根据类所拥有的非静态字段自动重写equals方法和hashCode方法@Data。
3-【JavaWeb】Lombok配置及使用方法介绍
weixin_44329069的博客
09-11 1485
Lombok 是一个帮助简化 Java 类中样板代码的 Java 库。比如，你经常会发现自己重复编写。
Java Web学习笔记70——lombok工具包介绍
CCH2024的专栏
06-16 173
Java Web学习笔记
Spring Web的创建,LomBok的配置以及MyBatis&MyBatisPlus的配置实现
qq_45428087的博客
11-15 536
Spring Web/LomBok/MyBatis/MyBatisPlus的使用以及配置
你现在还在手动生成set，get方法吗？使用lombok
热门推荐
互扯程序的博客
11-26 12万+
JAVA面向对象编程中的封闭性和安全性。封闭性即对类中的域变量进行封闭操作，即用private来修饰他们，如此一来其他类则不能对该变量访问。这样我们就将这些变量封闭在了类内部，这样就提高了数据的安全性，当我们想要操作这些域变量怎么办呢？ 我们可以通过两种方法，第一种即通过public方式的构造器（或称构造函数），对象一实例化就对该变量赋值。第二种就是通过set和get方法进行赋值...
Lombok 看这篇就够了
zhaoxj_2017的博客
02-26 194
前提 自从进公司实习后，项目代码中能用 Lombok 的都用了，毕竟这么好的轮子要充分利用好。也可以减少一些 get/set/toString 方法的编写，虽说 IDEA 的插件可以自动生成 get/set/toString 方法，但是使用 Lombok 可以让代码更简洁。 下面看看如何在 IDEA　中如何安装 Lombok： 安装 打开 IDEA 的 Settings 面板，并选择 Plu...
Java效率工具Lombok使用及原理
weixin_34268753的博客
04-18 347
还在编写无聊枯燥又难以维护的POJO吗？洁癖者的春天在哪里？请看Lombok！ 在过往的Java项目中，充斥着太多不友好的代码：POJO的getter/setter/toString；异常处理；I/O流的关闭操作等等，这些样板代码既没有技术含量，又影响着代码的美观，Lombok应运而生。 首先说明一下：任何技术的出现都是为了解决某一类问题的，如果在此基础上再建立奇技淫巧，不如回归Java本身。应该...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值