Spring Boot使用Lombok来减少Java中的样板代码

说实话第一次听到Lombok的时候,是从一个带我的匈牙利老师傅那里学来的。那个时候他给了我一套JPA的代码来访问数据库。 当我打开代码的时候,看到满屏幕的错误,打开实体Entity类一看,就一些成员变量的定义,完全没有setter 与getter的方法。 当时我就凌乱了,这什么啊。 后来当他告诉我 去查查lombok我才恍然大悟。

其实对于Java来说我一直都是爱与恨相互纠结。 一方面,Java确实是一种非常成熟的编程语言,具体很多开源的框架跟库,使得开发相对来说比较容易。 但是另一方面,它是非常冗长的, 因为需要编写大量的常用的样板代码。 虽然说在Java8中引入了 Lambdasstream, 情况变得相对来说好了一些, 但是在某一些方面仍然存在一些差异, 比如编写简单的Java对象Pojo,但是现在有了Lombok这个插件,你会发现我们写代码到底可以多轻松。 因为许多常用的方法像 SettergettertoStringequal等等 甚至 构造器 都已经帮你完成了,我们所需要做的就只是

在对的地方添加上注解标记就好了。

首先我们来看看传统的 Java POJO类 应该来怎么定义:

public class User {

    private String name;
    private String surname;
    private int age;

    public User(String name, String surname, int age) {
        this.name = name;
        this.surname = surname;
        this.age = age;
    }

    public String getName() {
        return name;
    }

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

    public String getSurname() {
        return surname;
    }

    public void setSurname(String surname) {
        this.surname = surname;
    }

    public int getAge() {
        return age;
    }

    public void setAge(int age) {
        this.age = age;
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (o == null || getClass() != o.getClass()) return false;
        User user = (User) o;
        return age == user.age
                && Objects.equals(name, user.name)
                && Objects.equals(surname, user.surname);
    }

    @Override
    public int hashCode() {
        return Objects.hash(name, surname, age);
    }

    @Override
    public String toString() {
        return "User{" +
                "name='" + name + '\'' +
                ", surname='" + surname + '\'' +
                ", age=" + age +
                '}';
    }

}

在这个常规的POJO类中只有三个成员字段, namesurnameage。但是它具有常见的POJO类的一切通用元素: getters,** setters, equals, hashCode, 和toString** 方法.

为了完成这个仅仅只有三个成员变量的类,我们竟然写了差不多60行的diamante。 确实,如果你使用IDE的话,IDE确实可以帮你自动生成一些方法的实现,但是在阅读代码的看到这些代码你难道不觉得头疼么。 下面我们通过使用Lombok来简化我们的代码。

首先在项目中添加Lombok的依赖:

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

通常情况下在,如果你使用IDE例如Intellji后者Eclipse,你还需要装上 Lombok的Plugin才能正确使用。 Lombok为成员变量提供了一些基本的注解来确保每一个成员变量都能够自动拥有访问的方法。

@EqualsAndHashCode
@ToString
@AllArgsConstructor
public class User {

    @Setter
    @Getter
    private String name;

    @Setter
    @Getter
    private String surname;

    @Setter
    @Getter
    private int age;

}

正如你所见的,我们使用了五个基本的注解。
@EqualsAndHashCode@ToString 告诉Lombok来生成 equals, hashCode, 和 toString 方法, 在生成这些方法的时候lombok会使用所有的成员变量。 @AllArgsConstructor会自动创建一个包括所有成员的构造器。 @Getter/@Setter annotations 注解会为每一个标记的成员变量自动生成对应的方法。
现在我们只需要像这个正常使用它就好了

User user = new User("John", "Doe", 32);
user.setAge(30);
user.equals(new User("John", "Doe", 30)); // true

如果你不想将注解用在全部的成员变量上,而是仅仅部分变量上,那么你可以提供一个指定的哪一个成员变量需要自动生成方法的变量。 比如在这里,我们不想让 age 这个成员变量出现在 toString 方法里,我们可以这么做:

@EqualsAndHashCode
@ToString(of = {"name", "surname"})
@AllArgsConstructor
public class User {

    @Getter
    @Setter
    private String name;

    @Getter
    @Setter
    private String surname;

    @Getter
    @Setter
    private int age;

}

我想到这里,这些代码已经比我们一开始要好太多了,但是它任然不够简洁。这里重复了大量的 @Getter@Setter 注解。如果你只是需要在Class中仅暴露几个字段,那么使用它们非常方便,但如果您需要为所有字段生成访问器,则会变得烦人又无聊。为了使代码更加简洁, Lombok永续我们在类级上使用这些注解。如果这些注解放在类名之上,那么lombok会自动为我们生成所有字段的访问方法。

@EqualsAndHashCode
@ToString
@AllArgsConstructor
@Getter
@Setter
public class User {

    private String name;
    private String surname;
    private int age;

}

目前为止我们所做的修改并没有改变类的行为,但是却使我们的类看起来更加的简洁。这就是我们使用Lombok想要达到的效果。

除此之外Lombok还有一个注解叫做 @Builder。 下面我们来看一段这样的代码:

@EqualsAndHashCode
@ToString
@AllArgsConstructor
@Getter
@Setter
@Builder
public class User {

    private String name;
    private String surname;
    private int age;

}

我们给User这个类加了一个@Builder的注解,下面我们如果想实例化这个类,你第一想到的是不是:

User user=new User;
user.setxxx();
....
....

但是现在我们可以利用@Builder注解这样生成实例:

User user = User.builder()
      .name("John")
      .surname("Doe")
      .age(32)
      .build();

怎么样,是不是很方便,这样你在生成实例的时候来呢setter方法都省得写了。

其实说了这么说,下面这个注解才是Lombok的精华:

简单的来说所有所有的注解我们都可以使用一个注解完成。 对 他就是@Data 注解。

@Data
@Builder
public class User {

    private String name;
    private String surname;
    private int age;

}

我们在定义类的时候 只需要加一个 @Data 注解,其他的注解我们都不需要在添加就可以达到前面所说的所有功能。 不相信的想伙伴可以试一试

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,383评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,522评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,852评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,621评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,741评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,929评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,076评论 3 410
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,803评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,265评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,582评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,716评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,395评论 4 333
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,039评论 3 316
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,798评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,027评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,488评论 2 361
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,612评论 2 350

推荐阅读更多精彩内容