Lombok从入门到精通

·  阅读 37
Lombok从入门到精通

一、序言

对于 Lombok 的使用是有争议的,作者对 Lombok 的态度是强烈推荐,甚至认为应当将部分常用功能直接以 JDK 的形式集成。

在构建实体类过程中写一堆Set/Get方法毫无意义;默认继承Object类的toString方法官方建议重写,每个实体类为了表达具象的实体信息而重写toString方法,操作繁琐。

二、常用注解解析

(一)实体类注解

下面讨论的注解是添加到实体类上面的。

public class XUser {
    private Integer userId;
    private String userName;
}
复制代码
1、@Data

添加@Data注解后,编译后的实体类自动增加如下信息:属性的Set/Get方法,变化后自动增减;默认构造器,其中equals方法、hashCode方法、toString方法由 Lombok 重写。后面会详细讨论其重写逻辑。

image-20210518155643615
2、@AllArgsConstructor

添加@AllArgsConstructor注解后,编译后的实体自动增加如下信息:全参构造器。添加完@AllArgsConstructor注解后,一般都需要无参构造器的注解@NoArgsConstructor

image-20210518160238223

在添加完@AllArgsConstructor注解后,增加@NoArgsConstructor后实体类变化如下:

image-20210518160952291
3、@ToString

添加@ToString注解后,编译后的实体自动增加如下信息:重写的toString方法。

image-20210518163835896

@ToString注解在@Data注解存在的情况下是不需要额外添加的,除非是需要用到其属性配置。常用的属性配置为callSuper = true表示将父类的属性值一起添加至重写的toString方法中。

4、@Builder

添加@Builder注解后,编译后的实体自动增加如下信息:链式Set方法。

image-20210518164257001

链式 Set 方法的优点如下:

// 用简洁的方式实例化实体类并完成赋值操作
XUser xUser = XUser.builder().userId(1).userName("AAAAA").build();
复制代码
5、@Accessors

添加@Accessors(chain = true)注解后,编译后的实体类变化如下:setXxx方法是有返回值的,并且是当前对象的示例。使用此注解需要注意三点:

  • 此注解属于试验型的,可能后期会删除;
  • 此注解将属性chain设置为true是效果生效的必要条件之一;
  • 配合@Data注解或者@Setter注解使用是效果生效的必要条件。
@Setter
@Accessors(chain = true)
public class XUser {
    private Integer userId;
    private String userName;
}
复制代码
image-20210518165611383

主要参数介绍

参数默认值注释
fluentfalse控制生成的 getter 和 setter 方法前面是否带 get/set。如果为true,则chain自动开启,无需再次设置
chainchain如果设置为true,setter 返回的是此对象,方便链式调用方法

参数fluent应谨慎使用,对于 Jackson 序列化框架,不带 get/set 前缀的方法有不识别的概率。

(二)服务类注解

上面提到的是针对实体类常用的注解,此处主要讲服务类注解。两者并没有明显的界限区分,理论上都能使用,本处仅仅是根据使用场合进行区分。

1、@Log4j2

类添加完@Log4j2注解后,当前类实例自动持有log成员变量,可以通过此变量增加日志信息。

@Log4j2
public class XUserServiceImpl {
    public void saveUser(XUser user) {
        log.info("此方法保存用户信息");
    }
}
复制代码

类信息变化如下:

image-20210518171104643

三、过程探究

(一)重写

Lombok 中的部分注解会重写下列方法:equals方法、hashCode方法、toString

1、toString 方法

(1)默认实现

默认继承超类Object的实现

public String toString() {
    return getClass().getName() + "@" + Integer.toHexString(hashCode());
}
复制代码

示例

XUser xUser = new XUser();
System.out.println(xUser.toString());
System.out.println(xUser.toString());
复制代码

同一个实例的输出结果一致

xin.altitude.lombok.domain.XUser@43d7741f
xin.altitude.lombok.domain.XUser@43d7741f
复制代码

(2)重写实现

示例

System.out.println(new XUser(1,"AAAAA").toString());
System.out.println(new XUser(1,"AAAAA").toString());~
复制代码

相同的成员变量输出值一致,只有当成员变量不同时,输出结果才有差异,与执行次数无关,与实例对象引用无关。

XUser(userId=1, userName=AAAAA)
XUser(userId=1, userName=AAAAA)
复制代码
2、equals 方法

(1)默认实现

默认继承超类Object的实现

public boolean equals(Object obj) {
    return (this == obj);
}
复制代码

示例

XUser xUser1 = new XUser(1, "AAAAA");
XUser xUser2 = xUser1;
// 在同一个JVM中,相同的引用对象实例相同(输出为true)
boolean bl = xUser1.equals(xUser2);
复制代码

(2)重写实现

示例

// 对象的属性值是否相等(输出是true)
boolean bl = new XUser(1, "AAAAA").equals(new XUser(1, "AAAAA"));
复制代码

相同的成员变量构造出对象使用重写后的equals方法,无论执行多少次,结果都为true


喜欢本文点个♥️赞♥️支持一下,关注我下期再见。相关源码在GitHub,视频讲解在B站,本文收藏在专题博客


分类:
后端
标签:
收藏成功!
已添加到「」, 点击更改