LomBok使用讲解

致微

已于 2023-06-13 12:06:45 修改

阅读量3.1k

点赞数 10

分类专栏： Lombok 文章标签： java 开发语言

于 2023-06-13 12:03:31 首次发布

本文链接：https://blog.csdn.net/happy_lifer/article/details/131185280

版权

Lombok 专栏收录该内容

1 篇文章 0 订阅

订阅专栏

一、Lombok注解

1.1 @Getter、@Setter

作⽤类上，⽣成所有成员变量的getter/setter⽅法
作⽤于成员变量上，⽣成该成员变量的getter/setter⽅法

被final修饰的变量，只能生成getter方法
被static修饰的变量，无法生成getter/setter方法

默认情况下，生成的getter、setter方法都是public，如果想让方法的修饰符为其他的，那么可以这样设置

@Setter
@Getter
public class UserDO {
     /**
     * 不想⽣成 get⽅法
     */
     @Getter(AccessLevel.NONE)
     private int age;

     // 让 getSalary 方法的访问权限为 protected
     @Getter(AccessLevel.PROTECTED)
     private int salary;

     /**
     * final 只会⽣成get
     */
     private final String name="⼆当家⼩D";

     /**
     * 下⾯两个静态成员变量不会⽣成set/get⽅法
     */
     static Date createTime = new Date();
     private static final String address = "⼴东
    省⼴州市";
}

AccessLevel枚举类中的枚举字段有：、
- PUBLIC：public
- MODULE：default
- PROTECTED：protected
- PACKAGE：package
- PRIVATE：private
- NONE：不生成getter/setter方法

1.2 @NonNull

作用于方法或者属性，用于非空判断，如果未空则抛出异常

1.3 @XXXConstructor

@AllArgsConstructor：生成全参构造函数。
@NoArgsConstructor：生成无参构造函数。
@RequiredArgsConstructor：生成指定参数的构造函数，其中的指定参数是：final类型未被初始化的属性或者标记了@NonNull的属性。

1.4 @ToString

作⽤于类，覆盖默认的toString()⽅法，用于打印对象的属性

不包括某个字段 @ToString(exclude = {"age"})
只输出某个字段 @ToString(of = {"name"})

1.5 @EqualsAndHashCode

作⽤于类，覆盖默认的equals和hashCode, 作⽤于全部属性

不包括某个属性：@EqualsAndHashCode(exclude = {"age"})
只输出某个属性：@EqualsAndHashCode(of = {"name"})
在讲解这个注解之后，我们来讲解下java对象中默认的hashcode、equal方法。

为什么对象要重写hashcode和equal⽅法？

HashCode⽅法
顶级类Object⾥⾯的⽅法，所有类都是继承Object的，返回值int类型根据⼀定的hash规则(存储地址，字段，或者⻓度等)，映射成⼀个数值，即散列值
Equals⽅法
顶级类Object⾥⾯的⽅法，所有类都是继承Object的，返回值boolean类型根据⾃定义的匹配规则，⽤于匹配两个对象是否⼀样, ⼀般逻辑是如下：

 //判断地址是否⼀样

 //⾮空判断和class类型判断

 //强转

 //对象⾥⾯的字段⼀⼀匹配

解析如果两个对象相等，那么它们的hashCode()值⼀定相同（这⾥的相等是指，通过equals()⽐较两个对象时返回true）如果两个对象hashCode()相等，它们并不⼀定相等。在散列表中hashCode()相等，即两个键值对的哈希值相等。然⽽哈希值相等，并不⼀定能得出键值对相等，就出现所谓的哈希冲突场景，还需判断equals⽅法判断对象是否相等

应⽤场景：
当向集合中插⼊对象时，如何判别在集合中是否已经存在该对象，⽐如Set确保存储对象的唯⼀，并判断是不是同个对象呢？

依据hashCode和equals进⾏判断；所以Set存储的对象必须重写这两个⽅法判断两个对象是否⼀样，⾸先判断插⼊obj的hashcode值是否存在，hashcode值不存在则直接插⼊集合，值存在则还需判断equals⽅法判断对象是否相等。

class User {

   private int age;

   private String name;

   private Date time;

   //省略setter和getter⽅法 @Override

   public boolean equals(Object o) {
 			if (this == o) return true;
 			if (o == null || getClass() != o.getClass()) return false;
 			Student student = (Student) o;
 			return age == student.age && Objects.equals(name, student.name) &&Objects.equals(time, student.time);
 }

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

1.6 @Data

作⽤于类上，是以下注解的集合
@ToString
@EqualsAndHashCode
@Getter
@Setter
@RequiredArgsConstructor

1.7 @Builder

作用于类，将其变成建造者模式；可以以链的形式调用；初始化实例对象生成的对象是不可以变的，可以在创建对象的时候进行赋值，如果需要在原来的基础上修改可以加 set 方法，final 字段可以不需要初始化。它会生成一个全参的构造函数。

属性

@Builder.Default：非 final 的字段可以有默认值
builderMethodName：指定创建内部静态类的方法名，默认值为 builder
buildMethodName：指定创建实体类的方法名，默认值为 build
builderClassName：指定内部静态的类名，默认值为 “”，默认创建的类名为 thisclassBuilder
toBuilder：设置为 true 可以对这个对象进行拷贝生成新的对象，可以再修改，默认为 false
access：设置 builderMethodName 的访问权限修饰符，默认为 public
共有 PUBLIC、MODULE、PROTECTED、PACKAGE、PRIVATE，其中 MODULE 是 Java 9 的新特性
setterPrefix：设置 setter 方法的前缀，默认为 “”

@Builder.ObtainVia：表示变量从什么地方获取值，只有当 toBuilder = true 时才生效

field：表示字段赋值时从某个字段上取值，对应的字段必须存在
method：表示字段赋值时从某个方法上取值，对应的方法必须存在
isStatic：表示 method 是否静态

@Builder(toBuilder = true)
public class Rita {
	private String name;
  
	// 对应方法 init，方法返回类型和字段类型必须统一
	@Builder.ObtainVia(method = "init")	
	private String identity;
	
	private String init() {
		return "Rita";
	}
	
	public static void main(String[] args) {
		Rita rita = Rita.builder().name("Rita").build();
		rita = rita.toBuilder().build();	// 此时变量 identity 从 init 方法中取值
		System.out.println(rita);
	}
}

@Builder 会生成一个全参构造方法，因此就没有了无参构造方法，但当我们遇到需要无参构造方法时就会发生问题，这个时候手写或者加上 @NoArgsConstructor都会报错，两种解决方案

加上 @AllArgsConstructor
使用@Tolerate注解

@Builder 内部做了什么

创建一个名为 ThisClassBuilder 的内部静态类，并具有和实体类相同的属性（称为构建器）
在构建器中：对于目标类中的所有的属性和未初始化的 final 字段，都会在构建器中创建对应属性
在构建器中：创建一个无参的默认构造函数
在构建器中：实体类中的每个参数，都会对应创建类似于 setter 的方法，方法名与该参数名相同。并且返回值是构建器本身（便于链式调用）
在构建器中：会创建一个 build 方法，调用 build 方法，就会根据设置的值进行创建实体对象
在构建器中：会生成一个 toString 方法
在实体类中：会创建一个 builder 方法，它的目的是用来创建构建器

1.8 @Log / @Slf4j

作用在类上，生成日志变量，用于记录日志

1.9 @Accessors

实现链式编程，当它可作用于类上时，修饰类中所有字段，当作用于具体字段时，只对该字段有效。
该注解共有三个属性，分别是 fluent，chain，prefix。

fluent 属性：不写默认为false，当该值为 true 时，对应字段的 getter 方法前面就没有 get，setter 方法就不会有 set。
chain 属性：不写默认为false，当该值为 true 时，对应字段的 setter 方法调用后，会返回当前对象。
prefix 属性：该属性是一个字符串数组，当该数组有值时，表示忽略字段中对应的前缀，生成对应的 getter 和 setter 方法。

二、使用Lombok注解遇到的bug

2.1 Setter-Getter方法的坑

问题发现

我们在项目当中主要使用Lombok的Setter-Getter方法的注解，也就是组合注解@Data，但是在一次使用Mybatis插入数据的过程当中，出现了一个问题，问题描述如下：

我们有个实体类：
@Data
public class NMetaVerify{
    private NMetaType nMetaType;
    private Long id;
    ....其他属性
}

当我们使用Mybatis插入数据的时候，发现，其他属性完全正常的插入，但是就是nMetaType属性在数据库一直是null。

解决

当我调试程序项目代码到调用Mybatis的插入SQL对应的方法的时候时，我看到NMetaVerify对象的nMetaType属性还是有数据的，但是执行插入之后，数据库的nMetaType就是一直是null，原先我以为是我的枚举类型写法不正确，看了下别的同样具有枚举类型的细分，也是正常能插入到数据库当中的，这更让我感觉到疑惑了。于是，我就跟踪Mybatis的源码，发现Mybatis在获取这个nMetaType属性的时候使用了反射，使用的是getxxxx方法来获取的，但是我发现nMetaType的get方法好像有点和Mybatis需要的getxxxx方法长的好像不一样。问题找到了！

原因

Lombok对于第一个字母小写，第二个字母大写的属性生成的get-set方法和Mybatis以及想法还是说是Java官方认可的get-set方法生成的不一样：

#Lombok生成的Get-Set方法
@Data
public class NMetaVerify {
    private Long id;
    private NMetaType nMetaType;
    private Date createTime;

    public void lombokFound(){
        NMetaVerify nMetaVerify = new NMetaVerify();
        nMetaVerify.setNMetaType(NMetaType.TWO); //注意：nMetaType的set方法为setNMetaType，第一个n字母大写了，
        nMetaVerify.getNMetaType();                                  //getxxxx方法也是大写
    }
}

#idea，Mybatis，Java官方默认的行为为：
public class NMetaVerify {
    private Long id;
    private NMetaType nMetaType;
    private Date createTime;

    public Long getId() {
        return id;
    }

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

    public NMetaType getnMetaType() {//注意：nMetaType属性的第一个字母小写
        return nMetaType;
    }

    public void setnMetaType(NMetaType nMetaType) {//注意：nMetaType属性的第一个字母小写
        this.nMetaType = nMetaType;
    }

    public Date getCreateTime() {
        return createTime;
    }

    public void setCreateTime(Date createTime) {
        this.createTime = createTime;
    }
}

Mybatis（3.4.6版本）解析get-set方法获取属性名字的源码：

package org.apache.ibatis.reflection.property;

import java.util.Locale;

import org.apache.ibatis.reflection.ReflectionException;

/**
 * @author Clinton Begin
 */
public final class PropertyNamer {

     private PropertyNamer() {
         // Prevent Instantiation of Static Class
       }

    public static String methodToProperty(String name) {
      if (name.startsWith("is")) {//is开头的一般是bool类型，直接从第二个(索引)开始截取(简单粗暴)
          name = name.substring(2);
      } else if (name.startsWith("get") || name.startsWith("set")) {//set-get的就从第三个(索引)开始截取
          name = name.substring(3);
      } else {
          throw new ReflectionException("Error parsing property name '" + name + "'.  Didn't start with 'is', 'get' or 'set'.");
      }
           //下面这个判断很重要，可以分成两句话开始解释，解释如下
            //第一句话：name.length()==1
            //       对于属性只有一个字母的，例如private int x;
            //          对应的get-set方法是getX();setX(int x);
            //第二句话：name.length() > 1 && !Character.isUpperCase(name.charAt(1)))
            //      属性名字长度大于1，并且第二个(代码中的charAt(1)，这个1是数组下标)字母是小写的
            //      如果第二个char是大写的，那就直接返回name
      if (name.length() == 1 || (name.length() > 1 && !Character.isUpperCase(name.charAt(1)))) {
          name = name.substring(0, 1).toLowerCase(Locale.ENGLISH) + name.substring(1);//让属性名第一个字母小写，然后加上后面的内容
      }

      return name;
    }

    public static boolean isProperty(String name) {
       return name.startsWith("get") || name.startsWith("set") || name.startsWith("is");
    }

    public static boolean isGetter(String name) {
       return name.startsWith("get") || name.startsWith("is");
    }

    public static boolean isSetter(String name) {
       return name.startsWith("set");
    }
}

Mybatis解析get-set方法为属性名字测试

    @Test
    public void foundPropertyNamer() {
        String isName = "isName";
        String getName = "getName";
        String getnMetaType = "getnMetaType";
        String getNMetaType = "getNMetaType";

        Stream.of(isName,getName,getnMetaType,getNMetaType)
                .forEach(methodName->System.out.println("方法名字是:"+methodName+" 属性名字:"+ PropertyNamer.methodToProperty(methodName)));
    }

    #输出结果如下:
    方法名字是:isName 属性名字:name
    方法名字是:getName 属性名字:name
    方法名字是:getnMetaType 属性名字:nMetaType //这个以及下面的属性第二个字母都是大写，所以直接返回name
    方法名字是:getNMetaType 属性名字:NMetaType

解决方案

1.修改属性名字，让第二个字母小写，或者说是规定所有的属性的前两个字母必须小写
2.如果数据库已经设计好，并且前后端接口对接好了，不想修改，那就专门为这种特殊的属性使用idea生成get-set方法

2.2 @Accessor（chain = true）注解的问题

问题发现

在使用easyexcel（github.com/alibaba/eas…）转换的时候，发现以前的实体类转换都很正常，但是现在新加的实体类不正常了，比对了发现，新加的实体类增加了@Accessor（chain = true）注解，我们的目的主要是方便我们链式调用set方法：

new UserDto()
.setUserName("")
.setAge(10)
........
.setBirthday(new Date());

原因

easyexcel短期使用的是cglib来做反射工具包的：

com.alibaba.excel.read.listener.ModelBuildEventListener 类的第130行
BeanMap.create(resultModel).putAll(map);

最底层的是cglib的BeanMap的这个方法调用

abstract public Object put(Object bean, Object key, Object value);

但是cglib使用的是Java的rt.jar里面的一个Introspector这个类的方法：

# Introspector.java 第520行
if (int.class.equals(argTypes[0]) && name.startsWith(GET_PREFIX)) {
   pd = new IndexedPropertyDescriptor(this.beanClass, name.substring(3), null, null, method, null);
   //下面这行判断，只获取返回值是void类型的setxxxx方法
 } else if (void.class.equals(resultType) && name.startsWith(SET_PREFIX)) {
    // Simple setter
    pd = new PropertyDescriptor(this.beanClass, name.substring(3), null, method);
    if (throwsException(method, PropertyVetoException.class)) {
       pd.setConstrained(true);
    }
}

解决方案

1.去掉Accessor注解
2.要么就等待easyexcel的作者替换掉底层的cglib或者是其他，反正是支持获取返回值不是void的setxxx方法就行

三、Lombok优缺点

缺点：

Lombok的使⽤要求⼀定要在IDE中安装对应的插件，如果项⽬组中有⼀个⼈使⽤了Lombok则都要⽤
代码可读性，可调试性低，⽐如想知道某个类中的某个属性的getter⽅法都被哪些类引⽤
影响升级，如果升级到某个新版本的JDK的时候，如果其中的特性在Lombok中不⽀持的话就会受到影响
注意常⻅的细节点：⽐如只使⽤了@Data，⽽不使⽤@EqualsAndHashCode(callSuper=true)的话，会默认是@EqualsAndHashCode(callSuper=false),这时候⽣成的equals()⽅法只会⽐较⼦类的属性，不会考虑从⽗类继承的属性，⽆论⽗类属性访问权限是否开放,只要知道是否需要使⽤⽗类的属性即可，也提供定制化配置，所以不⽤过多担⼼

优点：

使⽤注解即可帮忙⾃动⽣成代码
⼤⼤减少了代码量，使代码⾮常简洁
部分注解在业务项⽬中开发能⼤⼤提⾼效率

项⽬中应该⽤还是不⽤呢

不建议开发中间件的项⽬使⽤，中间件设计的要求是解耦少依赖
业务项⽬实体类可以⽤，且⽤的时候知道对应的常⻅的注解原理

致微

关注

10
点赞
踩
35

收藏

觉得还不错? 一键收藏
0
评论
LomBok使用讲解

当我调试程序项目代码到调用Mybatis的插入SQL对应的方法的时候时，我看到NMetaVerify对象的nMetaType属性还是有数据的，但是执行插入之后，数据库的nMetaType就是一直是null，原先我以为是我的枚举类型写法不正确，看了下别的同样具有枚举类型的细分，也是正常能插入到数据库当中的，这更让我感觉到疑惑了。可以以链的形式调用；顶级类Object⾥⾯的⽅法，所有类都是继承Object的，返回值int类型根据⼀定的hash规则(存储地址，字段，或者⻓度等)，映射成⼀个数值，即散列值。
复制链接

扫一扫