lombok学习笔记

lombok是通过简单的注解的形式来简化消除一些必要的Java 代码的工具，例如:一个标准实体类，通常需要getter, setter, toString, equals, hashCode, 无参构造器等方法，lombok的作用就是自动生成这些代码，使代码看起来更简洁.

lombok开发环境

1. 在idea插件库安装lombok插件
2. maven项目增加依赖

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

lombok使用方法

常用注解

@Getter
@Setter
@ToString
@EqualsAndHashCode
@NoArgsConstructor
@AllArgsConstructor
@RequiredArgsConstructor
   生成包含final属性和 @NonNull属性的构造器
   没有这样的属性会和 @NoArgsConstructor冲突
@Slf4j
   使用需要slf4j依赖

@XxxArgsConstructor(access = AccessLevel.PACKAGE)
   使用参数 access = AccessLevel.PACKAGE 控制访问权限
@Data
   相当于 @Getter @Setter @ToString @EqualsAndHashCode @RequiredArgsConstructor
@Builder
   builder模式, 链式编程, new Xxx.XxxBuilder().a("").build();
   注意:

1. @Builder 会生成包权限的全参构造器 @AllArgsConstructor(access = AccessLevel.PACKAGE)
2. 没有无参构造器, 会导致很多框架无法使用
3. 全参构造器权限导致JMH无法使用
4. 生成的XxxBuilder访问权限是package-private, 因此不要在提供给外部的接口中使用@Builder

配置文件

在src/main/java 目录下新建lombok.config文件

#lombok 默认对 boolean 类型字段生成的 get 方法使用 is 前缀, 通过此配置则使用 get 前缀
#lombok.getter.noIsPrefix=true

#默认的 set方法返回 void 设置为 true 返回调用对象本身
lombok.accessors.chain=true

#如果设置为true. get,set 方法将不带 get,set 前缀, 直接以字段名为方法名
#lombok.accessors.fluent=true

#设置 log 类注解返回的字段名称
clear lombok.log.fieldName
lombok.log.fieldName=LOGGER

常见问题

1. @Builder + @XxxArgsConstructor 编译失败:找不到对应参数列表的构造器
2. 使用链式编程并且解决没有无参构造器, 会导致很多框架无法使用问题

@Getter
@Setter
@ToString
@NoArgsConstructor
@AllArgsConstructor(access = AccessLevel.PACKAGE)

使用上面注解并且在配置文件中配置 lombok.accessors.chain=true
使用方式: new Xxx().setAaa("").setBbb("");
基于兼容性考虑, 不要提供开放的全参构造器(增加属性不要导致调用方报错)
注意: 配置 lombok.accessors.chain=true后, 引发的风险

//获取属性的getter, setter方法,  
// new PropertyDescriptor("aaa", A.class) 报错 找不到setAaa方法
PropertyDescriptor aaa = null;
        try {
            aaa = new PropertyDescriptor("aaa", A.class);
            Object invoke = aaa.getReadMethod().invoke(a, null);
            System.out.println(aaa.getReadMethod().getName() + ":" + invoke);
        } catch (IntrospectionException e) {
            e.printStackTrace();
        } catch (IllegalAccessException e) {
            e.printStackTrace();
        } catch (InvocationTargetException e) {
            e.printStackTrace();
        }

查看PropertyDescriptor源码发现 getWriteMethod中返回类型必须为void

经测试发现Spring的BeanUtils.getPropertyDescriptor 方法能正确返回, 查看BeanUtils源码发现, Spring封装了PropertyDescriptor类

Spring存储PropertyDescriptor逻辑原理
try {
    BeanInfo beanInfo = Introspector.getBeanInfo(beanClass, 3);
    PropertyDescriptor[] propertyDescriptors = beanInfo.getPropertyDescriptors();
    for(PropertyDescriptor pd : propertyDescriptors){
        propertyDescriptorCache.put(pd.getName(), 
        	new GenericTypeAwarePropertyDescriptor(beanClass, pd.getName(), pd.getReadMethod(),
					pd.getWriteMethod(), pd.getPropertyEditorClass()))
    }
} catch (IntrospectionException e) {
    e.printStackTrace();
}