【转载】Java工具篇之lombok

已于 2024-05-07 09:59:51 修改
阅读量8 收藏
点赞数
文章标签： java intellij-idea 开发语言
于 2024-05-07 09:55:47 首次发布
原文链接：https://www.cnblogs.com/likeguang/p/15463787.html
版权

Lombok

1、简单概述

工作中大量重复毫无技术的去书写get()、set()方法，不推荐手写，也不推荐利用idea中的工具类等等操作

而是使用lombok中的注解来一套搞定。

既然lombok能够搞定，那么需要理解一下是如何来搞定这一切的。

lombok除了get/set，还有一些其他的可以使用的。

可以去看一下官网：

Project Lombok is a java library that automatically plugs into your editor and build tools, spicing up your java.
Never write another getter or equals method again, with one annotation your class has a fully featured builder, Automate your logging variables, and much more.

lombok是一款比较常用的工具，可以用来帮助开发人员消除java中的冗长代码（也就是毫无技术可言的重复性工作），尤其是对于简单的java对象(POJO)，通过注解实现这一目的。

Lombok可以简化我们的代码书写方式。

Lombok的原理：

JSR269：插件化注解处理API

JDK6提供的特性，在javac编译期间利用注解搞事情。在编译期间可以利用lombok的注解方式来进行将生成的代码添加到字节码文件中去。我们利用Lombok注解生成的字节码文件中是包含了的。

二、使用

最常用的注解

2.1、@Data

可以自动的帮助我们生成get/seter、toString、hashcode和equals方法，但是呢，我们可以看到这种使用方式：

@Data
public class User {
    private String name;
}

在idea中看到对应的class目录：

public class User {
    private String name;

    public User() {
    }

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

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

    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 {
                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;
            }
        }
    }

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

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

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

可以看到其中的方法已经在上面对应好了，而且生成的还是当前类中的属性。

但是问题就出现在这里，我再写一个父类：

@Data
public class Person {
    private Integer id;
}

然后让其子类来进行继承：

@Data
@EqualsAndHashCode(callSuper = true)
public class User extends Person{
    private String name;
}

编译后的Java如下所示：

public class User extends Person {
    private String name;

    public User() {
    }

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

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

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

    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 (!super.equals(o)) {
                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;
            }
        }
    }

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

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

可以看到在equals方法中多了一个判断

if (!super.equals(o)) 
     return false;

@EqualsAndHashCode(callSuper = true)的作用就在于将子类和父类中的属性都来进行比较，举个例子进行说明：

父类Person：

@Data
public class Person {
    private Integer id;
}

子类User：

@Data
public class User extends Person{
    private String name;
}

测试方法：

    @Test
    void contextLoads() {
        User user1 = new User();
        User user2= new User();
        user1.setId(1);
        user2.setId(2);
        user1.setName("1");
        user2.setName("1");
        boolean equals = Objects.equals(user1, user2);
        log.info("两个对象是否是相等的？------>{}",equals); //true
    }

但是如果加了@EqualsAndHashCode(callSuper = true)

父类：

@Data
public class Person {
    private Integer id;
}

子类：

@Data
@EqualsAndHashCode(callSuper = true)
public class User extends Person{
    private String name;
}

再次运行测试类得到的却是false，那么为什么会有这样子的结果？

我们可以在不加@EqualsAndHashCode(callSuper = true)和不加的情况下分别看下class文件

2.2、@EqualsAndHashCode

不加@EqualsAndHashCode(callSuper = true)

public class User extends Person {
    private String name;

    public User() {
    }

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

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

    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 {
                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;
            }
        }
    }

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

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

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

加了@EqualsAndHashCode(callSuper = true)

public class User extends Person {
    private String name;

    public User() {
    }

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

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

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

    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 (!super.equals(o)) {
                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;
            }
        }
    }

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

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

综合这两个情况来进行对比，可以看到加了@EqualsAndHashCode(callSuper = true)之后，生成的equals方法中多了一个判断：

if (!super.equals(o)) {
     return false;
}

这里是在访问父类中的equals方法来进行判断，但是有时候我们希望使用到父类中的属性，有时候希望使用到子类中的属性。

所以我们需要根据当前的场景来进行选择，我现在使用的是直接将@EqualsAndHashCode(callSuper = false)

public class User extends Person {
    private String name;

    public User() {
    }

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

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

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

    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 {
                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;
            }
        }
    }

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

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

可以看到这里和不加@EqualsAndHashCode是一样的，但是为了有些场景我们又需要不加上，所以需要根据自己的场景来进行判断

2.3、@Accessors

@Accessors(chain=true)

链式访问，该注解设置chain=true，生成setter方法返回this，代替了默认的返回void。

@Data
@Accessors(chain=true)
public class User {
    private Integer id;
    private String name;
    private Integer age;

    public static void main(String[] args) {
        User user=new User().setAge(31).setName("pollyduan");
        System.out.println(user);
    }
}

@Accessors(fluent = true)

与chain=true类似，区别在于getter和setter不带set和get前缀。但是这个尽量不要使用，因为很多框架都是通过get/set方法来进行赋值的

@Data
@Accessors(fluent=true)
public class User {
    private Integer id;
    private String name;
    private Integer age;

    public static void main(String[] args) {
        User user=new User().age(31).name("pollyduan");
        System.out.println(user);
    }
}

@Accessors(prefix = “f”)

去除掉属性的前缀之后生成的set方法：

@Data
@Accessors(prefix = "f")
public class User {
    private String fName = "Hello, World!";
    public static void main(String[] args) {
        User user=new User();
        user.setName("pollyduan");//注意方法名
        System.out.println(user);
    }
}

2.4、@NoArgsConstructor

无参构造

    public User() {
    }

JAVA 复制 全屏

2.5、@AllArgsConstructor

当前类中的属性的有参构造：

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

JAVA 复制 全屏

2.6、@Builder

这个方法可以用也可以不用，我这里不用，做个记录。

从理论中来，到实践中去，最终回归理论

hunter403
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
Java效率工具之Lombok的具体使用
08-25
主要介绍了Java效率工具之Lombok的具体使用，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
Java编码辅助工具Lombok用法详解
08-25
主要介绍了Java编码辅助工具Lombok用法详解,可以使用Lombok来避免这种重复的操作，减少非核心代码的臃肿，提高编码效率,需要的朋友可以参考下
Java开发工具之Lombok
summer_huan的博客
10-23 195
转自：http://blog.csdn.net/ghsau/article/details/52334762 背景   我们在开发过程中，通常都会定义大量的JavaBean，然后通过IDE去生成其属性的构造器、getter、setter、equals、hashcode、toString方法，当要对某个属性进行改变时，比如命名、类型等，都需要重新去生成上面提到的这些方法，
Java效率工具之Lombok
weixin_30924239的博客
05-06 37
转载：juejin.im/post/5b00517cf265da0ba0636d4b 还在编写无聊枯燥又难以维护的POJO吗？洁癖者的春天在哪里？请看Lombok！ 在过往的Java项目中，充斥着太多不友好的代码：POJO的getter/setter/toString；异常处理；I/O流的关闭操作等等，这些样板代码既没有技术含量，又影响着代码的美观，Lombok应运而生。...
Java奇淫巧技之Lombok
无知人生，记录点滴
01-15 1063
背景   我们在开发过程中，通常都会定义大量的JavaBean，然后通过IDE去生成其属性的构造器、getter、setter、equals、hashcode、toString方法，当要对某个属性进行改变时，比如命名、类型等，都需要重新去生成上面提到的这些方法，那Java中有没有一种方式能够避免这种重复...
Java之——lombok注解
冰河的专栏
07-08 1627
lombok注解介绍lombok注解文档 lombok官网下载lombok是一个可以帮助我们简化java代码编写的工具类，尤其是简化javabean的编写，即通过采用注解的方式，消除代码中的构造方法，getter/setter等代码，使我们写的类更加简洁，先看一下lombok支持的一些常见的注解。@NonNull@Cleanup@Getter/@Setter@ToString@EqualsAndH...
java工具jar包—Lombok
weixin_30508241的博客
12-19 290
如何引入 maven工程，直接引入lombok的jar依赖即可： <dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> <version>1.16.18</version&g...
Java巧技之Lombok
woshishani的博客
03-20 158
背景  我们在开发过程中，通常都会定义大量的JavaBean，然后通过IDE去生成其属性的构造器、getter、setter、equals、hashcode、toString方法，当要对某个属性进行改变时，比如命名、类型等，都需要重新去生成上面提到的这些方法，那Java中有没有一种方式能够避免这种重复的劳动呢？答案是有，我们来看一下下面这张图，右面是一个简单的JavaBean，只定义了两个属性，在...
java之Lombok
dianlin1577的博客
07-31 53
Lombok是一个可以通过简单的注解形式来帮助我们简化消除一些必须有但显得很臃肿的Java代码的工具，通过使用对应的注解，可以在编译源码的时候生成对应的方法 pom依赖： <dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok&lt...
Java效率工具Lombok使用及原理
weixin_33896726的博客
05-13 60
还在编写无聊枯燥又难以维护的POJO吗？洁癖者的春天在哪里？请看Lombok！ 在过往的Java项目中，充斥着太多不友好的代码：POJO的getter/setter/toString；异常处理；I/O流的关闭操作等等，这些样板代码既没有技术含量，又影响着代码的美观，Lombok应运而生。 首先说明一下：任何技术的出现都是为了解决某一类问题的，如果在此基础上再建立奇技淫巧，不如回归Java本身。应该...
优雅的Java工具库Lombok
awei564335的博客
08-19 195
优雅的Java工具库Lombok 最近在公司的项目中看到了对于Lombok的应用，通过@Data注解标注POJO，省略了大量的getter/setter代码，原先冗长的POJO在瘦身之后直接变得干净、清爽，程序员再也不需要去关注那些长长的方法，只需要集中注意力于字段field之中 Lombok简介 Lombok是一个非常实用的Java工具库，有效地简化Java代码的冗长。它通过注解如@D...
Java开发之Lombok指南
08-25
Lombok是一款Java开发插件，使得Java开发者可以通过其定义的一些注解来消除业务工程中冗长和繁琐的代码，它能够在编译源代码期间自动帮我们生成这些方法，并没有如反射那样降低程序的性能。下面我们来详细了解一下吧
Lombok 是一种 Java™ 实用工具
09-20
Lombok 是一种 Java™ 实用工具，可用来帮助开发人员消除 Java 的冗长，尤其是对于简单的 Java 对象（POJO）。它通过注解实现这一目的
java lombok.rar
09-29
java lombok jar包下载
进阶2 探索图形化编程：扩展图形组件与切片开发的魅力
最新发布
优树搭的博客
05-30 864
当这些切片成功地通过图形程序串联起来后，在后续进行程序升级或维护时，大家会惊喜地发现，图形程序就如同清晰的路标一般，可以非常便捷地通过图形程序准确地定位到相关切片，并对这些切片进行在线查看、编辑和执行等操作。而且，这些切片的代码长度通常不会太长，相比传统开发的代码，阅读起来要容易得多，这无疑会给系统后续的工作带来极大的便利。
JAVAEE之多线程进阶（2）_ CAS概念、实现原理、ABA问题及解决方案
2301_80653026的博客
05-29 1226
CAS全称Compare and swap，字面意思:”比较并交换“，它是一条 CPU 并发原语，用于判断内存中某个值是否为预期值，如果是则更改为新的值，这个过程是原子的。全称 Compare and swap, 即 “比较并交换”. 相当于通过一个原子的操作, 同时完成 “读取内存, 比较是否相等, 修改内存” 这三个步骤. 本质上需要 CPU 指令的支撑。
【STM32学习】HAL库点灯学习
2301_78895982的博客
05-26 797
STM32基于HAL库流水灯实验_hel库安装教程中文版-CSDN博客t=N7T8。
数据访问与Spring Data JPA
无远弗届
05-25 633
假设我们要处理一个用户表（users），可以创建一个User@Entity // 标识这是一个实体类 public class User {@Id // 标识这是主键字段 @GeneratedValue(strategy = GenerationType . AUTO) // 主键生成策略 private Long id;// Getter 和 Setter ... }@Entity // 标识这是一个实体类 public class User {
java: 程序包lombok不存在
03-28
如果在使用Java程序中出现“程序包lombok不存在”的错误消息，则可能是因为缺少Lombok依赖项。Lombok是一个Java库，可用于自动化生成Java代码。 要解决此问题，请按照以下步骤操作： 1. 在您的项目中添加Lombok...

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

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

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值