最新公告
  • 新注册用户请前往个人中心绑定邮箱以便接收相关凭证邮件!!!点击前往个人中心
  • 如何给Lombok Builder提供默认值


    1.概览

    在这个教程中,我们将研究如何基于Lombok实现 Builder模式时为属性提供默认值。
    请务必阅读这篇Lombok简介 。

    2.Maven依赖

    在本教程中,我们将使用Lombok ,因此,需要添加一个Maven依赖:
    1. <dependency>
    2.    <groupId>org.projectlombok</groupId>
    3.    <artifactId>lombok</artifactId>
    4.    <version>1.16.18</version>
    5.    <scope>provided</scope>
    6. </dependency>

    3.基于Lombok Builder的POJO

    首先,让我们看看 Lombok如何帮助我们从实现 Builder模式所需的样板代码中解脱出来。 我们将从一个简单的 POJO开始:
    1. publicclassPojo{
    2.    privateString name;
    3.    privateboolean original;
    4. }
    为了使这个类可用,我们需要给每个字段实现一个getter。另外,如果希望将这个类用于ORM,我们可能需要一个默认构造函数。
    除了这些,我们还需要一个用于构建这个POJOBuilder类。有了Lombok,我们就可以通过一些简单的注解来实现上面这样功能了:
    1. @Getter
    2. @Builder
    3. @NoArgsConstructor
    4. @AllArgsConstructor
    5. publicclassPojo{
    6.    privateString name;
    7.    privateboolean original;
    8. }

    4.期望的效果

    让我们以单元测试的形式来定义想要达到的效果。
    最重要,也是最基本的要求是使用builder方法构建对象之后要有默认值:
    1. @Test
    2. publicvoid givenBuilderWithDefaultValue_ThenDefaultValueIsPresent(){
    3.    Pojo build =Pojo.builder()
    4.        .build();
    5.    Assert.assertEquals("foo", build.getName());
    6.    Assert.assertTrue(build.isOriginal());
    7. }
    当然,这个测试用例肯定会失败,因为@Builder注解并不会给属性赋默认值。 稍后,我们会让测试通过。 如果使用了依赖默认构造函数的ORM框架,那么我们应该先从默认构造函数开始:
    1. @Test
    2. publicvoid givenBuilderWithDefaultValue_NoArgsWorksAlso(){
    3.    Pojo build =Pojo.builder()
    4.        .build();
    5.    Pojo pojo =newPojo();
    6.    Assert.assertEquals(build.getName(), pojo.getName());
    7.    Assert.assertTrue(build.isOriginal()== pojo.isOriginal());
    8. }
    在这个阶段,这个测试用例通过了,因为都没有默认值。 现在,让我们看看如何让这两个测试用例都通过!

    5.LombokBuilder.Default注解

    自从Lombokv1.16.16之后,我们就可以使用@Builder.Default注解:
    1. // 添加在类上的注解同上
    2. publicclassPojo{
    3.    @Builder.Default
    4.    privateString name ="foo";
    5.    @Builder.Default
    6.    privateboolean original =true;
    7. }
    这个注解简单易读,但也有一些缺陷。
    有了这个注解,默认值将将与构造函数一起出现,那么第一个测试用例将通过。不幸的是,由于@NoArgsConstructor不会得到默认值,因此第二个测试用例失败了。即使无参构造函数不是 Lombok自动生成而是显式编写的,也取不到默认值。
    Builder.Default注解的这种副作用从一开始就有,可能还会持续很长时间。

    6.初始化Builder

    为了让这两个测试用例通过,我们可以尝试通过在一个极简的Builder中定义默认值:
    1. // 添加在类上的注解同上
    2. publicclassPojo{
    3.    privateString name ="foo";
    4.    privateboolean original =true;

    5.    publicstaticclassPojoBuilder{
    6.        privateString name ="foo";
    7.        privateboolean original =true;
    8.    }
    9. }
    通过这种方式,这两个测试用例都通过了。 很不幸,代价是代码重复。对于具有数十个属性的POJO,维护双重初始化可能会出错。
    但是,如果愿意付出这个代价,我们还应该注意一件事。如果我们使用IDE中的重构功能来重命名类,静态内部类将不会自动重命名。这样,Lombok就找不到它了,我们的代码就出错了。
    为了消除这种风险,我们可以再配置一下Builder注解:
    1. // 添加在类上的注解同上
    2. @Builder(builderClassName ="PojoBuilder")
    3. publicclassPojo{
    4.    privateString name ="foo";
    5.    privateboolean original =true;

    6.    publicstaticclassPojoBuilder{
    7.        privateString name ="foo";
    8.        privateboolean original =true;
    9.    }
    10. }

    7.使用toBuilder参数

    @Builder还支持在原始类的实例中生成一个Builder实例。默认情况下这个特性是关闭的。我们可以通过在Builder注解中配置toBuilder参数来启用:
    1. // class annotations as before
    2. // 添加在类上的注解同上
    3. @Builder(toBuilder =true)
    4. publicclassPojo{
    5.    privateString name ="foo";
    6.    privateboolean original =true;
    7. }
    这样,我们就可以避免*双重初始化 *
    当然,这也是有代价的。我们必须通过 实例化这个类来创建一个Builder实例。因此,相关的测试用例也必须修改:
    1. @Test
    2. publicvoid givenBuilderWithDefaultValue_ThenDefaultValueIsPresent(){
    3.    Pojo build =  newPojo().toBuilder()
    4.        .build();
    5.    Assert.assertEquals("foo", build.getName());
    6.    Assert.assertTrue(build.isOriginal());
    7. }

    8. @Test
    9. publicvoid givenBuilderWithDefaultValue_thenNoArgsWorksAlso(){
    10.    Pojo build =newPojo().toBuilder()
    11.        .build();
    12.    Pojo pojo =newPojo();
    13.    Assert.assertEquals(build.getName(), pojo.getName());
    14.    Assert.assertTrue(build.isOriginal()== pojo.isOriginal());
    15. }
    同样,这两个测试用例会全部通过。因此使用无参构造函数与使用Builder具有相同的默认值。

    8.总结

    至此,我们已经展示了为Lombok Builder提供默认值的几种方法。
    Builder.Default注解的副作用也很明显。但是,其他几个方案也有缺点。所以我们必须结合自身情况谨慎选择。
    照例,文中用到的代码都可以在 GitHub上找到。
    本站所有文章均由网友分享,仅用于参考学习用,请勿直接转载,如有侵权,请联系网站客服删除相关文章。若由于商用引起版权纠纷,一切责任均由使用者承担
    极客文库 » 如何给Lombok Builder提供默认值

    常见问题FAQ

    如果资源链接失效了怎么办?
    本站用户分享的所有资源都有自动备份机制,如果资源链接失效,请联系本站客服QQ:2580505920更新资源地址。
    如果用户分享的资源与描述不符怎么办?
    可以联系客服QQ:2580505920,如果要求合理可以安排退款或者退赞助积分。
    如何分享个人资源获取赞助积分或其他奖励?
    本站用户可以分享自己的资源,但是必须保证资源没有侵权行为。点击个人中心,根据操作填写并上传即可。资源所获收益完全归属上传者,每周可申请提现一次。
    如果您发现了本资源有侵权行为怎么办?
    及时联系客服QQ:2580505920,核实予以删除。

    参与讨论

    • 155会员总数(位)
    • 3735资源总数(个)
    • 0本周发布(个)
    • 0 今日发布(个)
    • 382稳定运行(天)

    欢迎加入「极客文库」,成为原创作者从这里开始!

    立即加入 了解更多
    成为赞助用户享有更多特权立即升级