Lombok介绍及使用

Lombok的基本使用

以前的Java项目中，充斥着太多不友好的代码：POJO的getter/setter/toString；异常处理；I/O流的关闭操作等等，这些样板代码既没有技术含量，又影响着代码的美观，Lombok应运而生。

1 引入相应的maven包

<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <version>1.16.18</version>
    <optional>true</optional>
    <scope>provided</scope>
</dependency>

注： Lombok的scope=provided，说明它只在编译阶段生效，不需要打入包中。Lombok在编译期将带Lombok注解的Java文件正确编译为完整的Class文件。

2 IDE工具对Lombok的支持配置

2.1 点击File-- Settings设置界面，安装Lombok插件:

2.2 点击File-- Settings设置界面，开启 AnnocationProcessors：

开启该项是为了让Lombok注解在编译阶段起到作用。

Eclipse的Lombok插件安装也比较简单，由于Eclipse内置的编译器不是Oracle javac，而是eclipse自己实现的Eclipse Compiler for Java (ECJ)。要让ECJ支持Lombok，需要在eclipse.ini配置文件中添加如下两项内容：

-Xbootclasspath/a: [lombok.jar所在路径]

3 Lombok实现原理

自从Java 6起，javac就支持“JSR 269 Pluggable Annotation Processing API”规范，只要程序实现了该API，就能在javac运行的时候得到调用。

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

1. javac对源代码进行分析，生成一棵抽象语法树(AST)

2. javac编译过程中调用实现了JSR 269的Lombok程序

3. 此时Lombok就对第一步骤得到的AST进行处理，找到Lombok注解所在类对应的语法树(AST)，然后修改该语法树(AST)，增加Lombok注解定义的相应树节点

4. javac使用修改后的抽象语法树(AST)生成字节码文件

4 Lombok注解的使用

4.1 @Getter/@Setter：

作用类上，生成所有成员变量的getter/setter方法；作用于成员变量上，生成该成员变量的getter/setter方法。可以设定访问权限及是否懒加载等。

package com.kaplan.pojo;

import lombok.*;
import lombok.extern.log4j.Log4j;

@Getter
@Setter
public class TestDemo {

    private String name;
    private int age ; private String email;
    private String address; private String password;
    @Getter @Setter private boolean funny;

}

4.2 @ToString：

作用于类，覆盖默认的toString()方法，可以通过of属性限定显示某些字段，通过exclude属性排除某些字段。

@ToString(of = {"name", "age"}, exclude = {"age"})
public static class Person {
    private String name;
    private int age;
}

4.3 @EqualsAndHashCode：

作用于类，覆盖默认的equals和hashCode

4.4 @NonNull：

主要作用于成员变量和参数中，标识不能为空，否则抛出空指针异常。

public static class Person {
    @NonNull private String name;
    private int age;
}

4.5 @NoArgsConstructor, @RequiredArgsConstructor, @AllArgsConstructor：

作用于类上，用于生成构造函数。有staticName、access等属性，staticName属性一旦设定，将采用静态方法的方式生成实例，access属性可以限定访问权限。

@ToString(of = {"name", "age"}, exclude = {"age"})
@Getter(value = AccessLevel.PUBLIC)
@Setter(value = AccessLevel.PUBLIC)
@NoArgsConstructor(staticName = "of", access = AccessLevel.PRIVATE)
@RequiredArgsConstructor( access = AccessLevel.PACKAGE)
@AllArgsConstructor(access = AccessLevel.PUBLIC)
public static class Person {
    @NonNull private String name;
    private int age;
    private boolean friendly;
}

@NoArgsConstructor：生成无参构造器；

@RequiredArgsConstructor：生成包含final和@NonNull注解的成员变量的构造器；

@AllArgsConstructor：生成全参构造器

4.6 @Data：

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

4.7 @Builder：

作用于类上，将类转变为建造者模式

4.8 @Log：

作用于类上，生成日志变量。针对不同的日志实现产品，有不同的注解：

其他重要注解：

4.9 @Cleanup：

自动关闭资源，针对实现了java.io.Closeable接口的对象有效，如：典型的IO流对象

public static void main(String[] args) throws Exception {
    File file = new File("d:\\test.txt");
    @Cleanup InputStream is =new FileInputStream(file);
    
    int len = 0;
    byte[] b = new byte[1024];
    while((len = is.read(b) != -1) {
        System.out.println("content:" + new String(b, 0, len));
    }
}

编译后结果如下：

public static void main(String[] args) throws Exception {
    File file = new File("d:\\test.txt");
    InputStream is =new FileInputStream(file);
    
    try {
        int len = 0;
        byte[] b = new byte[1024];
        while((len = is.read(b) != -1) {
            System.out.println("content:" + new String(b, 0, len));
        }
    } finally {
        if (is != null) {
            is.close();
        }
    }
}

4.10 @SneakyThrows：

可以对受检异常进行捕捉并抛出，可以改写上述的main方法如下：

@SneakyThrows
public static void main(String[] args) throws Exception {
    File file = new File("d:\\test.txt");
    @Cleanup InputStream is =new FileInputStream(file);
    
    int len = 0;
    byte[] b = new byte[1024];
    while((len = is.read(b) != -1) {
        System.out.println("content:" + new String(b, 0, len));
    }
}

4.11 @Synchronized：

作用于方法级别，可以替换synchronize关键字或lock锁，用处不大。

5 Lombok优缺点分析

5.1 优点

使用注解即可帮忙自动生成代码，大大减少了代码量，使代码非常简洁。

5.2 缺点

5.2.1 协同开发困难、侵入性高

• Lombok的使用要求开发者一定要在IDE中安装对应的插件。如果未安装插件的话，使用IDE打开一个基于Lombok的项目的话会提示找不到方法等错误，导致项目编译失败。

• 如果项目组中有一个人使用了Lombok，那么其他人就必须也要安装IDE插件。否则无法协同开发。

• 如果我们定义的一个jar包中使用了Lombok，那么就要求所有依赖这个jar包的所有应用都必须安装插件，这种侵入性是很高的。

5.2.2 代码可读性，可调试性低

代码是在编译阶段才会生成的，所以在开发的过程中，很多代码是缺失的。在代码中大量使用Lombok，就导致代码的可读性会低很多，而且也会给代码调试带来一定的问题。

例：想要知道某个类中的某个属性的getter方法都被哪些类引用比较困难。

5.2.3 产生过度依赖

因为Lombok使代码开发非常简便，这就使得部分开发者对其产生过度依赖。在使用Lombok过程中，如果对于各种注解的底层原理不理解的话，很容易产生意想不到的结果。

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

5.2.4 影响升级

因为Lombok对于代码有很强的侵入性，就可能带来一个比较大的问题，那就是会影响我们对JDK的升级。按照如今JDK的升级频率，每半年都会推出一个新的版本，但是Lombok作为一个第三方工具，并且是由开源团队维护的，那么他的迭代速度是无法保证的。所以，如果我们需要升级到某个新版本的JDK的时候，若其中的特性在Lombok中不支持的话就会受到影响。

还有一个可能带来的问题，就是Lombok自身的升级也会受到限制。因为一个应用可能依赖了多个jar包，而每个jar包可能又要依赖不同版本的Lombok，这就导致在应用中需要做版本仲裁，而我们知道，jar包版本仲裁是没那么容易的，而且发生问题的概率也很高。

5.2.5 破坏封装性

以上几个问题，都是有办法可以避免的。但是有些人排斥使用Lombok还有一个重要的原因，那就是他会破坏封装性。如果我们在代码中直接使用Lombok，那么他会自动帮我们生成getter、setter 等方法，这就意味着，一个类中的所有参数都自动提供了设置和读取方法。

例：定义一个购物车类：

@Data
public class ShoppingCart { 
    //商品数目
    private int itemsCount; 
    //总价格
    private double totalPrice; 
    //商品明细
    private List items = new ArrayList<>();
}

购物车中商品数目、商品明细以及总价格三者之前其实是有关联关系的，如果需要修改是要一起修改的。

我们知道，购物车中商品数目、商品明细以及总价格三者之前其实是有关联关系的，如果需要修改的话是要一起修改的。

但是，我们使用了Lombok的@Data注解，对于itemsCount 和 totalPrice这两个属性。虽然我们将它们定义成 private 类型，但是提供了 public 的 getter、setter 方法。外部可以通过 setter 方法随意地修改这两个属性的值。我们可以随意调用 setter 方法，来重新设置 itemsCount、totalPrice 属性的值，这也会导致其跟 items 属性的值不一致。

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

正确的做法：不提供getter/setter，而是只提供一个public的addItem方法，同时取修改itemsCount、totalPrice以及items三个属性。

6 总结

虽然使用Lombok存在着很多方便，但是也带来了一些问题。但是到底建不建议在日常开发中使用，我其实保持一个中立的态度，不建议大家过度依赖，也不要求大家一定要彻底不用。只要大家在使用的过程中，或者评估要不要在代码中引入Lombok之前，在想到他的优点的同时，也能够考虑到它给代码所带来的问题。