hibernate envers实践总结

1.简介

Envers模块是一个核心的Hibernate模型，可与Hibernate和JPA一起使用。事实上，你可以在Hibernate工作的任何地方使用Envers，无论它是独立的，在WildFly还是JBoss AS、Spring、Grails等内部。

Envers模块旨在为实体类提供一个简单的审核/版本控制解决方案

2.实验步骤

使用springboot来做实验。

pom.xml

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>
  
     <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.3.2.RELEASE</version>
        <relativePath/>
    </parent>

  <groupId>com</groupId>
  <artifactId>Spring-hibernate-envers-test</artifactId>
  <version>0.0.1-SNAPSHOT</version>
  <packaging>jar</packaging>

  <name>Spring-hibernate-envers-test</name>
  <url>http://maven.apache.org</url>

  <properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    <java.version>1.8</java.version>
  </properties>

  <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-jpa</artifactId>
        </dependency>
        <dependency>
            <groupId>org.hibernate</groupId>
            <artifactId>hibernate-envers</artifactId>
        </dependency>
        <dependency>
            <groupId>com.h2database</groupId>
            <artifactId>h2</artifactId>
        </dependency>
  </dependencies>
</project>

创建User类作为审计对象

package com;
import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.Id;
import javax.persistence.Table;
import org.hibernate.envers.Audited;
import com.fasterxml.jackson.annotation.JsonIgnoreProperties;

@Entity
@Table(name = "user")
@Audited
@JsonIgnoreProperties(value = "hibernateLazyInitializer")
public class User {

    @Id
    @GeneratedValue
    private Long id;
    private String name;

    public Long getId() {
        return id;
    }
    public void setId(Long id) {
        this.id = id;
    }
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
}

application.properties

spring.jpa.hibernate.ddl-auto=create
spring.jpa.properties.org.hibernate.envers.audit_strategy=org.hibernate.envers.strategy.internal.ValidityAuditStrategy
spring.jpa.properties.org.hibernate.envers.audit_strategy_validity_store_revend_timestamp=true
spring.h2.console.enabled=true
spring.h2.console.path=/h2
spring.datasource.url=jdbc:h2:mem:envers
spring.datasource.username=sa
spring.datasource.password=sa
spring.datasource.driverClassName=org.h2.Driver

创建相应的UserRepository

package com;
import org.springframework.data.jpa.repository.JpaRepository;
import org.springframework.stereotype.Repository;

@Repository
public interface UserRepository extends JpaRepository<User, Long> {
}

添加用于增删改的Controller

package com;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;

@Controller
public class UserController {
    @Autowired
    private UserRepository userRepository;
    private int counter;

    @ResponseBody
    @RequestMapping("/user/add")
    public Object add() {
        User user = new User();
        user.setName("name" + ++counter);
        userRepository.save(user);
        return user;
    }

    @ResponseBody
    @RequestMapping("/user/update/{id}")
    public Object update(@PathVariable Long id) {
        User user = userRepository.getOne(id);
        user.setName("name" + ++counter);
        userRepository.save(user);
        return user;
    }

    @ResponseBody
    @RequestMapping("/user/delete/{id}")
    public Object delete(@PathVariable Long id) {
        User user = userRepository.getOne(id);
        userRepository.delete(user);
        return user;
    }
    
}

查询审计的数据

package com;

import java.util.List;

import javax.persistence.EntityManager;

import org.hibernate.envers.AuditReader;
import org.hibernate.envers.AuditReaderFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.ResponseBody;

@Controller
public class AuditUserController {
	
	@Autowired
	private EntityManager entityManager;

    @ResponseBody
    @RequestMapping("/audit/user")
    public Object findAuditUser(@RequestParam(value="userId",required=true) String userId, @RequestParam(value="revision",required=true) Integer revision) {
    
    	AuditReader reader = AuditReaderFactory.get( entityManager );
    	User firstRevision = reader.find( User.class, Long.parseLong(userId), revision );
    	return firstRevision;
    }
    @ResponseBody
    @RequestMapping("/audit/users/{userId}")
    public Object getAllRevisions(@PathVariable Long userId) {
    	AuditReader reader = AuditReaderFactory.get( entityManager );
    	List<Number> allRevisions = reader.getRevisions(User.class, userId);
    	
    	return allRevisions;
    }
}

springboot的启动类

@SpringBootApplication
public class SpringbootEnversApplication {
    public static void main(String[] args) {
        SpringApplication.run(SpringbootEnversApplication.class, args);
    }
}

运行程序后，访问http://localhost:8080/h2，输入密码sa，即可登陆数据库并查询数据

由于配置了spring.jpa.hibernate.ddl-auto=create，可以看到系统已经为我们生成了相关的数据表

其中USER是实体类的表，USER_AUD是对应的审计表

依次访问以下链接，增加两条数据，分别对两条数据进行更新，再删除第一条数据

　　http://localhost:8080/user/add

　　http://localhost:8080/user/add

　　http://localhost:8080/user/update/1

　　http://localhost:8080/user/update/2

　　http://localhost:8080/user/delete/1

根据主键和revisionId查询审计数据，

http://localhost:8080/audit/user?userId=1&revision=1

根据UserId查询所有审计版本

http://localhost:8080/audit/users/1

其中ID是USER表的主键，REV是USER_AUD的主键，REVTYPE是操作类型，0新增，1更新，2删除，name则是对应USER的name属性

hibernate提供了两种审计策略，分别是

org.hibernate.envers.strategy.internal.DefaultAuditStrategy
org.hibernate.envers.strategy.internal.ValidityAuditStrategy

如果使用DefaultAuditStrategy，USER_AUD表中不会有REVEND，REVEND_TSTMP两个字段，只会单纯的记录变更与版本

而使用ValidityAuditStrategy，在新增一条变更记录时，会更新上一条变更记录的REVEND，REVEND_TSTMP为当前的版本号以及变更时间

因为ValidityAuditStrategy除了插入新纪录还要更新旧的记录，所以插入速度会慢一点，但是因为提供了额外的信息，对于数据查询，速度则较DefaultAuditStrategy更快一些

参考资料

Hibernate Getting Started Guide

Envers - Hibernate ORM