Lombok快速入门

已于 2024-04-25 22:33:06 修改
阅读量766 收藏 30
点赞数 16
分类专栏： java 文章标签： 开发语言 java idea
于 2024-04-21 15:42:45 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/m0_74114518/article/details/138032639
版权

为什么要使用Lombok

在Java开发中，getter、setter、equals、hashCode、toString等方法是非常常见的，但这些方法通常不包含任何业务逻辑，仅仅是数据访问或对象比较的简单实现。而Lombok可以让我们通过注解自动生成这些方法，极大地减少了样板代码的数量，让代码更加简洁。

了解Lombok

Lombok是一个Java工具库，其主要目的是通过提供简单的注解来简化Java代码的编写，从而提高开发效率和代码的可读性、可维护性。

集成Lombok

1.下载Lombok插件
在这里插入图片描述
2.添加maven依赖

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

Lombok常用注解

在这里插入图片描述

@Getter/@Setter

自动产生 getter/setter方法

@Getter
@Setter
public class User {
    private Integer id;
    private String name;
}

效果等同于

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

    public Integer getId() {
        return id;
    }

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

    public String getName() {
        return name;
    }

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

自动重写 toString () 方法，会印出所有变量

@ToString
public class User {
    private Integer id;
    private String name;
}

效果等同于

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

    @Override
    public String toString() {
        return "User{" +
                "id=" + id +
                ", name='" + name + '\'' +
                '}';
    }
}
@EqualsAnd HashCode

自动生成 equals(Object other) 和 hashcode() 方法，包括所有非静态变量和非 transient 的变量

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

效果等同于

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

    @Override
    public boolean equals(Object o) {
        if (this == o) {
            return true;
        }
        if (!(o instanceof User user)) {
            return false;
        }
        return Objects.equals(id, user.id) && Objects.equals(name, user.name);
    }

    @Override
    public int hashCode() {
        return Objects.hash(id, name);
    }
}

如果某些变量不想要加进判断 ，可以通过 exclude 排除 ，也可以使用 of 指定某些字段

@EqualsAndHashCode(exclude = "name")
public class User {
    private Integer id;
    private String name;
}

效果等同于

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

    @Override
    public boolean equals(Object o) {
        if (this == o) {
            return true;
        }
        if (!(o instanceof User user)) {
            return false;
        }
        return Objects.equals(id, user.id);
    }

    @Override
    public int hashCode() {
        return Objects.hash(id);
    }
}
@NoArgsConstructor, @AllArgsConstructor, @RequiredArgsConstructorz

这三个注解的作用都是在自动生成该类的构造器，差别在于生成的构造器的参数不一样

@NoArgsConstructor

生成一个没有参数的构造器

@NoArgsConstructor
public class User {
    private Integer id;
    private String name;
}

效果等同于

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

    public User() {
    }
}
@AllArgsConstructor

生成一个包含所有参数的构造器

@AllArgsConstructor
public class User {
    private Integer id;
    private String name;
}

效果等同于

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

    public User(Integer id, String name) {
        this.id = id;
        this.name = name;
    }
}

注意，很多情况下使用@AllArgsConstructor要配合@NoArgsConstructor，因为当我们写了构造器后Java不会帮我们生成无参构造器，而很多地方，例如Spring Data JPA会需要每个类都一定要有一个无参数的构造器

@RequiredArgsConstructor

生成一个包含final 修饰词的变量的构造器

@RequiredArgsConstructor
public class User {
    private final Integer id;
    private String name;
}

效果等同于

public class User {
    private final Integer id;
    private String name;

    public User(Integer id) {
        this.id = id;
    }
}
@Data

相当于一个整合包，只要加了 @Data 这个注解，等于同时加了以下注解

  • @Getter/@Setter
  • @ToString
  • @EqualsAnd HashCode
  • @RequiredArgsConstructor
@Data
public class User {
    private Integer id;
    private String name;
}

效果等同于

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

    public Integer getId() {
        return id;
    }

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

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }
    
    public User(Integer id, String name) {
        this.id = id;
        this.name = name;
    }

    @Override
    public String toString() {
        return "User{" +
                "id=" + id +
                ", name='" + name + '\'' +
                '}';
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) {
            return true;
        }
        if (!(o instanceof User user)) {
            return false;
        }
        return Objects.equals(getId(), user.getId()) && Objects.equals(getName(), user.getName());
    }
}
@Value

也是一个整合包，但是他会把所有的变量都设成 final 的，其他的就跟 @Data 一样 ，等于同时加了以下注解

  • @Getter (注意没有setter)
  • @ToString
  • @EqualsAnd HashCode
  • @RequiredArgsConstructor
@Value
public class User {
    private Integer id;
    private String name;
}

效果等同于

public class User {
    private final Integer id;
    private final String name;

    public Integer getId() {
        return id;
    }

    public String getName() {
        return name;
    }

    public User(final Integer id, final String name) {
        this.id = id;
        this.name = name;
    }

    @Override
    public String toString() {
        return "User{" +
                "id=" + id +
                ", name='" + name + '\'' +
                '}';
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) {
            return true;
        }
        if (!(o instanceof User user)) {
            return false;
        }
        return Objects.equals(getId(), user.getId()) && Objects.equals(getName(), user.getName());
    }

    @Override
    public int hashCode() {
        return Objects.hash(getId(), getName());
    }
}

相较于之下，@Data 适合用在 POJO 或 DTO 上 ，@Value 适合加在只读的类上
值得注意的是 ，Lombok 的注解 @Value 和另一个 Spring 的注解 @Value 撞名，在 导入时不要导入错了

@Builder

自动生成流式set值写法，不用写一堆setter

@Builder
public class User {
    private Integer id;
    private String name;

    public static void main(String[] args) {
        User user = User.builder().id(1).name("John").build();
    }
}

效果等同于

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

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

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

    public static void main(String[] args) {
        User user = new User();
        user.setId(1);
        user.setName("John");
    }
}

虽然只要加上 @Builder 注解，我们就能够用流式写法快速设定对象的值 ，但是 setter 还是必须要写不能省略的 ，因为 Spring 或是其他框架有很多地方都会用到对象的 getter/setter 对他们取值/赋值
所以通常是 @Data 和 @Builder 会一起用在同个类上 ，既方便我们流式写代码 ，也方便框架做事

此外，关于@Builder注解还有一个坑，感兴趣的可以了解一下

@Slf4j

自动生成该类的log静态常量
注意，在使用@Slf4j时需先加上maven依赖

 <dependency>
     <groupId>org.slf4j</groupId>
     <artifactId>slf4j-api</artifactId>
     <version>2.0.12</version>
 </dependency>

@Slf4j
public class User {
    public static void main(String[] args) {
        log.info("running...");
    }
}

效果等同于

public class User {
    private static final Logger log = LoggerFactory.getLogger(User.class);

    public static void main(String[] args) {
        log.info("running...");
    }
}

SpringBoot默认支持的就是 slf4j + logback 的日志框架，因此Lombok中log系列注解最常用的就是@Slf4j

简单JavaBean的构建

我们可以通过以下代码简单构造一个JavaBean

@Data
@Slf4j
@Builder
@NoArgsConstructor
@AllArgsConstructor
public class User {
    public Integer id;
    public String name;
}

Lombok的优点与缺点

优点

1.减少样板代码：Lombok通过注解自动生成这些方法，极大地减少了样板代码的数量，让代码更加简洁。

2.提高开发效率：由于Lombok能够自动生成这些方法，开发者不再需要手动编写它们，从而可以专注于实现业务逻辑。这不仅可以加快开发速度，还可以减少出错的可能性，因为Lombok生成的代码通常比手动编写的代码更加准确和可靠。

3.保持代码一致性：Lombok生成的代码风格是统一的，这有助于保持代码的一致性，提高代码的可维护性。

4.易于集成和使用：Lombok的集成非常简单，只需要将其添加到项目的依赖中，并在IDE中安装相应的插件即可。使用Lombok也非常方便，只需要在类上添加相应的注解，Lombok就会在编译时自动生成对应的代码。

缺点

1.侵入性太强：强制让同事在IDE中安装对应插件，更重要的是，如果我们定义的一个jar包中使用了Lombok，那么要求所有依赖这个jar包的应用都必须安装插件；

2.代码可读性、调试性低：因为Lombok会自动生成很多代码，但这些代码是要在编译阶段才会生成，所以开发过程中，很多代码是缺失的；还有使用了lombok，想要看某个属性的set/get方法被哪些类调用，会很不方便；

3.坑，盲目使用对自动生成的代码不够了解，会容易产生意想不到的结果

4.影响jdk升级：如果项目中使用了lombok，会导致如果lombok官方没有及时升级版本到对应的jdk，使用lombok的代码也无法升级到新的jdk版本；

洛邙
关注
  • 16
    点赞
  • 踩
  • 30
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
LomBok入门
赈川
08-17 135
文章目录lombok入门lombok注解lombok详细学习 lombok入门 lombok 是一个非常神奇的 java 类库，会利用注解自动生成 java Bean 中烦人的 Getter、Setting，还能自动生成 logger、ToString、HashCode、Builder 等 java 特色的函数或是符合设计模式的函数，能够让你 java Bean 更简洁，更美观。 lombok注解...
Lombok 的简单入门
鱼开饭的博客
02-20 215
基于 idea + maven 的 lombok 的简单入门
lombok快速入门
console的博客
12-30 490
lombok Lombok是一个可以通过简单的注解形式来帮助我们简化消除一些必须有但显得很臃肿的Java代码的工具，通过使用对应的注解，可以在编译源码的时候生成对应的方法。官方地址：https://projectlombok.org/，github地址：https://github.com/rzwitserloot/lombok。 lombok技术本身没有好坏之分，只有把这个技术用在合适的地方，才能发挥它的价值。 那些一味吐槽lombok没用的人，和那些觉得自己掌握了lombok就高人一等的人，我们“文
Lombok快速入门及使用详情
08-03
Lombok 快速入门及使用详情 Lombok 是一个 Java 库，可以自动生成 Java 类的 getter、setter、构造器、toString 方法等，减少开发者的工作量。下面我们将详细介绍 Lombok 的使用详情。 1. 安装 IDEA Lombok 插件 ...
Spring_DATA_JPA:Spring Boot + Spring DATA JPA，快速入门
05-18
这是Spring_DATA_JPA的快速入门。 环境 Java 1.8。 h2数据库1.4.186 Lombok1.16.2 弹簧靴1.2.4.RELEASE spring-data-jps 1.7.2。发布 该程序如何运作 H2数据库启动。 您应该阅读属性文件。 运行此应用程序...
跳板：基于Spring Boot的生产级入门套件
01-30
入门套件，用于快速启动基于API的基于Spring的Java服务器的开发。 它包含Spring Boot开发人员在全新开发中应该选择的最佳实践和最新工具。 由于使用了JPA，因此开发人员可以自由选择任何基于SQL的数据库引擎来实现...
multilingual.zip
03-04
本项目使用了SpringBoot集成SSM，为所有Spring开发者更快的入门， 开箱即用，提供各种默认配置来简化项目配置，内嵌式容器简化Web项目 没有冗余代码生成和XML配置的要求使用类注解方式书写SQL语句， 简化XML配置...
test-automation-bootstrap：一个简单有效的样板存储库，可快速启动测试自动化框架
02-04
Lombok（样板代码生成器） 运行模拟测试的能力 HTML报告 Selenide（Seleniumwebdriver库） Selenium网格 :spouting_whale: Jenkins模板（兼容Kubernetes！） 声纳曲贝 :spouting_whale: 弹性堆叠 :spouting_...
Lombok的使用介绍（入门）
qq_42107430的博客
11-30 161
SSM项目中使用Lombok 关于Lombok的官方解释 官网连接：Lombok官网链接 大致意思 Project Lombok是一个java库，它可以自动插入编辑器并构建工具，为java增色。 永远不要再编写另一个getter或equals方法，使用一个注释，您的类就有了一个功能齐全的构建器，自动化您的日志变量，等等。 使用步骤 IDEA中安装Lombok插件 File-&g...
Lombok的介绍与入门使用
qq_38763540的博客
03-03 152
什么是Lombok
开发工具 - Lombok一文入门到入土~
彭_德华的博客
09-08 218
零、前言 Lombok开发利器，非常简单的一个工具。此片博客参看： 官网：https://projectlombok.org/ B站编程不良人：https://www.bilibili.com/video/BV1gg4y1v7Mi 使用Lombok环境要求：JDK1.8+，MAVEN，IDEA，Internet，… 。 在IDEA中安装使用步骤： 引入pom依赖 安装Lombok插件（需要重启） 在对应类上加上注解 文章目录零、前言一、Lombok入门1.Lombok介绍2.项目中使用Lombok
笃学私教：Lombok入门使用教程及其优缺点详解
weixin_46898270的博客
10-22 1370
在Java开发中，因工作需要，你可能会学习或被迫去学习Lombok这个工具，这玩意用起来可以说是贼爽，很方便，可玄武老师实际上并不推荐大家使用，至于Lombok是什么？怎么入门？为什么不推荐使用？下面，玄武老师会慢慢跟你讲解。 一、Lombok是什么？ 1、官方网站地址：点击直达 2、官网对Lombok的描述如下： Project Lombok is a java library that automatically plugs into your editor and build tools, spic
Lombok - 快速入门 & 实战
牧码的博客
03-30 384
package com.mmall.pojo; import lombok.AllArgsConstructor; import lombok.Data; import lombok.EqualsAndHashCode; import lombok.Getter; import lombok.NoArgsConstru...
Lombok常用注解
dxx707099957的博客
07-22 875
加入 maven 依赖 <dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> <version>1.18.12</version> </dependency> 1. @Getter/@Setter 自动产生 getter/setter ...
Lombok的入门使用
m0_55337678的博客
02-14 546
Lombok的入门
Lombok入门
黄天赐的博客
03-09 1361
1.添加maven依赖<!-- lombok --> <dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> <version>1.16.10</version> </dependency> 2.在idea中添加lombok插件Settings–>Plugins–>搜索
projectlombok
最新发布
04-18
Project Lombok是一个Java库，它通过注解的方式简化了Java代码的编写。它提供了一系列的注解，可以自动为Java类生成常见的代码，如getter和setter方法、构造函数、equals和hashCode方法等。使用Lombok可以减少冗余的...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值