
本文旨在解决Javers在审计Spring Boot应用中一对多关系时,`ListChange`对象仅提供子实体引用ID而非实际对象值的问题。我们将深入探讨如何利用`javers.findShadows()`方法,结合`QueryBuilder`的精确查询能力,获取父实体及其关联子实体的完整历史快照,从而准确追溯子实体的变更前和变更后状态。
在使用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> 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()方法。findShadows()方法用于检索对象的历史快照,即在特定提交(Commit)时的完整数据状态。这些快照被称为“Shadow”(影子对象),它们是对象在某个时间点的完整副本,包含了所有属性值,包括集合中的关联实体。
通过获取父实体在不同时间点的Shadow,我们可以对比这些Shadow中childEntity列表的内容,从而精确地识别出哪些ChildEntity被添加、删除或修改,并获取它们的完整数据。
要获取包含子实体完整数据的历史快照,我们需要对父实体使用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<Shadow<ParentEntity>> getParentEntityShadowsAtCommit(UUID parentId, CommitId commitId) {
// 构建查询:
// 1. byInstanceId(parentId, ParentEntity.class):指定要查询的父实体实例
// 2. withChangedPropertyIn("childEntity"):筛选在"childEntity"属性上发生过变更的父实体快照。
// 这有助于聚焦于与子实体集合相关的历史记录。
// 3. toCommitId(commitId):指定获取特定提交ID的快照。
// 若要获取某个时间段内的所有快照,可以省略此方法或使用 fromDate()/toDate()。
List<Shadow<Object>> rawShadows = javers.findShadows(
QueryBuilder.byInstanceId(parentId, ParentEntity.class)
.withChangedPropertyIn("childEntity") // 仅获取childEntity属性有变化的快照
.toCommitId(commitId) // 获取特定提交的快照
.build()
);
// 将Shadow<Object>转换为Shadow<ParentEntity>
return rawShadows.stream()
.filter(shadow -> shadow.get() instanceof ParentEntity)
.map(shadow -> (Shadow<ParentEntity>) shadow)
.collect(Collectors.toList());
}
/**
* 获取指定父实体在所有相关提交上的历史快照
*
* @param parentId 父实体ID
* @return 包含父实体及其子实体完整数据的Shadow对象列表
*/
public List<Shadow<ParentEntity>> getAllParentEntityShadows(UUID parentId) {
List<Shadow<Object>> rawShadows = javers.findShadows(
QueryBuilder.byInstanceId(parentId, ParentEntity.class)
.withChangedPropertyIn("childEntity") // 仅获取childEntity属性有变化的快照
.build() // 不指定toCommitId,获取所有相关快照
);
return rawShadows.stream()
.filter(shadow -> shadow.get() instanceof ParentEntity)
.map(shadow -> (Shadow<ParentEntity>) shadow)
.collect(Collectors.toList());
}
}Shadow<ParentEntity>对象包含了在特定提交时ParentEntity的完整状态,包括其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<ParentEntity> beforeChangeShadow = ...;
// Shadow<ParentEntity> afterChangeShadow = ...;
public static void analyzeChildEntityChanges(ParentEntity before, ParentEntity after) {
if (before == null || after == null) {
System.out.println("无法比较,缺少变更前或变更后数据。");
return;
}
List<ChildEntity> beforeChildren = before.getChildEntity() != null ? before.getChildEntity() : new ArrayList<>();
List<ChildEntity> afterChildren = after.getChildEntity() != null ? after.getChildEntity() : new ArrayList<>();
// 将子实体列表转换为Map,以便通过ID快速查找
Map<UUID, ChildEntity> beforeChildrenMap = beforeChildren.stream()
.collect(Collectors.toMap(ChildEntity::getId, child -> child));
Map<UUID, ChildEntity> 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实例是否相同或是否发生了修改。通常,比较所有业务相关的属性是必要的。
Javers作为一款强大的审计工具,在处理一对多关系时,虽然ListChange默认只提供引用ID,但通过灵活运用javers.findShadows()方法,我们能够获取到父实体及其关联子实体的完整历史快照。结合QueryBuilder的精确查询和手动比较Shadow中集合内容的方式,可以有效地追溯子实体的变更前和变更后状态,满足更深层次的审计和数据分析需求。理解Shadow和Change的区别,并注意性能和数据一致性,是充分发挥Javers审计能力的关键。
以上就是Javers一对多关系中获取ListChange的完整对象值的详细内容,更多请关注php中文网其它相关文章!
每个人都需要一台速度更快、更稳定的 PC。随着时间的推移,垃圾文件、旧注册表数据和不必要的后台进程会占用资源并降低性能。幸运的是,许多工具可以让 Windows 保持平稳运行。
Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号