Lombok中关于@Data的使用解析

下面就来详细讲解一下"Lombok中关于@Data的使用解析"的完整攻略。

1. 什么是Lombok？

Lombok是一种Java库，它通过注解的方式来简化Java代码的编写。使用Lombok库可以避免写很多样板代码，减少代码的臃肿程度，同时提高代码的可读性和可维护性。在使用Lombok之前，需要先在项目的pom.xml中加入lombok的依赖：

<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <version>${lombok.version}</version>
    <scope>provided</scope>
</dependency>

1. @Data注解的作用

@Data是Lombok库中最为常用的注解之一，它可以自动生成Java bean中的getter、setter、toString、equals和hashCode方法，大幅度减少样板代码的编写。我们可以使用@Data注解来标记Java类，然后Lombok自动生成相应的getter、setter、toString、equals和hashCode方法。

1. @Data的使用示例

下面是两个使用@Data注解的示例：

(1)示例一：使用@Data注解来标记Java类

import lombok.Data;

@Data
public class User {
    private Long id;
    private String name;
    private Integer age;
}

使用@Data注解来标记Java类User，Lombok自动生成了如下的代码：

public class User {
    private Long id;
    private String name;
    private Integer age;

    public Long getId() {
        return this.id;
    }

    public void setId(Long id) {
        this.id = id;
    }

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

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

    public Integer getAge() {
        return this.age;
    }

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

    @Override
    public String toString() {
        return "User(id=" + this.getId() + ", name=" + this.getName() + ", age=" + this.getAge() + ")";
    }

    @Override
    public boolean equals(Object o) {
        if (o == this) {
            return true;
        }
        if (!(o instanceof User)) {
            return false;
        }
        User other = (User) o;
        if (!other.canEqual((Object) this)) {
            return false;
        }
        Object this$id = this.getId();
        Object other$id = other.getId();
        if (this$id == null ? other$id != null : !this$id.equals(other$id)) {
            return false;
        }
        Object this$name = this.getName();
        Object other$name = other.getName();
        if (this$name == null ? other$name != null : !this$name.equals(other$name)) {
            return false;
        }
        Object this$age = this.getAge();
        Object other$age = other.getAge();
        if (this$age == null ? other$age != null : !this$age.equals(other$age)) {
            return false;
        }
        return true;
    }

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

    @Override
    public int hashCode() {
        int result = 1;
        Object $id = this.getId();
        result = result * 59 + ($id == null ? 43 : $id.hashCode());
        Object $name = this.getName();
        result = result * 59 + ($name == null ? 43 : $name.hashCode());
        Object $age = this.getAge();
        result = result * 59 + ($age == null ? 43 : $age.hashCode());
        return result;
    }
}

使用@Data注解可以看到，Lombok自动帮我们实现了类中的常见方法。

(2)示例二：使用@Data注解来生成builder

import lombok.Builder;
import lombok.Data;

@Data
@Builder
public class Book {
    private Long id;
    private String name;
    private String author;
    private Integer pagesNum;
}

在这个示例中，除了使用@Data注解外，我们还使用了@Builder注解。这个注解会自动生成一个静态内部类Builder和一个toBuilder方法。

/**
 * 生成的静态内部类Builder
 */
public static class Builder {
    private Long id;
    private String name;
    private String author;
    private Integer pagesNum;

    Builder() {
    }

    public Book.Builder id(Long id) {
        this.id = id;
        return this;
    }

    public Book.Builder name(String name) {
        this.name = name;
        return this;
    }

    public Book.Builder author(String author) {
        this.author = author;
        return this;
    }

    public Book.Builder pagesNum(Integer pagesNum) {
        this.pagesNum = pagesNum;
        return this;
    }

    public Book build() {
        return new Book(this.id, this.name, this.author, this.pagesNum);
    }

    public String toString() {
        return "Book.BookBuilder(id=" + this.id + ", name=" + this.name + ", author=" + this.author + ", pagesNum=" + this.pagesNum + ")";
    }
}

/**
 * 生成的toBuilder方法
 * @return Builder对象
 */
public static Book.Builder builder() {
    return new Book.Builder();
}

使用@Builder注解生成builder，可以方便地构造对象。例如：

Book book = Book.builder().id(1L).name("Thinking in Java").author("Bruce Eckel").pagesNum(1793).build();

这里，我们通过Book.builder().id(1L).name("Thinking in Java").author("Bruce Eckel").pagesNum(1793).build()来创建一个对象。

1. 总结

本文详细介绍了Lombok库中最为常用的注解@Data的使用。通过使用@Data注解，能够自动生成getter、setter、toString、equals和hashCode方法，减少Java代码的编写工作。我们通过两个示例来说明@Data注解的具体用法，他们分别是：标记Java类并自动生成gette、setter、toString、equals和hashCode方法以及使用@Data注解来生成builder方法。