Builder 设计模式 +lomok @Data @Builder @Builder.default

最新推荐文章于 2024-08-09 18:31:09 发布

dufufd

最新推荐文章于 2024-08-09 18:31:09 发布

阅读量911

点赞数

分类专栏： Java

原文链接：https://www.jianshu.com/p/e2a2fe3555b9

版权

Java 专栏收录该内容

113 篇文章 4 订阅

订阅专栏

https://www.jianshu.com/p/e2a2fe3555b9

https://www.jianshu.com/p/4e4cef2e82e1

调试代码；带注解的代码---编译后，对应的 class文件，可以一览其全身，去掉注解的源代码；

class文件搞出来---------测试代码----调试代码， debug了解其过程

Builder模式是怎么来的

不知道是哪位贤人曾经说过，存在即为合理。Builder模式在众多的框架以及android原生代码中存在（比如AlertDialog)，就一定有其价值，用来解决某些需求。

考虑这样一个场景，假如有一个类(****User****)，里面有很多属性，并且你希望这些类的属性都是不可变的(final)，就像下面的代码：

public class User {

    private final String firstName;     // 必传参数
    private final String lastName;      // 必传参数
    private final int age;              // 可选参数
    private final String phone;         // 可选参数
    private final String address;       // 可选参数
}

在这个类中，有些参数是必要的，而有些参数是非必要的。就好比在注册用户时，用户的姓和名是必填的，而年龄、手机号和家庭地址等是非必需的。那么问题就来了，如何创建这个类的对象呢？

一种可行的方案就是实用构造方法。第一个构造方法只包含两个必需的参数，第二个构造方法中，增加一个可选参数，第三个构造方法中再增加一个可选参数，依次类推，直到构造方法中包含了所有的参数。

    public User(String firstName, String lastName) {
        this(firstName, lastName, 0);
    }

    public User(String firstName, String lastName, int age) {
        this(firstName, lastName, age, "");
    }

    public User(String firstName, String lastName, int age, String phone) {
        this(firstName, lastName, age, phone, "");
    }

    public User(String firstName, String lastName, int age, String phone, String address) {
        this.firstName = firstName;
        this.lastName = lastName;
        this.age = age;
        this.phone = phone;
        this.address = address;
    }

这样做的好处只有一个：可以成功运行。但是弊端很明显：

参数较少的时候问题还不大，一旦参数多了，代码可读性就很差，并且难以维护。
对调用者来说也很麻烦。如果我只想多传一个address参数，还必需给age、phone设置默认值。而且调用者还会有这样的困惑：我怎么知道第四个String类型的参数该传address还是phone？

第二种解决办法就出现了，我们同样可以根据JavaBean的习惯，设置一个空参数的构造方法，然后为每一个属性设置setters和getters方法。就像下面一样：

public class User {

    private String firstName;     // 必传参数
    private String lastName;      // 必传参数
    private int age;              // 可选参数
    private String phone;         // 可选参数
    private String address;       // 可选参数

    public User() {
    }

    public String getFirstName() {
        return firstName;
    }

    public String getLastName() {
        return lastName;
    }

    public int getAge() {
        return age;
    }

    public String getPhone() {
        return phone;
    }

    public String getAddress() {
        return address;
    }
}

这种方法看起来可读性不错，而且易于维护。作为调用者，创建一个空的对象，然后只需传入我感兴趣的参数。那么缺点呢？也有两点：

对象会产生不一致的状态。当你想要传入5个参数的时候，你必需将所有的setXX方法调用完成之后才行。然而一部分的调用者看到了这个对象后，以为这个对象已经创建完毕，就直接食用了，其实User对象并没有创建完成。
****User****类是可变的了，不可变类所有好处都不复存在。

终于轮到主角上场的时候了，利用Builder模式，我们可以解决上面的问题，代码如下：

public class User {

    private final String firstName;     // 必传参数
    private final String lastName;      // 必传参数
    private final int age;              // 可选参数
    private final String phone;         // 可选参数
    private final String address;       // 可选参数

    private User(UserBuilder builder) {
        this.firstName = builder.firstName;
        this.lastName = builder.lastName;
        this.age = builder.age;
        this.phone = builder.phone;
        this.address = builder.address;
    }

    public String getFirstName() {
        return firstName;
    }

    public String getLastName() {
        return lastName;
    }

    public int getAge() {
        return age;
    }

    public String getPhone() {
        return phone;
    }

    public String getAddress() {
        return address;
    }

    public static class UserBuilder {
        private final String firstName;
        private final String lastName;
        private int age;
        private String phone;
        private String address;

        public UserBuilder(String firstName, String lastName) {
            this.firstName = firstName;
            this.lastName = lastName;
        }

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

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

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

        public User build() {
            return new User(this);
        }
    }
}

有几个重要的地方需要强调一下：

****User****类的构造方法是私有的。也就是说调用者不能直接创建User对象。
****User****类的属性都是不可变的。所有的属性都添加了final修饰符，并且在构造方法中设置了值。并且，对外只提供getters方法。
Builder模式使用了链式调用。可读性更佳。
Builder的内部类构造方法中只接收必传的参数，并且该必传的参数适用了final修饰符。

相比于前面两种方法，Builder模式拥有其所有的优点，而没有上述方法中的缺点。客户端的代码更容易写，并且更重要的是，可读性非常好。唯一可能存在的问题就是会产生多余的Builder对象，消耗内存。然而大多数情况下我们的Builder内部类使用的是静态修饰的(static)，所以这个问题也没多大关系。

现在，让我们看看如何创建一个User对象呢？

new User.UserBuilder("王", "小二")
                .age(20)
                .phone("123456789")
                .address("亚特兰蒂斯大陆")
                .build();

相当整洁，不是吗？你甚至可以用一行代码完成对象的创建。

关于Builder的一点说明

线程安全问题

由于Builder是非线程安全的，所以如果要在Builder内部类中检查一个参数的合法性，必需要在对象创建完成之后再检查。

public User build() {
  User user = new user(this);
  if (user.getAge() > 120) {
    throw new IllegalStateException(“Age out of range”); // 线程安全
  }
  return user;
}

上面的写法是正确的，而下面的代码是非线程安全的：

public User build() {
  if (age > 120) {
    throw new IllegalStateException(“Age out of range”); // 非线程安全
  }
  return new User(this);
}

经典的Builder模式

上面介绍的Builder模式当然不是“原生态”的啦，经典的Builder模式的类图如下：

builder

其中：

Product 产品抽象类。
Builder 抽象的Builder类。
ConcretBuilder 具体的Builder类。
Director 同一组装过程。

当然，之前实例中的Builder模式，是省略掉了Director的，这样结构更加简单。所以在很多框架源码中，涉及到Builder模式时，大多都不是经典GOF的Builder模式，而是省略后的。

作者：湫水长天
链接：https://www.jianshu.com/p/e2a2fe3555b9
来源：简书
简书著作权归作者所有，任何形式的转载都请联系作者获得授权并注明出处。

先上结论：如果类中用了@Builder注解，而属性没有任何注解话，那么在你初始化这个类的时候，如果你的属性赋值了默认值，则在你初始化该类后，属性的默认值则无效即获取会产生空指针异常

接下来我们来剖析下这中间发生了什么

image.png

      从上面的例子，可以发现Teacher 的address属性为空，这正是我们很常规初始化操作，获取这个address，接着对它进行操作，如果此时它是null，则会出现空指针异常；
      比较Student中的address则是我们理想中的正常执行过程，是有一个默认值的对象，同时观察Student中的name 和age两个属性值默认值也出现了如同Teacher中的address现象，默认值消失了；
      从表面来看，Student多了@Builder.Default的注解，这个注解确实就是解决这个问题关键，让你想要赋值的默认值来进行正确的初始化了。知道了这个注解的使用只是做到了知其然，我们要做做知其所以然，所以来看看下他们生成的class有什么区别？以下代码反编译删除了equal和hashcode方法

Teacher.class

public class Teacher {
private String name;
private List<String> address = new ArrayList();

Teacher(String name, List<String> address) {
    this.name = name;
    this.address = address;
}

public static Teacher.TeacherBuilder builder() {
    return new Teacher.TeacherBuilder();
}

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

public List<String> getAddress() {
    return this.address;
}

public void setName(String name) {
    this.name = name;
}
public void setAddress(List<String> address) {
    this.address = address;
}
protected boolean canEqual(Object other) {
    return other instanceof Teacher;
}

public String toString() {
    return "Teacher(name=" + this.getName() + ", address=" + this.getAddress() + ")";
}

public static class TeacherBuilder {
    private String name;
    private List<String> address;

    TeacherBuilder() {
    }

    public Teacher.TeacherBuilder name(String name) {
        this.name = name;
        return this;
    }

    public Teacher.TeacherBuilder address(List<String> address) {
        this.address = address;
        return this;
    }

    public Teacher build() {
        return new Teacher(this.name, this.address);
    }

    public String toString() {
        return "Teacher.TeacherBuilder(name=" + this.name + ", address=" + this.address + ")";
    }
}

Student.class

public class Student {
private String name = "c";
private int age = 25;
private long num;
private List<String> address;

private static List<String> $default$address() {
    return new ArrayList();
}

Student(String name, int age, long num, List<String> address) {
    this.name = name;
    this.age = age;
    this.num = num;
    this.address = address;
}

public static Student.StudentBuilder builder() {
    return new Student.StudentBuilder();
}

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

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

public long getNum() {
    return this.num;
}

public List<String> getAddress() {
    return this.address;
}

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

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

public void setNum(long num) {
    this.num = num;
}

public void setAddress(List<String> address) {
    this.address = address;
}
protected boolean canEqual(Object other) {
    return other instanceof Student;
}

  public String toString() {
    return "Student(name=" + this.getName() + ", age=" + this.getAge() + ", num=" + this.getNum() + ", address=" + this.getAddress() + ")";
}

public static class StudentBuilder {
    private String name;
    private int age;
    private long num;
    private boolean address$set;
    private List<String> address;

    StudentBuilder() {
    }

    public Student.StudentBuilder name(String name) {
        this.name = name;
        return this;
    }

    public Student.StudentBuilder age(int age) {
        this.age = age;
        return this;
    }

    public Student.StudentBuilder num(long num) {
        this.num = num;
        return this;
    }

    public Student.StudentBuilder address(List<String> address) {
        this.address = address;
        this.address$set = true;
        return this;
    }

    public Student build() {
        List address = this.address;
        if(!this.address$set) {
            address = Student.$default$address();
        }

        return new Student(this.name, this.age, this.num, address);
    }

    public String toString() {
        return "Student.StudentBuilder(name=" + this.name + ", age=" + this.age + ", num=" + this.num + ", address=" + this.address + ")";
    }
}

}

      看两个类的build方法，Student类在调用builde方法时，会判断this.address$set 这个变量是否为false，如果为false，则为这个address对象进行赋值默认值，这个变量就是由@Builder.Default注解产生的.
      而如果你直接对address方法进行赋值话，则会将这个this.address$set进行赋值，这样调用build方法时，就不会再对address进行赋值了.
      比较Teacher，没有对address属性增加@Builder.Default注解，所以在调用build方法时候，就不会产生判断是否要对address进行默认值的初始化了，所以你获取到的address就是null.

这下你知道你程序为什么会出现空指针异常了，为什么添加@Builder.Default注解就能解决问题了。所以对你用的东西进行深入了解，出现问题才能做到知其然知其所以然