Lombok常用注解

和其他语言相比， Java经常因为不必要的冗长被批评。 Lombok提供了一系列注解用以在后台生成模板代码，将其从你的类中删除，从而有助于保持你的代码整洁。较少的模板意味着更简洁的代码，更易于阅读和维护。在本文中，我将涉及我经常使用的 Lombok功能，并向你展示如何使用他们生产更清晰、更简洁的代码。

1. @NonNull

对方法参数进行 null 检查通常不是一个坏主意，特别是如果该方法形成的 API被其他开发者使用。虽然这些检查很简单，但是他们可能变得冗长，特别是当你有多个参数时。如下所示，额外的代码无助于可读性，并且可能从方法的主要目的分散注意力。

public void nonNullDemo(Employee employee, Account account) {

    if (employee == null) {
        throw new IllegalArgumentException("Employee is marked @NonNull but is null");
    }

    if (account == null) {
        throw new IllegalArgumentException("Account is marked @NonNull but is null");
    }

    // do stuff
}

理想情况下，你需要 null 检查——没有干扰的那种。这就是 @NonNull发挥作用的地方。通过用@NonNull标记参数，Lombok替你为该参数生成 null 检查。你的方法突然变得更加简洁，但没有丢失那些安全性的 null 检查。

public void nonNullDemo(@NonNull Employee employee, @NonNull Account account) {

    // just do stuff

}

默认情况下， Lombok会抛出 NullPointerException，如果你愿意，可以配置 Lombok抛出 IllegalArgumentException。我个人更喜欢 IllegalArgumentException，因为我认为它更适合于对参数检查。

2. 更简洁的数据类

数据类是 Lombok 真正有助于减少模板代码的领域。在查看该选项前，思考一下我们经常需要处理的模板种类。数据类通常包括以下一种或全部：

构造函数（有或没有参数）
私有成员变量的 getter 方法
私有非 final 成员变量的 setter 方法
帮助记录日志的 toString 方法
equals 和 hashCode（处理相等/集合）

可以通过 IDE 生成以上内容，因此问题不在于编写他们花费的时间。问题是带有少量成员变量的简单类很快会变得非常冗长。让我们看看 Lombok 如何通过处理上述的每一项来减少混乱。

3.1 @Getter 和 @Setter

想想下面的 Car 类。当生成 getter 和 setter 时，我们会得到接近 50 行代码来描述一个包含 5 个成员变量的类。

public class Car {

    private String make;
    private String model;
    private String bodyType;
    private int yearOfManufacture;
    private int cubicCapacity;

    public String getMake() {
        return make;
    }

    public void setMake(String make) {
        this.make = make;
    }

    public String getModel() {
        return model;
    }

    public void setModel(String model) {
        this.model = model;
    }

    public String getBodyType() {
        return bodyType;
    }

    public void setBodyType(String bodyType) {
        this.bodyType = bodyType;
    }

    public int getYearOfManufacture() {
        return yearOfManufacture;
    }

    public void setYearOfManufacture(int yearOfManufacture) {
        this.yearOfManufacture = yearOfManufacture;
    }

    public int getCubicCapacity() {
        return cubicCapacity;
    }

    public void setCubicCapacity(int cubicCapacity) {
        this.cubicCapacity = cubicCapacity;
    }

}

Lombok可以替你生成 getter和 setter模板。通过对每个成员变量使用 @Getter和 @Setter注解，你最终得到一个等效的类，如下所示：

public class Car {

    @Getter
    @Setter
    private String make;

    @Getter
    @Setter
    private String model;

    @Getter
    @Setter
    private String bodyType;

    @Getter
    @Setter
    private int yearOfManufacture;

    @Getter
    @Setter
    private int cubicCapacity;

}

注意，你只能在非 final 成员变量上使用 @Setter，在 final成员变量上使用将导致编译错误。

如果你需要为每个成员变量生成 getter和 setter，你也可以在类级别使用 @Getter和 @Setter，如下所示。

@Getter
@Setter
public class Car {

    private String make;

    private String model;

    private String bodyType;

    private int yearOfManufacture;

    private int cubicCapacity;

}

3.2 @AllArgsConstructor

数据类通常包含一个构造函数，它为每个成员变量接受参数。IDE 为 Car 生成的构造函数如下所示：

public class Car {

    @Getter
    @Setter
    private String make;

    @Getter
    @Setter
    private String model;

    @Getter
    @Setter
    private String bodyType;

    @Getter
    @Setter
    private int yearOfManufacture;

    @Getter
    @Setter
    private int cubicCapacity;

    public Car(String make, String model, String bodyType, int yearOfManufacture, int cubicCapacity) {
        super();
        this.make = make;
        this.model = model;
        this.bodyType = bodyType;
        this.yearOfManufacture = yearOfManufacture;
        this.cubicCapacity = cubicCapacity;
    }

}

我们可以使用 @AllArgsConstructor 注解实现同样功能。使用 @Getter 和 @Setter、 @AllArgsConstructor可以减少模板，保持类更干净且更简洁。

@AllArgsConstructor
public class Car {

    @Getter
    @Setter
    private String make;

    @Getter
    @Setter
    private String model;

    @Getter
    @Setter
    private String bodyType;

    @Getter
    @Setter
    private int yearOfManufacture;

    @Getter
    @Setter
    private int cubicCapacity;

}

还有其他选项用于生成构造函数。 @RequiredArgsConstructor 将创建带有每个 final成员变量参数的构造函数， @NoArgsConstructor
将创建没有参数的构造函数。

3.3 @ToString

在你的数据类上覆盖 toString方法是有助于记录日志的良好实践。IDE 为 Car类生成的 toString方法如下所示：

@AllArgsConstructor
public class Car {

    @Getter
    @Setter
    private String make;

    @Getter
    @Setter
    private String model;

    @Getter
    @Setter
    private String bodyType;

    @Getter
    @Setter
    private int yearOfManufacture;

    @Getter
    @Setter
    private int cubicCapacity;

    @Override
    public String toString() {
        return "Car [make=" + make + ", model="
                + model + ", bodyType=" + bodyType + ", yearOfManufacture="
                + yearOfManufacture + ", cubicCapacity=" + cubicCapacity
                + "]";
    }

}

我们可以使用 ToString注解替换这个，如下所示：

@ToString
@AllArgsConstructor
public class Car {
    @Getter
    @Setter
    private String make;
    @Getter
    @Setter
    private String model;
    @Getter
    @Setter
    private String bodyType;
    @Getter
    @Setter
    private int yearOfManufacture;
    @Getter
    @Setter
    private int cubicCapacity;
}

默认情况下，Lombok 生成包含所有成员变量的 toString 方法。可以通过 exclude 属性 @ToString(exclude={"someField"},"someOtherField"}) 覆盖行为将某些成员变量排除。

3.4 @EqualsAndHashCode

如果你正在将你的数据类和任何类型的对象比较，则需要覆盖 equals和 hashCode 方法。对象的相等是基于业务规则定义的。举个例子，在 Car类中，如果两个对象有相同的 make、 model和 bodyType，我可能认为他们是相等的。如果我使用 IDE 生成 equals 方法检查 make、 model 和 bodyType，它看起来会是这样：

@Override
public boolean equals(Object obj) {
    if (this == obj)
        return true;
    if (obj == null)
        return false;
    if (getClass() != obj.getClass())
        return false;
    Car other = (Car) obj;
    if (bodyType == null) {
        if (other.bodyType != null)
            return false;
    } else if (!bodyType.equals(other.bodyType))
        return false;
    if (make == null) {
        if (other.make != null)
            return false;
    } else if (!make.equals(other.make))
        return false;
    if (model == null) {
        if (other.model != null)
            return false;
    } else if (!model.equals(other.model))
        return false;
    return true;
}

等价的 hashCode 实现如下所示：

@Override
public int hashCode() {
    final int prime = 31;
    int result = 1;
    result = prime * result + ((bodyType == null) ? 0 : bodyType.hashCode());
    result = prime * result + ((make == null) ? 0 : make.hashCode());
    result = prime * result + ((model == null) ? 0 : model.hashCode());
    return result;
}

虽然 IDE 处理了繁重的工作，但我们在类中仍然有大量的模板代码。 Lombok允许我们使用 @EqualsAndHashCode 类注解实现相同的功能，如下所示：

@ToString
@AllArgsConstructor
@EqualsAndHashCode(exclude = {"yearOfManufacture", "cubicCapacity"})
public class Car {
    @Getter
    @Setter
    private String make;
    @Getter
    @Setter
    private String model;
    @Getter
    @Setter
    private String bodyType;
    @Getter
    @Setter
    private int yearOfManufacture;
    @Getter
    @Setter
    private int cubicCapacity;
}

默认情况下，@EqualsAndHashCode 会创建包含所有成员变量的 equals 和 hashCode 方法。 exclude选项可用于通知 Lombok排除某些成员变量。在上面的代码片段中。我已经从生成的 equals和 hashCode方法中排除了 yearOfManuFacture 和 cubicCapacity。

3.5 @Data

如果你想使数据类尽可能精简，可以使用 @Data 注解。 @Data 是 @Getter、 @Setter、 @ToString、 @EqualsAndHashCode 和 @RequiredArgsConstructor 的快捷方式。

@ToString
@RequiredArgsConstructor
@EqualsAndHashCode(exclude = {"yearOfManufacture", "cubicCapacity"})
public class Car {
    @Getter
    @Setter
    private String make;
    @Getter
    @Setter
    private String model;
    @Getter
    @Setter
    private String bodyType;
    @Getter
    @Setter
    private int yearOfManufacture;
    @Getter
    @Setter
    private int cubicCapacity;
}

通过使用 @Data，我们可以将上面的类精简如下：

@Data
public class Car {
    private String make;
    private String model;
    private String bodyType;
    private int yearOfManufacture;
    private int cubicCapacity;
}

4. 使用 @Buidler 创建对象

建造者设计模式描述了一种灵活的创建对象的方式。 Lombok可以帮你轻松的实现该模式。看一个使用简单 Car 类的示例。假设我们希望可以创建各种 Car对象，但我们希望在创建时设置的属性具有灵活性。

@AllArgsConstructor
public class Car {
    private String make;
    private String model;
    private String bodyType;
    private int yearOfManufacture;
    private int cubicCapacity;
    private List<LocalDate> serviceDate;
}

假设我们要创建一个 Car，但只想设置 make和 model。在 Car上使用标准的全参数构造函数意味着我们只提供 make和 model并设置其他参数为 null。

Car2 car2 = new Car2("Ford", "Mustang", null, null, null, null);

这可行但并不理想，我们必须为我们不感兴趣的参数传递 null。我们可以创建一个只接受 make和 model的构造函数来避开这个问题。这是一个合理的解决方法，但不够灵活。如果我们有许多不同的字段排列，我们怎么来创建一个新 Car？最终我们得到了一堆不同的构造函数，代表了我们可以实例化 Car的所有可能方式。

解决该问题的一种干净、灵活的方式是使用建造者模式。 Lombok通过 @Builder 注解帮你实现建造者模式。当你使用 @Builder 注解 Car 类时， Lombok会执行以下操作：

添加一个私有构造函数到 Car
创建一个静态的 CarBuilder 类
在 CarBuilder 中为 Car 中的每个成员创建一个 setter风格方法
在 CarBuilder中添加创建 Car 的新实例的建造方法

CarBuilder上的每个 setter 风格方法返回自身的实例（ CarBuilder）。这允许你进行方法链式调用并为对象创建提供流畅的 API。让我们看看它如何使用。

Car muscleCar = Car.builder().make("Ford")
        .model("mustang")
        .bodyType("coupe")
        .build();

现在只使用 make 和 model 创建 Car 比之前更简洁了。只需在 Car 上简单的调用生成的 builder 方法获取 CarBuilder 实例，然后调用任何我们感兴趣的 setter 风格方法。最后，调用 build 创建 Car 的新实例。

另一个值得一提的方便的注解是 @Singular。默认情况下，Lombok 为集合创建使用集合参数的标准的 setter 风格方法。在下面的例子中，我们创建了新的 Car 并设置了服务日期列表。

@Builder
public class Car {
    private String make;
    private String model;
    private String bodyType;
    private int yearOfManufacture;
    private int cubicCapacity;
    @Singular
    private List<LocalDate> serviceDate;
}

向集合成员变量添加 @Singular 将提供一个额外的方法，允许你向集合添加单个项。

Car muscleCar3 = Car.builder()
        .make("Ford")
        .model("mustang")
        .serviceDate(LocalDate.of(2016, 5, 4))
        .build();

现在我们可以添加单个服务日期，如下所示：

Car muscleCar3 = Car.builder()
        .make("Ford")
        .model("mustang")
        .serviceDate(LocalDate.of(2016, 5, 4))
        .build();

这是一个有助于在创建对象期间处理集合时保持代码简洁的快捷方法。

5. 日志

Lombok另一个伟大的功能是日志记录器。如果没有 Lombok，要实例化标准的 SLF4J日志记录器，通常会有以下内容：

public class SomeService {
    
    private static final org.slf4j.Logger log = org.slf4j.LoggerFactory.getLogger(LogExample.class);

    public void doStuff() {
        log.debug("doing stuff....");
    }
}

这些日志记录器很沉重，并为每个需要日志记录的类添加了不必要的混乱。值得庆幸的是 Lombok提供了一个为你创建日志记录器的注解。你要做的所有事情就是在类上添加注解，这样就可以了。

@Slf4j
public class SomeService {
    public void doStuff() {
        log.debug("doing stuff....");
    }
}

我在这里使用了 @SLF4J注解，但 Lombok能为几乎所有通用 Java日志框架生成日志记录器。有关更多日志记录器的选项，请参阅文档。

我非常喜欢 Lombok 的一点是它的不侵入性。如果你决定在使用如 @Getter、 @Setter 或 @ToString 时也想要自己的方法实现，你的方法将总是优先于 Lombok。它允许你在大多数时间使用 Lombok，但在你需要的时候仍有控制权。

人面猴
序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
沈念sama阅读 158,560评论 4赞 361
死咒
序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
沈念sama阅读 67,104评论 1赞 291
救了他两次的神仙让他今天三更去死
文/潘晓璐我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
开封第一讲书人阅读 108,297评论 0赞 243
道士缉凶录：失踪的卖姜人
文/不坏的土叔我叫张陵，是天一观的道长。经常有香客问我，道长，这世上最难降的妖魔是什么？我笑而不...
开封第一讲书人阅读 43,869评论 0赞 204
港岛之恋（遗憾婚礼）
正文为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
茶点故事阅读 52,275评论 3赞 287
恶毒庶女顶嫁案：这布局不是一般人想出来的
文/花漫我一把揭开白布。她就那样静静地躺着，像睡着了一般。火红的嫁衣衬着肌肤如雪。梳的纹丝不乱的头发上，一...
开封第一讲书人阅读 40,563评论 1赞 216
城市分裂传说
那天，我揣着相机与录音，去河边找鬼。笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。我是一名探鬼主播，决...
沈念sama阅读 31,833评论 2赞 312
双鸳鸯连环套：你想象不到人心有多黑
文/苍兰香墨我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
开封第一讲书人阅读 30,543评论 0赞 197
万荣杀人案实录
序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
沈念sama阅读 34,245评论 1赞 241
护林员之死
正文独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋以下内容为张勋视角年9月15日...
茶点故事阅读 30,512评论 2赞 244
白月光启示录
正文我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
茶点故事阅读 32,011评论 1赞 258
活死人
序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
沈念sama阅读 28,359评论 2赞 253
日本核电站爆炸内幕
正文年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
茶点故事阅读 33,006评论 3赞 235
男人毒药：我在死后第九天来索命
文/蒙蒙一、第九天我趴在偏房一处隐蔽的房顶上张望。院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
开封第一讲书人阅读 26,062评论 0赞 8
一桩弑父案，背后竟有这般阴谋
文/苍兰香墨我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。一阵脚步声响...
开封第一讲书人阅读 26,825评论 0赞 194
情欲美人皮
我被黑心中介骗来泰国打工，没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。一个月前我还...
沈念sama阅读 35,590评论 2赞 273
代替公主和亲
正文我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
茶点故事阅读 35,501评论 2赞 268