JPA ManyToOne审计优化与冗余更新解决方法

问题描述

在复杂的实体关系中，例如一个TariffOption实体通过@ManyToOne关联到DictTariff实体，而DictTariff实体则通过@OneToMany维护着其关联的TariffOption列表。当这两个实体都被@Audited注解标记以启用Envers审计时，一个常见的问题便会出现：

// TariffOption 实体
@Entity
@Audited
@Table(name = "tariff_option")
public class TariffOption extends BaseEntity {
    // ... 其他字段
    @ManyToOne
    @JoinColumn(name = "dict_tariff_id", updatable = false)
    private DictTariff tariff; // ManyToOne 关联到 DictTariff
}

// DictTariff 实体
@Entity
@Audited
@Table(name = "dict_tariff")
public class DictTariff extends BaseEntity {
    // ... 其他字段
    @OneToMany(mappedBy = "tariff", fetch = FetchType.LAZY)
    private List tariffOptions; // OneToMany 关联到 TariffOption
}

在这种配置下，当我们保存一个TariffOption实例时，例如执行repository.save(dictTariffOption)，即使关联的DictTariff实例（即dictTariffOption.getTariff()）的任何字段都没有被修改，Envers仍然会为DictTariff生成一个新的审计记录。这通常是由于JPA的持久化上下文在处理@ManyToOne关系时，会隐式地认为关联的父实体（DictTariff）的状态可能因其子实体（TariffOption）的保存而“脏”了，从而触发了DictTariff的审计更新。这种行为导致审计表中出现大量重复且无意义的记录，增加了数据量和查询复杂性。

尝试过的解决方案，如在保存TariffOption之前对DictTariff执行EntityManager.detach(dictTariff)或重新检索DictTariff以使其脱离JPA的脏检查，均未能解决此问题。这表明问题根源在于Envers对关联关系的默认审计策略。

解决方案：使用 @NotAudited 注解

解决此问题的关键在于精确地告诉Envers，当DictTariff实体被审计时，其@OneToMany关联的tariffOptions集合的变化不应被视为导致DictTariff自身生成新审计记录的理由。这可以通过在DictTariff实体的tariffOptions字段上添加@NotAudited注解来实现。

@NotAudited注解是Envers提供的，用于排除特定的字段或集合不被审计。当应用于集合字段时，它指示Envers在审计包含该集合的实体时，忽略该集合的任何变化。

修改后的DictTariff实体代码如下：

import org.hibernate.envers.Audited;
import org.hibernate.envers.NotAudited; // 导入 NotAudited

@Data // Lombok 注解，生成 getter/setter/equals/hashCode/toString
@NoArgsConstructor
@Entity
@Audited // DictTariff 实体本身仍然需要审计
@AuditTable(schema = "audit", value = "dict_tariff")
@AuditOverride(forClass = BaseEntity.class, isAudited = true)
@Table(name = "dict_tariff")
@EqualsAndHashCode(of = {}, callSuper = true)
@ToString(exclude = {"contractorTypes", "service", "tariffOptions", "dictTariffOptions"})
@JsonIgnoreProperties(value = {"contractorTypes", "service", "tariffOptions", "dictTariffOptions"})
public class DictTariff extends BaseEntity {
    private static final long serialVersionUID = -3881580795280130829L;
    // ... 其他字段

    @OneToMany(mappedBy = "tariff", fetch = FetchType.LAZY)
    @NotAudited // 核心改动：不对这个集合的变化进行审计
    private List tariffOptions;
}

而TariffOption实体保持不变：

import org.hibernate.envers.Audited;

@Data // Lombok 注解
@NoArgsConstructor
@Entity
@Audited // TariffOption 实体本身仍然需要审计
@AuditTable(schema = "audit", value = "tariff_option")
@AuditOverride(forClass = BaseEntity.class, isAudited = true)
@Table(name = "tariff_option")
@EqualsAndHashCode(of = {}, callSuper = true)
@ToString()
public class TariffOption extends BaseEntity {
    private static final long serialVersionUID = -6398231779406280786L;

    // ... 其他字段

    @ManyToOne
    @JoinColumn(name = "dict_tariff_id", updatable = false)
    private DictTariff tariff; // ManyToOne 关联
}

通过在DictTariff的tariffOptions集合上添加@NotAudited，当TariffOption实例被保存或更新时，Envers将不再因为DictTariff的tariffOptions集合可能发生“变化”（即使是隐式的）而为DictTariff生成新的审计记录。这样就成功避免了冗余的审计更新。

注意事项

1. 审计范围的理解：@NotAudited注解只影响被注解字段或集合的审计行为。在本例中，它阻止了DictTariff实体因其tariffOptions集合的变化而被审计。但是，TariffOption实体本身及其字段（包括@ManyToOne关联到DictTariff的tariff字段）仍然会按照其@Audited注解的指示进行审计。
2. 何时使用：此方法适用于以下场景：
   • 父实体（如DictTariff）的审计记录仅关注其自身字段的变化，而不关心其子实体集合（如tariffOptions）的变化是否触发其自身的审计。
   • 子实体（如TariffOption）的审计记录已足够反映其与父实体的关联变化。
3. 避免过度使用：不要在所有@OneToMany或@ManyToMany集合上盲目使用@NotAudited。只有当您明确不希望集合的变化导致包含该集合的实体被审计时才使用它。过度使用可能会导致审计记录丢失关键信息。
4. JPA与Envers的交互：理解JPA的持久化上下文如何管理实体状态，以及Envers如何在此基础上进行脏检查和审计，是解决这类问题的基础。有时，即使实体字段没有直接修改，JPA的内部状态变化也可能被Envers捕获。

总结

在JPA和Envers的集成中，管理实体间的复杂关系和审计行为是常见的挑战。通过在父实体@OneToMany关联字段上巧妙地使用@NotAudited注解，我们可以精确控制Envers的审计范围，有效避免因子实体操作导致的父实体冗余审计更新。这不仅能减少审计表的膨胀，提高数据库性能，还能使审计记录更加清晰和有意义，聚焦于真正的数据变化。