Lombok@Builder高级用法：不可变对象与复制技巧

本文深入解析 Lombok 中 `@Builder` 注解的高级用法，重点介绍 `toBuilder=true` 参数在处理不可变对象时的妙用。当需要基于现有对象修改部分属性时，`toBuilder` 能够生成一个预填充了原对象属性的 Builder 实例，开发者可以通过链式调用修改特定字段，最终构建出一个全新的对象，而无需修改原始对象。这种方式完美契合了不可变对象的特性，避免了传统 Setter 方法带来的可变性问题。通过示例代码，清晰展示了如何利用 `toBuilder` 实现对象的“复制并修改”，并强调了其在构建健壮、可维护的应用中的重要性，尤其是在函数式编程范式下。

本文将深入探讨 Lombok 的 @Builder 注解的一个高级特性：如何在不直接修改现有对象的情况下，通过创建新的 Builder 实例来实现“复制并修改”对象的需求。这对于处理不可变（Immutable）对象尤其有效，它允许开发者基于现有对象的值生成一个预填充的 Builder，然后仅修改特定字段以构建一个新的对象实例，从而避免了传统 Setter 带来的可变性问题。

@Builder 的基本作用与进阶需求

Lombok 的 @Builder 注解极大地简化了复杂对象的创建过程，通过提供链式调用的 Builder 模式，使得对象实例化更加清晰和安全。然而，当面临需要“修改”一个已创建对象的需求时，开发者可能会疑惑 @Builder 是否也能派上用场。传统的做法是使用 Setter 方法，但这通常意味着对象是可变的，这与函数式编程或构建不可变对象的设计理念相悖。直接使用 @Builder 创建新对象，虽然可以达到修改部分字段的目的，但如果需要保留大部分现有字段的值，则需要手动复制这些值，这无疑增加了冗余。

解决方案：@Builder(toBuilder=true) 实现“复制并修改”

Lombok 针对这一需求提供了优雅的解决方案：在 @Builder 注解中设置 toBuilder=true 参数。当一个类被 @Builder(toBuilder=true) 注解时，Lombok 会为该类自动生成一个名为 toBuilder() 的方法。

这个 toBuilder() 方法的作用是：

1. 它不是直接修改原对象。
2. 它会基于当前对象的所有字段值，创建一个新的 Builder 实例。
3. 这个新的 Builder 实例已经预填充了当前对象的所有属性值。

开发者可以在这个预填充的 Builder 上，像创建新对象一样，链式调用 Builder 的 Setter 方法来修改（或覆盖）特定的字段值，最终通过 build() 方法生成一个全新的对象实例。这个新对象拥有原对象的大部分属性，但特定被修改的属性则反映了新的值。

示例代码

让我们通过一个具体的例子来演示这一机制：

import lombok.Builder;
import lombok.Value;

/**
 * 示例类 A，使用 @Value 和 @Builder(toBuilder=true)
 * @Value 确保对象不可变，@Builder 提供构建器，toBuilder=true 提供复制构建器能力
 */
@Value // @Value 自动生成 final 字段、getter、equals/hashCode/toString，并默认使对象不可变
@Builder(toBuilder = true) // 启用 Builder 模式，并允许通过 toBuilder() 方法创建新的 Builder
public class A {
    String name;
    long value;
}

现在，我们来看如何使用这个类来创建对象并进行“修改”：

public class BuilderModificationDemo {
    public static void main(String[] args) {
        // 1. 使用 Builder 创建初始对象
        var a = A.builder()
                .name("test-name")
                .value(1234L)
                .build();
        System.out.println("原始对象 a: " + a);

        // 2. 使用 toBuilder() 方法从对象 a 创建一个新的 Builder
        //    然后修改其中的 value 字段，构建一个新的对象 b
        var b = a.toBuilder() // 获取一个预填充了 a 所有值的 Builder
                .value(4321L) // 修改 Builder 中的 value 字段
                .build();     // 构建新的对象 b
        System.out.println("修改后的新对象 b: " + b);

        // 验证原始对象 a 是否被修改（结果证明没有被修改）
        System.out.println("再次检查原始对象 a: " + a);
    }
}

运行上述代码，将得到如下输出：

原始对象 a: A(name=test-name, value=1234)
修改后的新对象 b: A(name=test-name, value=4321)
再次检查原始对象 a: A(name=test-name, value=1234)

从输出可以看出，对象 a 的 name 字段值保持不变，而 value 字段的值在对象 b 中被成功“修改”了。最重要的是，原始对象 a 并没有被改变，这完美地支持了不可变对象的特性。

注意事项与最佳实践

• 创建新对象，而非修改旧对象： 务必理解 toBuilder() 方法及其后续操作是创建了一个全新的对象实例。原始对象保持不变。这是实现不可变性的核心。
• 适用于不可变对象： 这种模式与不可变对象（Immutable Objects）的设计理念高度契合。当一个对象一旦创建就不能被修改时（例如使用 @Value 或手动将字段声明为 final），toBuilder() 提供了一种安全、函数式的“修改”方式。
• 避免与 Setter 混淆： 如果你的类是可变的，并且已经提供了 Setter 方法，那么 toBuilder() 模式可能不是必需的。但即使是可变类，使用 toBuilder() 也能提供一种更清晰、更安全的批量更新字段的方式，尤其是在需要部分更新且希望保持链式调用的场景下。
• 性能考量： 每次调用 toBuilder().build() 都会创建新的对象。对于极度性能敏感的场景，需要权衡对象创建的开销。然而，在大多数业务应用中，这种开销通常可以忽略不计。
• Lombok 文档： 深入了解 Lombok 的 @Builder 和 @Value 特性，可以查阅官方文档以获取更多详细信息和高级用法。

总结

Lombok 的 @Builder(toBuilder=true) 特性提供了一种强大的机制，用于在保持对象不可变性的前提下，实现“复制并修改”对象的需求。它通过生成 toBuilder() 方法，允许开发者基于现有对象的值快速构建一个新的 Builder，然后对特定字段进行修改，最终生成一个全新的、具有所需更新属性的对象。这种模式在构建健壮、可维护的应用程序时，尤其是在处理不可变数据结构和采用函数式编程范式时，显得尤为重要和实用。

文中关于的知识介绍，希望对你的学习有所帮助！若是受益匪浅，那就动动鼠标收藏这篇《Lombok@Builder高级用法：不可变对象与复制技巧》文章吧，也可关注golang学习网公众号了解相关技术文章。