分享 Java 开发的利器-Lombok

译注： Lombok 是一个很老的项目了，也非常实用，但奇怪的是这么多年来似乎一直不温不火。很多 Lombok 特性可以参考它的官网介绍哈。兄弟连教育在这里只是简单介绍一下它的基础功能。

Lombok 是一个旨在减少代码开发工作的 Java 库。兄弟连在本文介绍了如何用它来完成 getter/setter 方法，构造方法，以及重写 equals()， hashCode()和 toString()方法。在 Java 中，一个很简单的类却往往写得特别复杂。如果你没听说过 Lombok 的话，那它肯定会让你满意的。

Lombok 可以帮助 Java 开发人员完成以下这些事情：

不用再写 setter/getter 方法了不用 Lombok 的话，我们通常都得这么写：

public class Animal {

private String name;
private String gender;
private String species;

public String getName(){
    return this.name;
}

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

public String getGender(){
    return this.gender;
}

public void setGender(String gender){
    this.gender = gender;
}

public String getSpecies(){
    return this.species;
}

public void setSpecies(String species){
    this.species = species;
}

} 这些方法写多了之后，我慢慢开始有点讨厌 Java 了。

有了 Lombok 之后：

public class Animal {

@Getter @Setter private String name;
@Getter @Setter private String gender;
@Getter @Setter private String species;

} 日子开始变得滋润多了。下面还有 Lombok 其它的一些很棒的特性。

不用再重写 toString 方法。可以给类加上 @ToString 注解， Lombok 会自动重写 toString 方法并打印出类的所有字段。

不用再重写 equals 和 hashCode 方法 @EqualsAndHashCode 注解可以自动生成这些方法

通过类注解来生成构造方法 @NoArgsConstructor 生成一个默认的构造方法 @RequiredArgsConstructor 为所有 final 和非空（译注：带有 @NonNull 注解)字段生成一个构造方法 @AllArgsConstructor 会为所有字段生成一个构造方法

@Data 是 @ToString, @EqualsAndHashCode, @RequiredArgsConstructor, 和 @Getter / @Setter 这些注解的一个快捷方式。

这些是最常用到的 Lombok 特性。其它的一些功能可以到它的项目主页上进行了解。

示例假设我们有一个类是需要支持序列化的，并且需要一个构造方法。这需要重写 equals,hashCode,toString,同时为私有成员变量提供 setter/getter 方法，并实现一个构造方法。

使用了 Lombok

@RequiredArgsConstructor @ToString @EqualsAndHashCode public class Animal { @Getter @Setter private String name; @Getter @Setter private String gender; @Getter @Setter private String species; } 没有使用 Lombok ：

public class Animal {

private String name;
private String gender;
private String species;

public Animal(String name, String gender, String species) {
    this.name = name;
    this.gender = gender;
    this.species = species;
}

public String getName(){
    return this.name;
}

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

public String getGender(){
    return this.gender;
}

public void setGender(String gender){
    this.gender = gender;
}

public String getSpecies(){
    return this.species;
}

public void setSpecies(String species){
    this.species = species;
}

@Override
public boolean equals(Object o) {
    if (this == o) return true;
    if (!(o instanceof Animal)) return false;

    Animal animal = (Animal) o;

    if (gender != null ? !gender.equals(animal.gender) : animal.gender != null) return false;
    if (name != null ? !name.equals(animal.name) : animal.name != null) return false;
    if (species != null ? !species.equals(animal.species) : animal.species != null) return false;

    return true;
}

@Override
public int hashCode() {
    int result = name != null ? name.hashCode() : 0;
    result = 31 * result + (gender != null ? gender.hashCode() : 0);
    result = 31 * result + (species != null ? species.hashCode() : 0);
    return result;
}

@Override
public String toString() {
    return Objects.toStringHelper(this) //Using guava library objects toString
            .add("name", name)
            .add("gender", gender)
            .add("species", species)
            .toString();
}

} 很多 Java 开发人员会争辩道，"有加注解的那个工夫， IDE 早就把这些代码给生成了！"

我想说的是你没有说到点子上。人们不喜欢 Java 是因为它的代码里必须要有这些乱七八糟的东西。像 Ruby, Groovy, Perl 或者别的脚本语言，都比这简单多了。简单即是美，兄弟连小编觉得 Lombok 和 Java 很般配呢。