Lombok @SuperBuilder 在继承结构中正确构建与显示父类属性

本教程旨在解决使用lombok `@superbuilder` 构建继承体系时，子类对象在打印时未能显示父类属性的常见误解。我们将深入探讨`@superbuilder`如何实现跨继承链的构建器模式，并重点说明通过在子类上添加`@tostring(callsuper=true)`注解，来确保`tostring()`方法能够正确包含并显示所有继承自父类的属性，从而提供完整的对象表示。

理解 Lombok @SuperBuilder 与继承

Lombok 的 @SuperBuilder 注解是 @Builder 的一个增强版本，专门用于处理类继承体系中的构建器模式。当一个类继承自另一个也使用了 @SuperBuilder 的类时，子类的构建器将能够访问并设置父类的所有属性。这使得在创建子类实例时，可以统一地通过一个构建器链来设置所有层次的属性，极大地简化了代码。

然而，开发者在使用 @SuperBuilder 构建对象后，可能会遇到一个看似“父类属性未被继承”的问题，尤其是在打印子类对象时。这并非属性未被继承，而是默认的 toString() 方法行为所致。

考虑以下类结构：

import lombok.Data;
import lombok.EqualsAndHashCode;
import lombok.experimental.SuperBuilder;

// 父类
@Data
@SuperBuilder
public class CParent {
    protected Integer parentId;
}

// 子类
@Data
@SuperBuilder
@EqualsAndHashCode(callSuper = true)
public class CChild extends CParent {
    protected String childId;
}

// 包含 CParent 类型的组合类
@Data
@SuperBuilder
public class CHouse {
    String address;
    String description;
    CParent parent; // 可以是 CParent 或其子类 CChild
}

按照上述定义，我们尝试构建一个 CChild 对象并将其赋值给 CHouse：

public class Main {
    public static void main(String[] args) {
        // 构建 CChild 实例
        CChild child = CChild.builder()
            .parentId(123) // 设置父类属性
            .childId("789") // 设置子类属性
            .build();

        // 构建 CHouse 实例，并传入 CChild 对象
        CHouse house = CHouse.builder()
            .address("address")
            .description("description")
            .parent(child)
            .build();

        System.out.println("CChild object: " + child);
        System.out.println("CHouse object: " + house);
    }
}

在上述代码中，当我们运行 Main 方法并打印 child 对象时，预期输出可能是 CChild(childId=789, parentId=123)。然而，实际输出可能仅显示 CChild(childId=789)，导致开发者误认为 parentId 未被正确设置或继承。

问题现象分析：toString() 的默认行为

出现上述现象的原因在于 Lombok 的 @Data 注解。@Data 是一个复合注解，它包含了 @ToString、@EqualsAndHashCode、@Getter、@Setter 和 @RequiredArgsConstructor。当 @Data 应用于一个类时，Lombok 会自动生成这些方法的实现。

对于 toString() 方法，默认生成的实现不会自动包含父类的属性。这意味着，即使 CChild 实例内部确实拥有 parentId 的值，其默认的 toString() 方法也只会打印 CChild 类自身定义的属性（即 childId）。因此，parentId 实际上已经被正确继承和设置，只是在对象被打印时没有被显示出来。

LanguagePro

LanguagePro是一款强大的AI写作助手，可以帮助你更好、更快、更有效地写作。

120

查看详情

解决方案：使用 @ToString(callSuper=true)

要解决这个问题，确保 toString() 方法能够完整地显示所有继承自父类的属性，我们需要在子类上明确指定 @ToString(callSuper=true)。这个参数会指示 Lombok 在生成 toString() 方法时，首先调用父类的 toString() 方法，然后将父类的输出与子类的输出合并。

修正后的类定义如下：

import lombok.Data;
import lombok.EqualsAndHashCode;
import lombok.ToString; // 引入 ToString
import lombok.experimental.SuperBuilder;

// 父类
@Data
@SuperBuilder
public class CParent {
    protected Integer parentId;
}

// 子类 - 关键修改：添加 @ToString(callSuper = true)
@Data
@SuperBuilder
@EqualsAndHashCode(callSuper = true) // 确保 equals 和 hashCode 也包含父类属性
@ToString(callSuper = true) // 确保 toString 包含父类属性
public class CChild extends CParent {
    protected String childId;
}

// 包含 CParent 类型的组合类
@Data
@SuperBuilder
public class CHouse {
    String address;
    String description;
    CParent parent;
}

现在，当我们再次运行 Main 方法：

public class Main {
    public static void main(String[] args) {
        CChild child = CChild.builder()
            .parentId(123)
            .childId("789")
            .build();

        CHouse house = CHouse.builder()
            .address("address")
            .description("description")
            .parent(child)
            .build();

        System.out.println("CChild object: " + child);
        System.out.println("CHouse object: " + house);
    }
}

输出将符合预期：

CChild object: CChild(super=CParent(parentId=123), childId=789)
CHouse object: CHouse(address=address, description=description, parent=CChild(super=CParent(parentId=123), childId=789))

这明确表明 parentId 属性已被 CChild 实例正确继承和赋值，并且在打印时也得到了完整的显示。

注意事项与最佳实践

1. @SuperBuilder 的正确使用: 确保继承链中的所有类（父类和子类）都使用 @SuperBuilder。如果父类没有 @SuperBuilder，子类就无法通过构建器设置父类的属性。
2. @EqualsAndHashCode(callSuper=true): 当你希望子类的 equals() 和 hashCode() 方法在比较对象时，也考虑父类的属性，务必在子类上添加 @EqualsAndHashCode(callSuper=true)。否则，即使父类属性不同，两个子类对象也可能被认为是相等的。
3. @ToString(callSuper=true): 如本教程所示，为了在打印子类对象时显示完整的属性信息（包括父类属性），请在子类上使用 @ToString(callSuper=true)。
4. @Data 与 callSuper: 记住 @Data 包含了 @ToString 和 @EqualsAndHashCode。因此，当你使用 @Data 时，若要实现 callSuper=true 的效果，你需要显式地在子类上添加 @EqualsAndHashCode(callSuper=true) 和 @ToString(callSuper=true)，它们会覆盖 @Data 默认生成的无 callSuper 行为。
5. 多层继承: 在多层继承链中，例如 GrandChild extends Child extends Parent，每个子类都需要添加 callSuper=true 到 @EqualsAndHashCode 和 @ToString，以确保所有上层父类的属性都被考虑在内。

总结

Lombok 的 @SuperBuilder 是一个强大的工具，能够优雅地处理 Java 中的构建器模式与继承。当遇到子类对象打印时父类属性“丢失”的情况，这通常不是属性未被继承，而是 toString() 方法的默认行为所致。通过在子类上显式添加 @ToString(callSuper=true)，我们可以确保 toString() 方法能够递归地包含所有父类的属性，从而提供对象状态的完整且准确的字符串表示。理解并正确应用这些 Lombok 注解的 callSuper 参数，对于构建健壮且易于调试的 Java 应用程序至关重要。

以上就是Lombok @SuperBuilder 在继承结构中正确构建与显示父类属性的详细内容，更多请关注php中文网其它相关文章！