迁移旧项目至新栈：能否复用现有审计表适配Hibernate Envers？

这确实是遗留系统迁移时很头疼的场景——既要用上Hibernate Envers和Spring Data JPA的便捷，又得死守现有数据库模型不动。我来给你拆解下可行的方案：

当然可以，但需要做一些自定义配置，因为Envers默认会生成自己的审计表结构，我们需要把它映射到你已有的审计表上。核心是通过Envers的注解来指定现有表和列的映射关系：

• 指定审计表名：用@AuditTable注解标记你的实体类，比如你的现有审计表叫legacy_audit，就写@AuditTable(value = "legacy_audit")
• 映射审计列：如果现有表的列名和Envers默认的（比如REV、REVTYPE）不一样，用@AuditColumn来指定对应关系。比如你的表用change_id代替默认的版本号列REV，用action_type代替操作类型列REVTYPE，可以这样配置：

  @Audited
  @AuditTable(value = "legacy_audit")
  public class YourEntity {
      @Id
      private Long id;
  
      // 映射实体字段到审计表的对应列
      @AuditColumn(name = "entity_name", auditColumnSuffix = "")
      private String name;
  
      // ...其他字段
  }
  

  另外，你需要确保现有审计表能覆盖Envers需要的元数据（比如修订版本号、操作类型、修改时间、修改人等），如果有缺失，可通过自定义修订实体来补充，映射到现有表的对应列。

结合你的需求，这里有一套完整的落地方案：

1. 自定义修订实体匹配现有审计表 #

先创建一个自定义修订实体，完全映射你现有审计表的元数据字段：

@Entity
@Table(name = "legacy_audit")
@RevisionEntity(CustomRevisionListener.class)
public class CustomRevisionEntity {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    @Column(name = "change_id")
    private Long id;

    @Column(name = "modified_date")
    private LocalDateTime modifiedDate;

    @Column(name = "modified_by")
    private String modifiedBy;

    // 对应Envers的操作类型：0=新增，1=修改，2=删除
    @Column(name = "action")
    private Integer revType;

    // getter、setter方法
}

然后编写修订监听器，自动填充修改时间和操作人：

public class CustomRevisionListener implements RevisionListener {
    @Autowired
    private AuditorAware<String> auditorAware;

    @Override
    public void newRevision(Object revisionEntity) {
        CustomRevisionEntity rev = (CustomRevisionEntity) revisionEntity;
        rev.setModifiedDate(LocalDateTime.now());
        // 从Spring Security上下文获取当前登录用户，需根据你的权限框架调整
        rev.setModifiedBy(auditorAware.getCurrentAuditor().orElse("system"));
    }
}

同时配置Spring的AuditorAware，让框架能获取当前操作人：

@Bean
public AuditorAware<String> auditorAware() {
    return () -> Optional.ofNullable(SecurityContextHolder.getContext().getAuthentication())
            .map(Authentication::getName);
}

2. 审计删除操作 #

Envers默认会自动审计删除操作：它会在审计表中记录删除前的实体快照，并标记操作类型为2（删除）。如果你的现有审计表需要更明确的删除标记，无需额外编码，只要确保自定义修订实体的revType列正确映射即可。

如果需要在删除前执行额外逻辑（比如记录删除原因），可以结合Spring Data JPA的生命周期注解：

@Entity
@Audited
@AuditTable(value = "legacy_audit")
public class YourEntity {
    // ...字段

    @PreDelete
    public void onPreDelete() {
        // 这里可以添加自定义逻辑，比如记录删除触发的上下文
        // 注意：不要在这里直接操作审计表，Envers会自动处理
    }
}

3. 用Spring Data JPA查询审计历史 #

让你的Repository继承AuditRepository接口，就能直接使用Envers的审计查询能力：

public interface YourEntityRepository extends JpaRepository<YourEntity, Long>, 
        AuditRepository<YourEntity, Long, CustomRevisionEntity> {
    // 可添加自定义查询方法
}

之后就能轻松获取实体的所有审计版本，包括删除记录：

// 获取某个实体的所有修订历史
Revisions<Long, CustomRevisionEntity> revisions = yourEntityRepository.findRevisions(entityId);
// 遍历筛选删除操作
for (Revision<Long, CustomRevisionEntity> revision : revisions) {
    if (revision.getRevisionEntity().getRevType() == 2) {
        // 这是一条删除操作的审计记录
        System.out.println("删除时间：" + revision.getRevisionEntity().getModifiedDate());
    }
}

4. 关键注意事项 #

• 确保现有审计表的主键生成策略和自定义修订实体一致（比如自增、序列）
• 如果现有表没有操作类型列，可直接使用Envers默认的REVTYPE值，无需额外修改
• 测试时要验证所有CRUD操作（尤其是删除）的审计记录是否完整写入现有表，元数据（操作人、时间、类型）是否正确

内容的提问来源于stack exchange，提问作者Chandresh Mishra