基于Lombok集成springboot遇到的坑

目录

• Lombok集成springboot遇到的坑
• 问题
• 原因
• springboot引入Lombok

Lombok集成springboot遇到的坑

最近有同事在spring boot中用Lombok @Data注解时遇到了一个奇怪的问题，然后有幸一起研究了一下，把研究成果记录下来。

问题

先上代码：

@Data
public abstract class TestAbstract {
    private RedisTemplate redisTemplate;
    public TestAbstract(RedisTemplate redisTemplate) {
        this.redisTemplate = redisTemplate;
    }
}

@Data
public class TestChild extends TestAbstract {
    @Autowired
    public TestChild(RedisTemplate redisTemplate) {
        super(redisTemplate);
    }
}

上面的代码在spring boot 2.0.2版本可以正常运行，但在2.0.3版本却编译错误。

Error:(13, 1) java: TestAbstract() 在 com.brotherj.learn.TestAbstract 中是private 访问控制

查看了pom.xml文件后发现lombok的版本号是从spring boot继承而来：

<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <optional>true</optional>
</dependency>

然后又查看了spring boot pom.xml中的lombok版本号，发现从spring boot 2.0.3版本开始使用了lombok 1.16.22，而2.0.2版本使用的是1.16.20版本。

#2.0.2
<lombok.version>1.16.20</lombok.version>

#2.0.3
<lombok.version>1.16.22</lombok.version>

于是修改pom.xml版本号之后，问题解决。

 <dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <optional>true</optional>
    <version>1.16.20</version>
</dependency>

原因

问题解决后，决定研究一下具体的原因，由于Lombok只是依靠可插件化的Java自定义注解处理API（JSR 269: Pluggable Annotation Processing API）来实现在Javac编译阶段利用“Annotation Processor”对自定义的注解进行预处理后生成真正在JVM上面执行的“Class文件”。

所以应该时两个版本下编译生成的class文件不同，于是比较了一下两个版本下编译后的class文件。

    public TestAbstract(RedisTemplate redisTemplate) {
        this.redisTemplate = redisTemplate;
    }
    //1.16.22会生成一个private的构造方法，而1.16.20不会生成
    private TestAbstract() {
    }

     @Autowired
    public TestChild(RedisTemplate redisTemplate) {
        super(redisTemplate);
    }
    private TestChild() {
    }

看到这里一切就都清楚了，是类加载顺序导致的问题。

先复习一下类加载顺序：（静态变量、静态初始化块）–>（变量、初始化块）–> 构造器。如果有父类，加载顺序是：父类static方法 –> 子类static方法 –> 父类构造方法- -> 子类构造方法 。

也就是说，当加载TestChild类时先加载类TestAbstract的构造方法，而类TestAbstract的空参构造为private，于是报了访问控制的错误。

springboot引入Lombok

传统的写法，要写一串串的get()、set()方法等等

现引入Lombok

pom.xml引入

<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
</dependency>

引入后发现，在实体类上面使用@Data找不到import的包

网上巴拉巴拉，发现是springBoot的版本和import的版本不统一，加上

<optional>true</optional>

提示版本信息，改为可用的版本即可。修正后如下：

<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <optional>true</optional>
    <version>1.18.2</version>
</dependency>

终于可以正常导入^_^

延伸阅读（1）：

idea安装Lombok插件

File——Settings——Plugins——Marketplact

延伸阅读（2）：

常见参数

• @Setter 注解在类或字段，注解在类时为所有字段生成setter方法，注解在字段上时只为该字段生成setter方法。
• @Getter 使用方法同上，区别在于生成的是getter方法。
• @ToString 注解在类，添加toString方法。
• @EqualsAndHashCode 注解在类，生成hashCode和equals方法。
• @NoArgsConstructor 注解在类，生成无参的构造方法。
• @RequiredArgsConstructor 注解在类，为类中需要特殊处理的字段生成构造方法，比如final和被@NonNull注解的字段。
• @AllArgsConstructor 注解在类，生成包含类中所有字段的构造方法。
• @Data 注解在类，为类的所有字段注解@ToString、@EqualsAndHashCode、@Getter的便捷方法，同时为所有非final字段注解@Setter。

以上为个人经验，希望能给大家一个参考，也希望大家多多支持我们。