使用Spring Data Auditing更新Couchbase文档时避免覆盖@Created字段

问题本质 #

直接使用replaceById()、upsertById()这类覆盖式更新操作时，Spring Data Couchbase的审计机制不会自动保留@CreatedDate/@CreatedBy字段。原因在于：

• 这类操作是用传入的实体对象直接覆盖数据库中的文档，而非基于原有文档做增量更新
• @Created系列字段的设计逻辑是仅在实体首次插入时赋值，但覆盖式更新时，框架不会主动查询原有文档的创建信息进行合并，若传入的实体中@Created字段为null或被重新赋值，就会覆盖数据库中的原有值

解决方案 #

方案1：先查询再更新（推荐，符合框架设计预期） #

这是最稳妥的方式，利用Spring Data对实体状态的识别能力（判断是否为已有实体），自动保留创建字段：

// 1. 查询数据库中已有实体
Entity existingEntity = couchbaseTemplate.findById(entityId, Entity.class);
// 2. 修改需要更新的业务字段
existingEntity.setFirstName("UpdatedFirstName");
existingEntity.setLastName("UpdatedLastName");
// 3. 保存，审计逻辑仅更新LastModified系列字段，保留Created字段值
couchbaseTemplate.save(existingEntity);

方案2：自定义逻辑避免两次调用 #

如果追求性能，可通过两种方式自定义审计行为：

方式A：重写AuditingHandler的回调逻辑

在配置类中自定义审计处理器，区分新实体和已有实体的审计字段赋值：

@Bean
public AuditingHandler auditingHandler(PersistentEntities persistentEntities) {
    AuditingHandler handler = new AuditingHandler(persistentEntities);
    handler.setAuditorAware(couchAuditing());
    
    handler.setAuditableCallback((auditable, auditInfo) -> {
        // 通过version字段判断是否为已有实体（需确保version字段正常维护）
        if (auditable instanceof Entity && ((Entity) auditable).getVersion() > 0) {
            // 仅更新LastModified系列字段
            auditable.setLastModifiedDate(auditInfo.getLastModifiedDate());
            auditable.setLastModifiedBy(auditInfo.getLastModifiedBy());
        } else {
            // 新实体，赋值所有审计字段
            auditable.setCreatedDate(auditInfo.getCreatedDate());
            auditable.setCreatedBy(auditInfo.getCreatedBy());
            auditable.setLastModifiedDate(auditInfo.getLastModifiedDate());
            auditable.setLastModifiedBy(auditInfo.getLastModifiedBy());
        }
        return auditable;
    });
    return handler;
}

方式B：实体类中限制@Created字段的修改

在实体的setter方法中添加判断，仅允许首次赋值：

@CreatedDate
private LocalDateTime createTimeStamp;

public void setCreateTimeStamp(LocalDateTime createTimeStamp) {
    // 仅当当前值为null时才允许设置
    if (this.createTimeStamp == null) {
        this.createTimeStamp = createTimeStamp;
    }
}

// 同理处理@CreatedBy字段
@CreatedBy
private String createdBy;

public void setCreatedBy(String createdBy) {
    if (this.createdBy == null) {
        this.createdBy = createdBy;
    }
}

总结 #

• 优先选择先查询再更新的方式，避免自定义逻辑带来的边界问题
• 若必须优化性能，可通过自定义AuditingHandler或实体setter控制，但需确保实体状态判断逻辑（如version字段）的准确性

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