Javers一对多关系中获取ListChange的完整对象值

本文旨在解决Javers在审计Spring Boot应用中一对多关系时，`ListChange`对象仅提供子实体引用ID而非实际对象值的问题。我们将深入探讨如何利用`javers.findShadows()`方法，结合`QueryBuilder`的精确查询能力，获取父实体及其关联子实体的完整历史快照，从而准确追溯子实体的变更前和变更后状态。

Javers一对多关系变更追踪的挑战

在使用Javers进行数据审计时，常见场景是追踪包含一对多关系（例如，父实体ParentEntity拥有多个子实体ChildEntity）的实体变更。当ChildEntity集合发生变化时，Javers会生成ListChange对象来记录这些集合操作。然而，一个常见的困扰是，这些ListChange对象在描述子实体变更时，往往只提供子实体的全局ID（GlobalId），而非子实体的完整属性值。

考虑以下Java Spring Boot实体结构：

@Entity
@Getter
@Setter
@NoArgsConstructor
class ParentEntity {

    @Id
    @GenericGenerator(name = "UUIDGenerator", strategy = "uuid2")
    @GeneratedValue(generator = "UUIDGenerator")
    @Column(name = "id", updatable = false, nullable = false)
    private UUID id;

    @Column(name = "customer_id")
    private String customerId;

    @OneToMany(mappedBy = "parentEntity", cascade = CascadeType.ALL, orphanRemoval = true)
    private List childEntity;
}

@Entity
@Getter
@Setter
class ChildEntity {

    @Id
    @GenericGenerator(name = "UUIDGenerator", strategy = "uuid2")
    @GeneratedValue(generator = "UUIDGenerator")
    @Column(name = "id", updatable = false, nullable = false)
    protected UUID id;

    @ManyToOne(fetch = FetchType.LAZY)
    private ParentEntity parentEntity;
}

当ParentEntity中的childEntity列表发生添加、删除或修改操作时，若我们使用如下查询获取变更：

javers.findChanges(QueryBuilder.byInstanceId(id, classname).withSnapshotTypeUpdate().build());

返回的ListChange对象可能包含ReferenceChange，其getLeft()和getRight()方法仅返回子实体的GlobalId，而非其实际的属性值。这使得我们难以直接从ListChange中获取子实体变更前后的完整数据。

解决方案核心：利用javers.findShadows()方法

为了获取子实体的实际值（包括变更前和变更后的版本），Javers提供了findShadows()方法。findShadows()方法用于检索对象的历史快照，即在特定提交（Commit）时的完整数据状态。这些快照被称为“Shadow”（影子对象），它们是对象在某个时间点的完整副本，包含了所有属性值，包括集合中的关联实体。

通过获取父实体在不同时间点的Shadow，我们可以对比这些Shadow中childEntity列表的内容，从而精确地识别出哪些ChildEntity被添加、删除或修改，并获取它们的完整数据。

Cursor

一个新的IDE，使用AI来帮助您重构、理解、调试和编写代码。

下载

详细操作步骤与示例代码

1. 查询父实体的历史快照

要获取包含子实体完整数据的历史快照，我们需要对父实体使用findShadows()方法。关键在于构建一个合适的QueryBuilder来筛选出我们感兴趣的快照。

import org.javers.core.Javers;
import org.javers.core.commit.CommitId;
import org.javers.core.json.JsonConverter;
import org.javers.core.metamodel.object.CdoSnapshot;
import org.javers.core.query.QueryBuilder;
import org.javers.core.shadow.Shadow;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

import java.util.List;
import java.util.Optional;
import java.util.UUID;
import java.util.stream.Collectors;

@Service
public class ParentEntityAuditService {

    private final Javers javers;

    @Autowired
    public ParentEntityAuditService(Javers javers) {
        this.javers = javers;
    }

    /**
     * 获取指定父实体在某个提交ID时的历史快照
     *
     * @param parentId 父实体ID
     * @param commitId 提交ID，用于指定获取哪个版本的快照
     * @return 包含父实体及其子实体完整数据的Shadow对象列表
     */
    public List> getParentEntityShadowsAtCommit(UUID parentId, CommitId commitId) {
        // 构建查询：
        // 1. byInstanceId(parentId, ParentEntity.class)：指定要查询的父实体实例
        // 2. withChangedPropertyIn("childEntity")：筛选在"childEntity"属性上发生过变更的父实体快照。
        //    这有助于聚焦于与子实体集合相关的历史记录。
        // 3. toCommitId(commitId)：指定获取特定提交ID的快照。
        //    若要获取某个时间段内的所有快照，可以省略此方法或使用 fromDate()/toDate()。
        List> rawShadows = javers.findShadows(
                QueryBuilder.byInstanceId(parentId, ParentEntity.class)
                        .withChangedPropertyIn("childEntity") // 仅获取childEntity属性有变化的快照
                        .toCommitId(commitId) // 获取特定提交的快照
                        .build()
        );

        // 将Shadow