本文档阐述了在使用 Spring Data Couchbase 进行审计时，如何避免在更新 Couchbase 文档时意外覆盖 @CreatedDate 和 @CreatedBy 等创建时间相关的字段。通过结合 Couchbase Repository 的 save() 方法以及理解审计的工作机制，可以确保在更新操作中正确地保留原始创建信息，仅更新修改时间相关的字段。
在使用 Spring Data Couchbase 进行审计时，一个常见的困惑是如何在更新文档时保留 @CreatedDate 和 @CreatedBy 字段，只更新 @LastModifiedDate 和 @LastModifiedBy 字段。 很多人会尝试使用 CouchbaseTemplate 的 upsert() 或 replaceById() 方法，但这些方法并不会触发审计逻辑，导致每次更新都会覆盖所有审计字段。
正确的使用方法：Couchbase Repository 的 save() 方法
要使审计正常工作，必须结合 Couchbase Repository 的 save() 方法。 Spring Data 的审计机制依赖于 Repository 提供的实体生命周期管理。 当使用 save() 方法时，Spring Data 会自动检测到实体上的审计注解，并执行相应的审计逻辑。
审计的工作机制
Spring Data Couchbase 的审计机制并非完全透明，它需要一些前提条件才能正确工作。特别是对于更新操作，如果调用方没有提供完整的审计信息（包括 @CreatedDate、@CreatedBy、@LastModifiedDate、@LastModifiedBy 和 @Version），则需要先从数据库中检索现有实体，再进行更新。
具体来说，如果你的调用方需要更新一个实体，但没有当前的版本号和审计数据，你需要执行以下步骤：
- 查找 (Find): 使用 Repository 的 findById() 方法从数据库中检索现有实体。
- 更新 (Update): 将检索到的实体中的 @CreatedDate、@CreatedBy 和 @Version 字段复制到要更新的实体中。 然后，修改需要更新的字段。
- 保存 (Save): 使用 Repository 的 save() 方法保存更新后的实体。
只有这样，审计机制才能智能地保留原始的 @Createdxx 字段，同时更新 @Lastxx 字段。
代码示例
假设我们有以下实体类：
@Document(expiry = 0, expiryUnit = TimeUnit.DAYS, touchOnRead = true)
public class Entity {
@Id
@GeneratedValue(strategy = GenerationStrategy.USE_ATTRIBUTES, delimiter = ":")
private String id;
@Version
private long version;
private String firstName;
@CreatedDate
private LocalDateTime createTimeStamp;
@LastModifiedDate
private LocalDateTime lastUpdateTimeStamp;
// 省略 getter 和 setter
}以下是如何正确更新实体的示例：
@Autowired
private EntityRepository entityRepository;
public void updateEntity(String id, String newFirstName) {
// 1. 查找现有实体
Entity existingEntity = entityRepository.findById(id).orElseThrow(() -> new RuntimeException("Entity not found"));
// 2. 创建一个新实体，并复制现有实体的审计信息
Entity updatedEntity = new Entity();
updatedEntity.setId(existingEntity.getId());
updatedEntity.setVersion(existingEntity.getVersion());
updatedEntity.setCreateTimeStamp(existingEntity.getCreateTimeStamp()); // 重要：复制创建时间戳
// 3. 更新需要更新的字段
updatedEntity.setFirstName(newFirstName);
// 4. 保存更新后的实体
entityRepository.save(updatedEntity);
}配置审计
确保你的配置类启用了审计功能：
@Configuration
@EnableCouchbaseAuditing
public class CouchbaseConfig extends AbstractCouchbaseConfiguration {
@Bean
public AuditorAware auditorAware() {
return () -> Optional.of("user"); // 替换为你的用户获取逻辑
}
// 其他配置...
} 注意事项
- 版本控制： @Version 注解至关重要。 如果版本号不匹配，save() 方法将抛出 OptimisticLockingFailureException 异常，防止并发更新导致的数据不一致。
- AuditorAware： AuditorAware 用于提供创建者和修改者的信息。 你需要根据你的应用程序的实际情况来实现它。
- 事务： 如果你的更新逻辑涉及多个操作，请考虑使用事务来确保数据的一致性。
总结
要避免在使用 Spring Data Couchbase 进行审计时覆盖 @Created 字段，必须使用 Couchbase Repository 的 save() 方法，并确保在更新实体时提供完整的审计信息（包括 @CreatedDate、@CreatedBy 和 @Version）。 如果调用方没有这些信息，则需要先从数据库中检索现有实体，再进行更新。 遵循这些步骤可以确保在更新操作中正确地保留原始创建信息，仅更新修改时间相关的字段。
