本文旨在解决Javers在审计Spring Boot应用中一对多关系时，`ListChange`对象仅提供子实体引用ID而非实际对象值的问题。我们将深入探讨如何利用`javers.findShadows()`方法，结合`QueryBuilder`的精确查询能力，获取父实体及其关联子实体的完整历史快照，从而准确追溯子实体的变更前和变更后状态。
Javers一对多关系变更追踪的挑战
在使用Javers进行数据审计时，常见场景是追踪包含一对多关系（例如，父实体ParentEntity拥有多个子实体ChildEntity）的实体变更。当ChildEntity集合发生变化时，Javers会生成ListChange对象来记录这些集合操作。然而，一个常见的困扰是，这些ListChange对象在描述子实体变更时，往往只提供子实体的全局ID（GlobalId），而非子实体的完整属性值。
考虑以下Java Spring Boot实体结构：
@Entity@Getter@Setter@NoArgsConstructorclass 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@Setterclass 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被添加、删除或修改，并获取它们的完整数据。
Vizard
AI驱动的视频编辑器
101 查看详情 
详细操作步骤与示例代码
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;@Servicepublic 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<Shadow> getParentEntityShadowsAtCommit(UUID parentId, CommitId commitId) { // 构建查询： // 1. byInstanceId(parentId, ParentEntity.class)：指定要查询的父实体实例 // 2. withChangedPropertyIn("childEntity")：筛选在"childEntity"属性上发生过变更的父实体快照。 // 这有助于聚焦于与子实体集合相关的历史记录。 // 3. toCommitId(commitId)：指定获取特定提交ID的快照。 // 若要获取某个时间段内的所有快照，可以省略此方法或使用 fromDate()/toDate()。 List<Shadow
2. 解析Shadow对象以获取变更前后数据
Shadow对象包含了在特定提交时ParentEntity的完整状态，包括其childEntity列表。要获取子实体的“变更前”和“变更后”数据，通常需要以下步骤：
确定相关提交： 首先，您需要确定发生变更的提交ID。可以通过javers.findChanges()获取ListChange，其中会包含commitMetadata，从而得知变更发生在哪个提交。获取两个相邻的Shadow： 查找在目标变更提交之前的最近一个ParentEntity的Shadow，以及在目标变更提交之后（或在目标变更提交本身）的ParentEntity的Shadow。比较childEntity列表： 比较这两个Shadow中的childEntity列表，以识别出具体被添加、删除或修改的ChildEntity实例。
以下是一个简化的伪代码示例，展示如何比较两个ParentEntity快照的childEntity列表：
import java.util.ArrayList;import java.util.HashMap;import java.util.List;import java.util.Map;import java.util.UUID;import java.util.stream.Collectors;public class ShadowComparisonExample { // 假设我们已经获取了两个ParentEntity的Shadow对象 // Shadow beforeChangeShadow = ...; // Shadow afterChangeShadow = ...; public static void analyzeChildEntityChanges(ParentEntity before, ParentEntity after) { if (before == null || after == null) { System.out.println("无法比较，缺少变更前或变更后数据。"); return; } List beforeChildren = before.getChildEntity() != null ? before.getChildEntity() : new ArrayList(); List afterChildren = after.getChildEntity() != null ? after.getChildEntity() : new ArrayList(); // 将子实体列表转换为Map，以便通过ID快速查找 Map beforeChildrenMap = beforeChildren.stream() .collect(Collectors.toMap(ChildEntity::getId, child -> child)); Map afterChildrenMap = afterChildren.stream() .collect(Collectors.toMap(ChildEntity::getId, child -> child)); System.out.println("--- 分析子实体变更 ---"); // 查找被删除的子实体 beforeChildrenMap.forEach((id, child) -> { if (!afterChildrenMap.containsKey(id)) { System.out.println("删除的子实体: " + child.getId() + " (原数据: " + child + ")"); } }); // 查找被添加或修改的子实体 afterChildrenMap.forEach((id, child) -> { if (!beforeChildrenMap.containsKey(id)) { System.out.println("添加的子实体: " + child.getId() + " (新数据: " + child + ")"); } else { // 如果子实体ID存在于变更前后，则可能被修改 ChildEntity oldChild = beforeChildrenMap.get(id); if (!oldChild.equals(child)) { // 需要ChildEntity正确实现equals和hashCode方法 System.out.println("修改的子实体: " + child.getId() + " (原数据: " + oldChild + ", 新数据: " + child + ")"); } } }); System.out.println("--------------------"); } // 为了示例，这里需要一个ChildEntity的equals和hashCode实现 // @Override // public boolean equals(Object o) { // if (this == o) return true; // if (o == null || getClass() != o.getClass()) return false; // ChildEntity that = (ChildEntity) o; // return Objects.equals(id, that.id) && // Objects.equals(someOtherProperty, that.someOtherProperty); // 比较所有相关属性 // } // // @Override // public int hashCode() { // return Objects.hash(id, someOtherProperty); // }}
注意： 上述比较逻辑依赖于ChildEntity正确实现了equals()和hashCode()方法，以便能够准确判断两个ChildEntity实例是否相同或是否发生了修改。通常，比较所有业务相关的属性是必要的。
注意事项与最佳实践
理解Shadow与Change的区别：Change对象（如ListChange、ValueChange）描述了什么发生了变化以及如何变化的（例如，集合中添加了一个引用ID）。Shadow对象则提供了在特定时间点上整个对象图的完整数据状态。当需要获取实际数据值时，Shadow是更强大的工具。性能考量： findShadows()会加载整个对象图的快照。对于包含大量子实体或复杂关联关系的大型父实体，频繁或不加限制地查询Shadow可能会带来性能开销。建议：使用withChangedPropertyIn()来缩小查询范围，只关注特定属性的变更。使用toCommitId()、fromCommitId()、fromDate()、toDate()等方法精确限定查询的时间或版本范围。考虑对Javers的历史数据进行归档或清理，以控制数据库大小。数据一致性： Javers通过对象的ID来识别集合中的元素。在比较Shadow时，确保您的实体ID是稳定且唯一的，这是正确识别变更的基础。错误处理和空值检查： 在处理Shadow对象及其内部属性时，始终进行必要的空值检查，以避免NullPointerException。ChildEntity的equals()和hashCode()： 正确实现ChildEntity的equals()和hashCode()方法对于比较两个ChildEntity实例是否相同至关重要，尤其是在自定义比较逻辑中。
总结
Javers作为一款强大的审计工具，在处理一对多关系时，虽然ListChange默认只提供引用ID，但通过灵活运用javers.findShadows()方法，我们能够获取到父实体及其关联子实体的完整历史快照。结合QueryBuilder的精确查询和手动比较Shadow中集合内容的方式，可以有效地追溯子实体的变更前和变更后状态，满足更深层次的审计和数据分析需求。理解Shadow和Change的区别，并注意性能和数据一致性，是充分发挥Javers审计能力的关键。
以上就是Javers一对多关系中获取ListChange的完整对象值的详细内容，更多请关注创想鸟其它相关文章！
版权声明：本文内容由互联网用户自发贡献，该文观点仅代表作者本人。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。
如发现本站有涉嫌抄袭侵权/违法违规的内容， 请发送邮件至 chuangxiangniao@163.com 举报，一经查实，本站将立刻删除。
发布者：程序猿，转转请注明出处：https://www.chuangxiangniao.com/p/870893.html
微信扫一扫 
支付宝扫一扫 
