建造者模式之Lombok中的@Builder注解

建造者模式（Builder pattern）使用场景

当一个类的构造函数参数个数超过4个，而且这些参数有些是可选的参数，考虑使用建造者模式。

1.前言

我们都知道Lombok的注解是在java代码进行编译时对代码进行构建. Lombok插件的出现, 使得开发人员无需写多余的重复代码, 对于java对象的创建更是提供了Builder方法,  使得开发人员在设计实体类的时候, 对外保持private setter, 而对属性的赋值采用Builder方式, 不对外公开属性的写操作, 这种方式更加优雅, 并且符合面向对象编程的封装原则.

2.pom.xml的引入

        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.18.10</version>
        </dependency>

3.@Builder注解的应用

import lombok.Data;
import lombok.Builder;

/**
 * 此处添加类的描述
 *
 * @Author 当我谈编程时我谈些什么
 * @Date 2021/6/17 11:45 上午
 * @Version 1.0
 */
@Builder
@Data
public class User {
  private String name;
  private Integer age;
}

public class TestUser {

  public static void main(String[] args) {
     // 使用Builder注解来创建一个User实例
    User user= User.builder().name("zhangsan").age(12).build();
    System.out.println(user);
  }
}

输出：

User(name=zhangsan, age=12)

Process finished with exit code 0

4.@Builder内部工作

先来看一下使用@Builder注解之后, User类编译后的代码:

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

    User(String name, Integer age) {
        this.name = name;
        this.age = age;
    }

    public static User.UserBuilder builder() {
        return new User.UserBuilder();
    }

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

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

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

    public static class UserBuilder {
        private String name;
        private Integer age;

        UserBuilder() {
        }

        public User.UserBuilder name(String name) {
            this.name = name;
            return this;
        }

        public User.UserBuilder age(Integer age) {
            this.age = age;
            return this;
        }

        public User build() {
            return new User(this.name, this.age);
        }

        public String toString() {
            return "User.UserBuilder(name=" + this.name + ", age=" + this.age + ")";
        }
    }
}

通过上面编译后的User类代码可以看到@Builder的内部工作结果:

1. 创建了一个名为UserBuilder的静态内部类, 并且具有和实体类相同的属性(称为构建器).

2. 在构建器中: 对于目标类中的所有的属性, 都会在构建器中创建对应的属性.

3. 在构建器中: 创建一个无参的default构造方法.

4. 在构建器中: 对于实体类中的每个参数, 都会对应创建类似于setter方法,  但是方法名是与该参数名是相同的, 并且返回值是构建器本身(便于链式调用).

5. 在构建器中:  一个build方法, 调用此方法, 就会根据设置的值进行创建对象实例.

6. 在构建器中: 同时也会生成一个toString() 方法.

7. 在构建器中: 会创建一个builder()方法, 它的目的是用来创建构建器.