JaVers 教程:一个对象审计和差异框架
1. 项目介绍
JaVers 是一款轻量级的 Java 库,用于审计你的数据对象的变化。它类似源代码管理系统,但是专注于跟踪应用程序中 Java 对象的变更。JaVers 提供了对象之间的比较功能,还支持将审计日志存入数据库以备后续审计。
官网:javers.org
2. 项目快速启动
安装依赖
在 Maven 工程中,添加 JaVers 的依赖到 pom.xml
文件:
<dependencies>
<dependency>
<groupId>org.javers</groupId>
<artifactId>javers-core</artifactId>
<version>最新版本号</version> <!-- 替换为实际发布的最新版本 -->
</dependency>
<dependency>
<groupId>org.javers</groupId>
<artifactId>javers-persistence-sql</artifactId>
<version>最新版本号</version> <!-- 替换为实际发布的最新版本 -->
</dependency>
</dependencies>
编写示例代码
首先,创建一个简单的对象,比如 Person
类,并初始化两个实例:
public class Person {
private String name;
private List<String> hobbies;
// getters, setters 和构造函数
}
Person personBefore = new Person("Tommy", Arrays.asList("film", "game"));
Person personAfter = new Person("ggg", Arrays.asList("game", "music", "travel"));
接下来,使用 JaVers 进行比较:
Javers javers = JaversBuilder.javers().build();
Diff diff = javers.compare(personBefore, personAfter);
System.out.println(diff.printJson());
这段代码将会打印出对象之间差异的 JSON 表述。
3. 应用案例和最佳实践
- 审计追踪:记录数据库中的数据变更历史,便于后期查询和分析。
- 回归测试:比较新旧系统处理同一输入的不同结果,确保升级后系统的正确性。
- 版本化对象:类似代码版本控制,允许回滚到某个历史版本。
最佳实践:
- 使用
@CdoClass
注解标记主实体类。 - 对于关联对象,使用
@ShallowReference
避免深度比较。 - 通过实现
EqualsAndHashCode
来自定义对象相等性检查逻辑。
4. 典型生态项目
JaVers 可与其他技术结合使用,例如:
- Spring Boot:集成 Spring 数据审计,自动持久化变更。
- Docker:在容器环境中部署 JaVers 服务。
- JPA/Hibernate:与 JPA 实体框架配合,简化数据模型的审计。
- SQL databases:如 MySQL, PostgreSQL, Oracle 支持存储审计日志。
更多详细信息及示例代码,请参考 JaVers 官方文档。