持续创作，加速成长！这是我参与「掘金日新计划 · 10 月更文挑战」的第2天，点击查看活动详情

一、Lombok的介绍

Lombok项目是一个java库，它可以自动插入到编辑器和构建工具中，增强java的性能。不需要再写getter、setter或equals方法，只要有一个注解你的类就有一个功能齐全的构建器、自动记录变量等等。

二、lombok的优缺点

Lombok优点:
代码简洁，减少冗余代码。

Lombok缺点:

1.强制要求队友安装idea插件如果使用lombok注解编写代码，就要求参与开发的所有人都必须安装idea的lombok插件，否则代码编译出错。
2.代码可读性变差使用lombok注解之后，最后生成的代码你其实是看不到的，你能看到的是代码被修改之前的样子。如果要想查看某个getter或setter方法的引用过程，是非常困难的。
3.升级JDK对功能有影响把JDK从Java 8升级到Java 11时，Lombok不能正常工作了。（目前lombok已升级到 v1.18.24，支持到了JDK18）
4.有一些坑使用@Data时会默认使用@EqualsAndHashCode(callSuper=false)，这时候生成的equals()方法只会比较子类的属性，不会考虑从父类继承的属性，无论父类属性访问权限是否开放。使用@Builder时要加上@AllArgsConstructor，否则可能会报错。
5.不便于调试我们平时大部分人都喜欢用debug调试定位问题，但是使用lombok生成的代码不太好调试。
6.上下游系统强依赖如果上游系统中提供的fegin client使用了lombok，那么下游系统必须也使用lombok，否则会报错，上下游系统构成了强依赖。

三、使用建议

1）、如果是一个新项目，上下游系统都是新的，这时候建议使用lombok，因为它可以显著提升开发效率。

2）、如果是一个老项目，并且以前没有使用过lombok，建议你后面也不要使用，因为代码改造成本较高。如果以前使用过lombok，建议你后面也使用，因为代码改造成本较高。

四、lombok注解

下图为lombok提供的一些相关注解

五、lombok的使用

5-1、idea安装lombok插件

打开idea的插件、搜索lombok安装即可

5-2、引入依赖

<!-- https://mvnrepository.com/artifact/org.projectlombok/lombok -->
<dependency>
   <groupId>org.projectlombok</groupId>
   <artifactId>lombok</artifactId>
   <version>1.18.24</version>
   <scope>provided</scope>
</dependency>

5-3、注解的使用

lombok大部分的注解主要用于实体类中，下面先创建一个User实体类，并创建简单属性

public class User {
    private Integer id;
    private String userName;
}

在没有lombok的项目中，我们需要添加getter、setter、有参/无参构造、并重写toStrong等方法，使用了lombok这些就变的简单，为了便于查看，首先打开idea的Structure,这样就便于查看类中的方法。

5-3-1、@Getter/@Setter注解生成属性getter/setter方法

在未添加@Getter/@Setter注解前，类中只有两个属性，如下：

然后添加@Getter/@Setter（注意引入package是lombok）

添加@Getter后的效果，此时在实体类中是无法看到生成的getter方法。

添加@Setter后的效果，此时在实体类中是无法看到生成的setter方法。

最终添加@Getter/@Setter就和在方法内自己写的getter/setter效果一样（其中无参构造是编译后自动加上的）

5-3-2、@ToString注解生成toString方法

添加@ToString会自动重写toString()方法，会打印出所有变量

项目build一下看下编译的class文件

最终

5-3-3、@EqualsAndHashCode注解生成equls和hashcode方法

添加@EqualsAndHashCode注解，会自动生成equals/canEquals/hashcode方法

项目build，再次查看编译的class文件，就会生成如下三个方法

public boolean equals(final Object o) {
    if (o == this) {
        return true;
    } else if (!(o instanceof User)) {
        return false;
    } else {
        User other = (User)o;
        if (!other.canEqual(this)) {
            return false;
        } else {
            Object this$id = this.getId();
            Object other$id = other.getId();
            if (this$id == null) {
                if (other$id != null) {
                    return false;
                }
            } else if (!this$id.equals(other$id)) {
                return false;
            }

            Object this$userName = this.getUserName();
            Object other$userName = other.getUserName();
            if (this$userName == null) {
                if (other$userName != null) {
                    return false;
                }
            } else if (!this$userName.equals(other$userName)) {
                return false;
            }

            return true;
        }
    }
}

protected boolean canEqual(final Object other) {
    return other instanceof User;
}

public int hashCode() {
    int PRIME = true;
    int result = 1;
    Object $id = this.getId();
    int result = result * 59 + ($id == null ? 43 : $id.hashCode());
    Object $userName = this.getUserName();
    result = result * 59 + ($userName == null ? 43 : $userName.hashCode());
    return result;
}

在不重写类的equals的时候，如果使用equals比较对象的时候，比较的是对象内存地址，而重写equals方法之后，就会比较对象中的所有值。

在没有添加@EqualsAndHashCode的时候

添加@EqualsAndHashCode的时候

5-3-3-1、排除不需要匹配的属性和指定某些属性字段

如果对象的参数很多，而我们个别参数不需要匹配，就可以通过exclude来进行排除，同时也可以使用of来进行指定，虽然user对象的userName值不一致，进行equals的时候依然是true,如下：

如果需要排除多个参数，可进行如下配置

添加了exclude实际上就是在equals的方法内，排除对应的参数进行比较，排除userName之后，查看编译文件可以看到

Q : 为什么只有一个整体的 @EqualsAndHashCode 注解，而不是分开的两个 @Equals 和 @HashCode？

A : 在 Java 中有规定，当两个对象 equals 时，他们的 hashcode 一定要相同，反之，当 hashcode 相同时，对象不一定 equals。所以 equals 和 hashcode 要一起实现，免得发生违反 Java 规定的情形发生

通过以上定律，再次查看排除userName后的hashCode方法，仅对Id进行了hashCode运算

5-3-4、@NoArgsConstructor生成无参构造

5-3-5、@AllArgsConstructor生成所有参数的构造

这里注意一个 Java 的小坑，当我们没有指定构造器时，Java 编译器会帮我们自动生成一个没有任何参数的构造器给该类，但是如果我们自己写了构造器之后，Java 就不会自动帮我们补上那个无参数的构造器了然而很多地方（像是 Spring Data JPA），会需要每个类都一定要有一个无参数的构造器，所以你在加上 @AllArgsConstructor 时，一定要补上 @NoArgsConstrcutor，不然会有各种坑等着你

5-3-6、@RequiredArgsConstructor生成一个包含 "特定参数" 的构造器

特定参数指的是那些有加上 final 修饰词的变量们

特定参数加上lombok的@NonNull修饰（等同final）

补充一下，如果所有的变量都是正常的，都没有用 final 修饰的话，那就会生成一个没有参数的构造器

5-3-7、@Data 整合包注解

整合包，只要加了 @Data 这个注解，等于同时加了以下注解

@Getter
@Setter 
@ToString 
@EqualsAndHashCode 
@RequiredArgsConstructor

@Data 是使用频率最高的 lombok 注解，通常 @Data 会加在一个值可以被更新的对象上，像是日常使用的 DTO 们、或是 JPA 裡的 Entity 们，就很适合加上 @Data 注解，也就是 @Data for mutable class

5-3-8、@Value整合包注解

@Value也是整合包，但是他会把所有的变量都设成 final 的，其他的就跟 @Data 一样，等于同时加了以下注解

@Getter (注意没有setter) 
@ToString 
@EqualsAndHashCode 
@RequiredArgsConstructor

上面那个 @Data 适合用在 POJO 或 DTO 上，而这个 @Value 注解，则是适合加在值不希望被改变的类上，像是某个类的值当创建后就不希望被更改，只希望我们读它而已，就适合加上 @Value 注解，也就是 @Value for immutable class 另外注意一下，此 lombok 的注解 @Value 和另一个 Spring 的注解 @Value 撞名，在 import 时不要 import 错了

5-3-9、@Builder自动生成有参构造及对象的创建

看编译文件如下：

加上@Builder之后就可以使用流式写法，如下：

添加@Builder不会帮我们创建setter方法，因此就无法使用setter方法，如下：

注意，虽然只要加上 @Builder 注解，我们就能够用流式写法快速设定对象的值，但是 setter 还是必须要写不能省略的，因为 Spring 或是其他框架有很多地方都会用到对象的 getter/setter 对他们取值/赋值所以通常是 @Data 和 @Builder 会一起用在同个类上，既方便我们流式写代码，也方便框架做事

5-3-10、@Slf4j

自动生成该类的 log 静态常量，要打日志就可以直接打，不用再手动 new log 静态常量了，一般@Slf4j用在业务层，用于日志的输出。

看编译文件，就可以看到已经帮我们自动创建了日志工具

使用的时候就可以直接进行使用

除了 @Slf4j 之外，lombok 也提供其他日志框架的变种注解可以用，像是 @Log、@Log4j...等，他们都是帮我们创建一个静态常量 log，只是使用的库不一样而已 @Log //对应的log语句如下

private static final java.util.logging.Logger log = java.util.logging.Logger.getLogger(LogExample.class.getName());

@Log4j //对应的log语句如下

private static final org.apache.log4j.Logger log = org.apache.log4j.Logger.getLogger(LogExample.class);

SpringBoot默认支持的就是 slf4j + logback 的日志框架，所以也不用再多做啥设定，直接就可以用在 SpringBoot project上， log 系列注解最常用的就是 @Slf4j

5-3-11、@Synchronized 自动生成同步锁

先给main方法添加@Synchronized

然后查看编译之后的class文件

5-3-12、@SneakyThrows自动添加try-catch

先给方法添加@SneakyThrows注解

然后查看编译后的class文件

Lombok的快速入门