Lombok: Java开发的利器

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


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

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

1. 不用再写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其它的一些很棒的特性。

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

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

3. 通过类注解来生成构造方法
     @NoArgsConstructor生成一个默认的构造方法
     @RequiredArgsConstructor为所有final和非空（译注：带有@NonNull注解)字段生成一个构造方法
     @AllArgsConstructor会为所有字段生成一个构造方法
4. @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很般配。

原创文章转载请注明出处：http://it.deepinmind.com

英文原文链接

评论

23 楼 非法用户 2014-09-12  

我们编译打包用的maven啊，需要maven插件支持吗？

22 楼 endual 2014-04-10  

谈不上利器吧，现有IDE可以辅助解决很多JAVA劣势。

21 楼 w286332849 2014-04-10  

Night舞夜 写道

使用注解 @Getter @Setter 能调用实例对象的getter setter方法嘛？(显示的调用，而不是通过反射)

这货主要是黑了Eclipse的编译器,你加了注解之后,Eclipse编译出来的class里面已经存在了get/set方法. 所以你就可以直接调用了.

20 楼 w286332849 2014-04-10  

代码生成器 你值得拥有.

19 楼 Night舞夜 2014-04-10  

使用注解 @Getter @Setter 能调用实例对象的getter setter方法嘛？(显示的调用，而不是通过反射)

18 楼 quanzhanweiyi-cc 2014-04-09  

这种只适合纯粹set get，如果方法里家简单逻辑就不行了

17 楼 gundumw100 2014-04-09  

1：工具生成的setter/getter/toString/hashCode都太死
2：又要多记一些关键字了
综上：纯粹鸡肋！

16 楼 deepinmind 2014-04-09  

freezingsky 写道

我只能说，如果从代码的清洁程度上去考虑的话，使用注解确实可以让类看起来更简洁干净些。但同时也引入了新的学习曲线，而这个学习曲线还没有达到有用户觉得这是一种可以接受的范围。

所以，我想绝大数人都会选择让IDE去做这个事吧。

是的，其实它就是提供了另一种选择而已，你说的或许也是这个工具不怎么流行的原因。我在项目中也不用它，事实上我觉得它应该更适合个人开发。要团队中所有人统一接受它还是有一定成本的。

15 楼 freezingsky 2014-04-09  

我只能说，如果从代码的清洁程度上去考虑的话，使用注解确实可以让类看起来更简洁干净些。但同时也引入了新的学习曲线，而这个学习曲线还没有达到有用户觉得这是一种可以接受的范围。

所以，我想绝大数人都会选择让IDE去做这个事吧。

14 楼 remoteJavaSky 2014-04-08  

我看到这就想到了四个字  大浪淘沙

13 楼 sayji 2014-04-08  

按几个快捷键都完成了。除非像C# 3.0 加入的的自动属性那样，不用写字段还差不多。

12 楼 love297 2014-04-08  

"人们不喜欢Java...."说的我像是火星人似得。

11 楼 rex0654335 2014-04-08  

此功能无实际意义

10 楼 deepinmind 2014-04-08  

wuyunlong 写道

Lombok我看见就想干掉。它在ide差异化的团队遭受诟病，本来就是使用idea能够解决快速解决的问题，非要多此一举。

这确实是见仁见智的问题，我们项目中其实也没用。

9 楼 lcwen08 2014-04-08  

其实有点多此一举了，ide已经能够很好的完成了

8 楼 wuyunlong 2014-04-08  

Lombok我看见就想干掉。它在ide差异化的团队遭受诟病，本来就是使用idea能够解决快速解决的问题，非要多此一举。

7 楼 deepinmind 2014-04-08  

guomingzhang2008 写道

支持eclipse，但是对idea的支持不是很好，至少在半年前我还没有在idea上使用成功！

IDEA的插件前几天刚更新了，你可以试下，我这边是可以了

6 楼 guomingzhang2008 2014-04-08  

支持eclipse，但是对idea的支持不是很好，至少在半年前我还没有在idea上使用成功！

5 楼 deepinmind 2014-04-08  

1927105 写道

这是codesmith干的活啊，用注解是不是有点重量级了，何况效率如何？

效率是没有问题的，它是在输出成class文件的时候进行生成的，不是运行时的增强。

4 楼 deepinmind 2014-04-08  

yixiandave 写道

限制有点死。toString()和hashCode()不一定是按照这种逻辑来，equals也可能只比较某一个字段或者是自己实现的算法。
甚至是Getter和Setter也可能包含了转换操作。
至于构造器，一个类的构造器可能远远不止一个，这包含了一些默认参数的设定之类的。我认为groovy输入一个map实现构造的方式更为灵活

确实是，这也就适合最普通的一些情况，用来替代IDE生成代码的那种场景的。