学而实习之 不亦乐乎

Java 中 Lombok 的用法及工作原理

2024-02-17 19:11:57

一、Lombok 简介

大概的意思：Lombok是一个Java库，能自动插入编辑器并构建工具，简化Java开发。通过添加注解的方式，不需要为类编写getter或eques方法，同时可以自动化日志变量。简而言之：Lombok能以简单的注解形式来简化java代码，提高开发人员的开发效率。

二、Lombok 用法

1、添加依赖

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

2、安装插件

使用Lombok还需要插件的配合，IDEA中打开设置，点击 Plugins，点击 Browse repositories，在弹出的窗口中搜索 lombok，然后安装即可

3、使用

实例一

不用 Lombok 时代码如下：

public class User implements Serializable {

    private static final long serialVersionUID = -8054600833969507380L;

    private Integer id;
    private String username;
    private Integer age;

    public User() {
    }

    public Integer getId() {
        return id;
    }

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

    public String getUsername() {
        return username;
    }

    public void setUsername(String username) {
        this.username = username;
    }

    public Integer getAge() {
        return age;
    }

    public void setAge(Integer age) {
        this.age = age;
    }

    @Override
    public String toString() {
        return "User{" +
                "id=" + id +
                ", username='" + username + '\'' +
                ", age=" + age +
                '}';
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) {
            return true;
        }

        if (o == null || getClass() != o.getClass()) {
            return false;
        }

        User user = (User) o;
        return Objects.equals(id, user.id) &&
                Objects.equals(username, user.username) &&
                Objects.equals(age, user.age);
    }

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

使用 Lombok 后

@Data
public class User implements Serializable {

    private static final long serialVersionUID = -8054600833969507380L;
    private Integer id;
    private String username;
    private Integer age;
}

编译后，反编译生成的 class 文件，可以看到自动生成了 getter/setter、toString()等方法。

说明 @Data 注解在类上，会为类的所有属性自动生成 setter/getter、equals、canEqual、hashCode、toString方法，对于 final 属性，则不会为该属性生成 setter() 方法。

实例二：自动化日志变量

@Slf4j
@RestController
@RequestMapping(("/user"))
public class UserController {

    @GetMapping("/getUserById/{id}")
    public User getUserById(@PathVariable Integer id) {
        User user = new User();
        user.setUsername("风清扬");
        user.setAge(21);
        user.setId(id);

        if (log.isInfoEnabled()) {
            log.info("用户 {}", user);
        }
        return user;
    }
}

过反编译可以看到 @Slf4j 注解生成了 log 日志变量（严格意义来说是常量），无需去声明一个 log 就可以在类中使用 log 记录日志。

4、常用注解

  • @Data 注解在类，生成setter/getter、equals、canEqual、hashCode、toString方法，如为final属性，则不会为该属性生成setter方法。
  • @Setter 注解在类或字段，注解在类时为所有字段生成setter方法，注解在字段上时只为该字段生成setter方法。
  • @Getter 使用方法同上，区别在于生成的是getter方法。
  • @ToString 注解在类，添加toString方法。
  • @EqualsAndHashCode 注解在类，生成hashCode和equals方法。
  • @NoArgsConstructor 注解在类，生成无参的构造方法。
  • @RequiredArgsConstructor 注解在类，为类中需要特殊处理的字段生成构造方法，比如final和被@NonNull注解的字段。
  • @AllArgsConstructor 注解在类，生成包含类中所有字段的构造方法。
  • @Slf4j 注解在类，生成log变量，严格意义来说是常量。private static final Logger log = LoggerFactory.getLogger(UserController.class);

三、Lombok 工作原理

在Lombok使用的过程中，只需要添加相应的注解，无需再为此写任何代码。自动生成的代码到底是如何产生的呢？

核心之处就是对于注解的解析上。JDK5引入了注解的同时，也提供了两种解析方式。

运行时解析：运行时能够解析的注解，必须将@Retention设置为RUNTIME，这样就可以通过反射拿到该注解。java.lang.reflect反射包中提供了一个接口AnnotatedElement，该接口定义了获取注解信息的几个方法，Class、Constructor、Field、Method、Package等都实现了该接口，对反射熟悉的朋友应该都会很熟悉这种解析方式。

编译时解析：编译时解析有两种机制，分别简单描述下：

1、Annotation Processing Tool

apt自JDK5产生，JDK7已标记为过期，不推荐使用，JDK8中已彻底删除，自JDK6开始，可以使用Pluggable Annotation Processing API来替换它，apt被替换主要有2点原因：

  1. api都在com.sun.mirror非标准包下
  2. 没有集成到javac中，需要额外运行

2、Pluggable Annotation Processing API

JSR 269自JDK6加入，作为apt的替代方案，它解决了apt的两个问题，javac在执行的时候会调用实现了该API的程序，这样我们就可以对编译器做一些增强，javac执行的过程如下：

Lombok本质上就是一个实现了“JSR 269 API”的程序。在使用javac的过程中，它产生作用的具体流程如下：

  1. javac对源代码进行分析，生成了一棵抽象语法树（AST）
  2. 运行过程中调用实现了“JSR 269 API”的Lombok程序
  3. 此时Lombok就对第一步骤得到的AST进行处理，找到@Data注解所在类对应的语法树（AST），然后修改该语法树（AST），增加getter和setter方法定义的相应树节点
  4. javac使用修改后的抽象语法树（AST）生成字节码文件，即给class增加新的节点（代码块）

通过读Lombok源码，发现对应注解的实现都在HandleXXX中，比如@Getter注解的实现在HandleGetter.handle()。还有一些其它类库使用这种方式实现，比如Google Auto、Dagger等等。

四、Lombok 缺点

任何事物好用，也不能滥用，需要把握好度。Lombok 有人建议使用，也有人反对使用。其实需要视情况而定。

这里收集了 Lombok 如下缺点来参考：

1、代码可读性和可调试性降低

大量使用Lombok，例如想要知道某个类中的某个属性的getter方法都被哪些类引用的话，就没那么简单了。

注：这种说法是不对的，其实通过IDEA可以很方便的找到某个属性的getter方法都被哪些类引用。

2、必须安装第三方插件

如果未安装插件，使用IDE打开一个基于Lombok的项目的话会提示找不到方法等错误。导致项目编译失败。所以只要你负责的项目使用了Lombok，就必须安装插件。

注：这点我觉得不是最不能接受的，安装一个插件也不会很费事。

3、有坑

在使用Lombok过程中，如果对于各种注解的底层原理不理解的话，很容易产生意想不到的结果。

举一个简单的例子，我们知道，当我们使用@Data定义一个类的时候，会自动帮我们生成equals()方法 。

但是如果只使用了@Data，而不使用@EqualsAndHashCode(callSuper=true)的话，会默认是@EqualsAndHashCode(callSuper=false),这时候生成的equals()方法只会比较子类的属性，不会考虑从父类继承的属性，无论父类属性访问权限是否开放。

注：确实会存在这样的问题，不过我们用什么工具，就必须对这个工具要有了解，不然就变成黑盒了，上线很容易出问题。

4、影响升级

因为Lombok对于代码有很强的侵入性，就可能带来一个比较大的问题，那就是会影响我们对JDK的升级。如果我们需要升级到某个新版本的JDK的时候，若其中的特性在Lombok中不支持的话就会受到影响。因为一个应用可能依赖了多个jar包，而每个jar包可能又要依赖不同版本的Lombok，这就导致在应用中需要做版本仲裁，而我们知道，jar包版本仲裁是没那么容易的，而且发生问题的概率也很高。

注：这个问题我没有碰到过，如果有，确实比较头疼，如果是maven项目需要去排包，有类似经历的同学欢迎留言

5、破坏抽象

如果我们在代码中直接使用Lombok，那么他会自动帮我们生成getter、setter 等方法，这就意味着，一个类中的所有参数都自动提供了设置和读取方法。

外部可以通过 setter 方法随意地修改属性的值。而面向对象封装的定义是：通过访问权限控制，隐藏内部数据，外部仅能通过类提供的有限的接口访问、修改内部数据。所以，暴露不应该暴露的 setter 方法，明显违反了面向对象的封装特性。

好的做法应该是不提供getter/setter，而是通过暴露实体的行为去访问和修改实体的属性值，这也是DDD所倡导的。