Lombok简介、使用、工作原理、优缺点

一、Lombok简介

官方介绍
Project Lombok is a java library that automatically plugs into your editor and build tools, spicing up your java.Never write another getter or equals method again, with one annotation your class has a fully featured builder, Automate your logging variables, and much more.

大概的意思：Lombok是一个Java库，能自动插入编辑器并构建工具，简化Java开发。通过添加注解的方式，不需要为类编写getter或eques方法，同时可以自动化日志变量。官网链接

简而言之：Lombok能以简单的注解形式来简化java代码，提高开发人员的开发效率。

二、Lombok使用

使用Lombok需要的开发环境Java+Maven+IntelliJ IDEA或者Eclipse（安装Lombok Plugin）

1. 添加maven依赖

  org.projectlombok
  lombok
  1.18.4
  provided

2. 安装插件

使用Lombok还需要插件的配合，我使用的开发工具为IDE，这里只讲解idea中安装lombok插件，使用eclipse和myeclipse的小伙伴自行google安装方法。

打开idea的设置，点击Plugins，点击Browse repositories，在弹出的窗口中搜索lombok，然后安装即可。

3. 解决编译时出错问题

编译时出错，可能是没有enable注解处理器。Annotation Processors > Enable annotation processing。设置完成之后程序正常运行。

4. 示例

下面举两个栗子，看看使用lombok和不使用的区别。

创建一个用户类

（1）不使用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);
  }

}

（2）使用Lombok

@Data
public class User implements Serializable {

  private static final long serialVersionUID = -8054600833969507380L;

  private Integer id;

  private String username;

  private Integer age;

}

编译源文件，然后反编译class文件，反编译结果如下图。说明@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记录日志。

5. 常用注解

下面介绍一下常用的几个注解：

（1）@Setter 注解在类或字段，注解在类时为所有字段生成setter方法，注解在字段上时只为该字段生成setter方法。

（2）@Getter 使用方法同上，区别在于生成的是getter方法。

（3）@ToString 注解在类，添加toString方法。

（4）@EqualsAndHashCode 注解在类，生成hashCode和equals方法。

（5）@NoArgsConstructor 注解在类，生成无参的构造方法。

（6）@RequiredArgsConstructor 注解在类，为类中需要特殊处理的字段生成构造方法，比如final和被@NonNull注解的字段。

（7）@AllArgsConstructor 注解在类，生成包含类中所有字段的构造方法。

（8）@Data 注解在类，生成setter/getter、equals、canEqual、hashCode、toString方法，如为final属性，则不会为该属性生成setter方法。

（9）@Slf4j 注解在类，生成log变量，严格意义来说是常量。

private static final Logger log = LoggerFactory.getLogger(UserController.class);

三、Lombok工作原理

在Lombok使用的过程中，只需要添加相应的注解，无需再为此写任何代码。

自动生成的代码到底是如何产生的呢？

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

1. 运行时解析

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

2. 编译时解析

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

（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的优缺点

1. Lombok有什么好处？

通过上面的例子，大家可以发现，使用@Data注解大大减少了代码量，使代码非常简洁，这也是很多开发者热衷于使用Lombok的主要原因。

不仅如此，我还列举了Lombok其它的优势：

（1）减少模板代码：lombok处理get，set，toString，hash，equal等方法，大量的模板代码进行封装，减少重复代码，当增加新属性的时候，以上方法都不需要再重新编写；

（2）增强代码可读性：专注于类的属性定义，不需要再去为排版浪费时间；

（3）减少代码维护：新增属性的时候，会减少非常多的代码维护工作。

2. Lombok有什么坏处？

（1）强迫队友

Lombok插件的使用，要求开发者一定要在IDE中安装对应的插件。不仅自己要安装，任何和你协同开发的人都要安装。

如果有谁未安装插件的话，使用IDE打开一个基于Lombok的项目的话会提示找不到方法等错误，导致项目编译失败。

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

（2）代码可调试性降低

Lombok确实可以帮忙减少很多代码，因为Lombok会帮忙自动生成很多代码。

但是，这些代码是要在编译阶段才会生成的，所以在开发的过程中，很多代码其实是缺失的。

这就给代码调试带来一定的问题，我们想要知道某个类中的某个属性的getter方法都被哪些类引用的话，就没那么简单了。

（3）影响版本升级

Lombok对于代码有很强的侵入性，就可能带来一个比较大的问题，那就是会影响我们对JDK的升级。

按照如今JDK的升级频率，每半年都会推出一个新的版本，但是Lombok作为一个第三方工具，并且是由开源团队维护的，那么他的迭代速度是无法保证的。

所以，如果我们需要升级到某个新版本的JDK的时候，若其中的特性在Lombok中不支持的话就会受到影响。

还有一个可能带来的问题，就是Lombok自身的升级也会受到限制。

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

（4）谈谈踩过的坑

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

举一个简单的例子：

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

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

（5）可能会破坏封装性

如果说上面的4点问题都可以人为避免，那么，关于封装性的问题就是Lombok的短板了。

举个简单的例子，我们定义一个购物车类：

@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三个属性。

3. 总结

Lombok注解可以自动生成代码，大大减少了代码量，使代码非常简洁。

但是并不意味着Lombok的使用没有任何问题，在使用Lombok的过程中，还可能存在对队友不友好、对代码不友好、对调试不友好、对升级不友好等问题。

虽然，使用Lombok还会导致破坏封装性的问题，但是我更认为Lombok的操作是遵循了Bean的使用初衷。

Bean尤其数据库和Java类的映射Bean，Java对Bean的定义和使用就是无参数的构造方法和set和get方法，而不应该在bean中处理任何和业务有任何关系的逻辑。