如何快速上手JaVers？5分钟搭建Java对象变更审计系统

吴铎根

554人浏览 · 2026-02-15 03:42:44

吴铎根 · 2026-02-15 03:42:44 发布

如何快速上手JaVers？5分钟搭建Java对象变更审计系统

【免费下载链接】javers JaVers - object auditing and diff framework for Java 项目地址: https://gitcode.com/gh_mirrors/ja/javers

JaVers是一款强大的Java对象审计和差异框架，能够帮助开发者轻松跟踪对象的变更历史，实现数据的版本控制和审计追踪。通过简单的配置，你可以在项目中快速集成JaVers，为你的应用添加可靠的对象变更记录功能。

🚀 1. 环境准备与依赖添加

要开始使用JaVers，首先需要在你的项目中添加相应的依赖。根据你使用的构建工具，选择以下方式添加依赖：

Maven项目

在pom.xml中添加：

<dependency>
    <groupId>org.javers</groupId>
    <artifactId>javers-core</artifactId>
    <version>6.9.0</version>
</dependency>

Gradle项目

在build.gradle中添加：

implementation 'org.javers:javers-core:6.9.0'

🔧 2. 快速初始化JaVers实例

JaVers提供了简洁的构建器模式，让你可以快速创建实例。最基本的初始化方式如下：

import org.javers.core.Javers;
import org.javers.core.JaversBuilder;

public class JaversExample {
    public static void main(String[] args) {
        // 创建基本的JaVers实例
        Javers javers = JaversBuilder.javers().build();
        System.out.println("JaVers实例初始化成功！");
    }
}

对于需要持久化存储审计数据的场景，可以注册相应的存储库，例如使用内存存储：

Javers javers = JaversBuilder.javers()
    .registerJaversRepository(new InMemoryRepository())
    .build();

🏷️ 3. 标记需要审计的对象

JaVers使用注解来标识需要审计的实体和值对象，主要注解包括：

@Entity - 标识实体对象

用于标记具有唯一标识的持久化对象：

import org.javers.core.metamodel.annotation.Entity;
import org.javers.core.metamodel.annotation.Id;

@Entity
public class User {
    @Id
    private Long id;
    private String name;
    private String email;
    
    // 构造函数、getter和setter省略
}

@ValueObject - 标识值对象

用于标记没有唯一标识的组合对象：

import org.javers.core.metamodel.annotation.ValueObject;

@ValueObject
public class Address {
    private String street;
    private String city;
    private String zipCode;
    
    // 构造函数、getter和setter省略
}

✅ 4. 执行对象审计操作

初始化JaVers并标记对象后，就可以开始执行审计操作了。主要包括对象的提交和变更查询。

提交对象变更

// 创建用户对象
User user = new User(1L, "John Doe", "john@example.com");

// 首次提交
javers.commit("admin", user);

// 修改用户信息
user.setName("John Smith");
user.setEmail("john.smith@example.com");

// 再次提交变更
javers.commit("admin", user);

查询对象变更历史

import org.javers.core.changelog.ChangeLog;
import org.javers.core.changelog.SimpleTextChangeLog;
import org.javers.core.metamodel.object.GlobalId;

// 获取用户的变更历史
GlobalId userGlobalId = javers.getIdFactory().createId(user);
ChangeLog changeLog = javers.findChanges(
    QueryBuilder.byInstanceId(user.getId(), User.class).build()
);

// 打印变更日志
System.out.println(SimpleTextChangeLog.format(changeLog));

💾 5. 集成持久化存储

JaVers支持多种持久化存储方案，包括：

内存存储：适合测试环境
关系型数据库：通过javers-persistence-sql模块
MongoDB：通过javers-persistence-mongo模块
Redis：通过javers-persistence-redis模块

以MongoDB为例，添加依赖后配置：

import org.javers.repository.mongo.MongoRepository;
import com.mongodb.MongoClient;

MongoClient mongoClient = new MongoClient("localhost", 27017);
MongoRepository mongoRepository = new MongoRepository(mongoClient, "myDatabase");

Javers javers = JaversBuilder.javers()
    .registerJaversRepository(mongoRepository)
    .build();

📊 审计结果展示

JaVers提供了多种方式来展示审计结果，包括：

简单文本格式
JSON格式
自定义格式

使用SimpleTextChangeLog可以生成易读的文本变更日志：

Changes made by admin:
Commit 1.0 at 2023-10-01T12:00:00
  created object: User/1
    name: "John Doe"
    email: "john@example.com"

Commit 2.0 at 2023-10-01T12:30:00
  updated object: User/1
    name: "John Doe" -> "John Smith"
    email: "john@example.com" -> "john.smith@example.com"