让人又爱又恨的Lombok，到底该不该用

1 简介

Lombok，印尼的一个岛屿，龙目岛。但在Java的世界里，它是一个方便的类库，能提供很多便利，因此得到许多人的青睐。但也有不少反对声音。这是为什么呢？

之前去龙目岛拍的日落。

2 Lombok提供的便利

一般我们在Java中用到POJO时，就很容易想到要用Lombok，如VO、DTO、DO等。使用Lombok需要安装对应IDE的插件，同时需要引入依赖：

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

举个例子，如果不用Lombok，实现getter/setter、equals、hashCode、toString代码量非常大，如下所示：

package com.pkslow.basic.lombok;

import java.util.Objects;

public class Book {
    private String name;
    private int id;
    private double price;
    private String author;
    private String desc;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public int getId() {
        return id;
    }

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

    public double getPrice() {
        return price;
    }

    public void setPrice(double price) {
        this.price = price;
    }

    public String getAuthor() {
        return author;
    }

    public void setAuthor(String author) {
        this.author = author;
    }

    public String getDesc() {
        return desc;
    }

    public void setDesc(String desc) {
        this.desc = desc;
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (o == null || getClass() != o.getClass()) return false;
        Book book = (Book) o;
        return id == book.id &&
                Double.compare(book.price, price) == 0 &&
                Objects.equals(name, book.name) &&
                Objects.equals(author, book.author) &&
                Objects.equals(desc, book.desc);
    }

    @Override
    public int hashCode() {
        return Objects.hash(name, id, price, author, desc);
    }

    @Override
    public String toString() {
        return "Book{" +
                "name='" + name + '\'' +
                ", id=" + id +
                ", price=" + price +
                ", author='" + author + '\'' +
                ", desc='" + desc + '\'' +
                '}';
    }
}

而且大部分是样板代码，没有太多实际逻辑。

如果使用Lombok则非常简单，一个注解@Data就可以完成以上工作（安装了Lombok插件后才能显示右边的方法）：

让人又爱又恨的Lombok，到底该不该用

Lombok的常用注解有：

@NonNull：用于做空指针异常检测；

@Cleanup：自动资源关闭；

@Getter/@Setter：自动生成get/set方法；

@ToString：生成toString方法，方便打印调试；

@EqualsAndHashCode：生成equals和hashCode方法，注意这两个应该同时去实现；

@NoArgsConstructor, @RequiredArgsConstructor and @AllArgsConstructor：构造方法；

@Data：相当于 @ToString+ @EqualsAndHashCode+@Getter+ @Setter +@RequiredArgsConstructor。

@Builder：生成builder方法；

@Log：日志相关：

@CommonsLog：org.apache.commons.logging.LogFactory.getLog(LogExample.class);
@Flogger：com.google.common.flogger.FluentLogger.forEnclosingClass();
@JBossLog：org.jboss.logging.Logger.getLogger(LogExample.class);
@Log：java.util.logging.Logger.getLogger(LogExample.class.getName());
@Log4j：org.apache.log4j.Logger.getLogger(LogExample.class);
@Log4j2：org.apache.logging.log4j.LogManager.getLogger(LogExample.class);
@Slf4j：org.slf4j.LoggerFactory.getLogger(LogExample.class);
@XSlf4j：org.slf4j.ext.XLoggerFactory.getXLogger(LogExample.class);
@CustomLog：com.foo.your.LoggerFactory.createYourLogger(LogExample.class);

所以Lombok确实能给我们带来极大的便利，减少大量重复、无业务逻辑的代码，代码显得比较干净；修改了field的名字，不用多处修改；提高开发效率。