Hibernate Envers

一、目的

Hibernate Envers的目的是提供应用程序实体数据的历史版本，记录执行数据变更历史。

二、用途

Hibernate Envers记录的审计数据，主要用于意外丢失数据找回、审查数据合法性、辅助问题分析等用途。一般直接在数据库执行sql查询分析即可。

三、实现原理

为每个Audited的表创建一个对应的审计数据存储表，然后借助Hibernate Listener机制把对数据的增删改操作记录到审计表。（由此引申出的问题：随着业务操作的频繁，审计表数据增长很快）。

四、配置方法

以下是基于Spring的配置：

1. 配置Envers事件监听器

<bean id="sessionFactory" class="……Bean">
    <property name="eventListeners">
    <map>
    <entry key="post-insert" value-ref="enversEventListener" />
    <entry key="post-update" value-ref="enversEventListener" />
    <entry key="post-delete" value-ref="enversEventListener" />
    <entry key="post-collection-recreate" value-ref="enversEventListener" />
    <entry key="pre-collection-remove" value-ref="enversEventListener" />
    <entry key="pre-collection-update" value-ref="enversEventListener" />
    </map>
    </property>
    </bean>
    <bean name="enversEventListener" class="org.hibernate.envers.event.AuditEventListener" />

2. 配置Envers相关属性

<property name="hibernateProperties">
    <!-- 配置版本数据 -->
    <props>
    <!--配置审计表名的后缀，默认为空 -->
    <prop key="org.hibernate.envers.audit_table_suffix"></prop>
    <!--配置审计表名的前缀，默认为_AUD -->
    <prop key="org.hibernate.envers.audit_table_prefix">V_</prop>
    <!--配置审计表中记录版本号的字段名称 -->
    <prop key="org.hibernate.envers.revision_field_name">VER</prop>
    <!--配置审计表中数据操作类型的字段名称，0：新增 1：修改 2：删除 -->
    <prop key="org.hibernate.envers.revision_type_field_name">REVTYPE</prop>
    <!--配置是否支持关联表修改时记录修改记录,默认为true -->
    <prop key="org.hibernate.envers.revision_on_collection_change">true</prop>
    <!--配置是否不对乐观锁字段修改时记录修改记录，即使用Version字段，默认值为true -->
    <prop key="org.hibernate.envers.do_not_audit_optimistic_locking_field">true</prop>
    <!--配置是否在删除操作时，记录所有字段还是只记录id值。默认为false false：只记录id true：记录全部字段 -->
    <prop key="org.hibernate.envers.store_data_at_delete">true</prop>
    <!--配置审计表的schema，默认为null -->
    <prop key="org.hibernate.envers.default_schema">DateBaseName</prop>
    <!--配置审计表的catalog，默认为null -->
    <prop key="org.hibernate.envers.default_catalog"></prop>
    </props>
</property>

3. 实体对象配置

给要增加审计记录的实体添加注解。

@Audited 标记该实体类或属性支持数据修改记录。

@NotAudited 标记该属性不支持数据修改记录。

@RevisionEntity 实现为数据修改记录表保存其他自定义内容

@RevisionTimestamp 记录修改时间，必须配合@RevisionEntity使用

@RevisionNumber 修改记录表的版本id 通常是配置成主键

给创建审计记录的实体添加注解