如何在 Spring Boot 2.2.x 中使用 Mongo 审计和 UUID 作为 id？

Question

我希望使用 UUID id 和 createdAt / updatedAt 字段存储文档。我的解决方案是使用 Spring Boot 2.1.x。在我从 Spring Boot 2.1.11.RELEASE 升级到 2.2.0.RELEASE 之后，我对 MongoAuditing 的测试以createdAt = null 失败。我需要做什么才能再次填充 createdAt 字段？

这不仅仅是一个测试问题。我运行了该应用程序，它的行为与我的测试相同。所有审计字段都保持为空。

我有一个启用 MongoAuditing 和 UUID 生成的配置：

@Configuration
@EnableMongoAuditing
public class MongoConfiguration {
    @Bean
    public GenerateUUIDListener generateUUIDListener() {
        return new GenerateUUIDListener();
    }
}

监听器连接到onBeforeConvert - 我猜这就是麻烦开始的地方。

public class GenerateUUIDListener extends AbstractMongoEventListener<IdentifiableEntity> {
    @Override
    public void onBeforeConvert(BeforeConvertEvent<IdentifiableEntity> event) {
        IdentifiableEntity entity = event.getSource();
        if (entity.isNew()) {
            entity.setId(UUID.randomUUID());
        }
    }
}

文档本身（我删除了 getter 和 setter）：

@Document
public class MyDocument extends InsertableEntity {
    private String name;
}


public abstract class InsertableEntity extends IdentifiableEntity {
    @CreatedDate
    @JsonIgnore
    private Instant createdAt;
}

public abstract class IdentifiableEntity implements Persistable<UUID> {
    @Id
    private UUID id;

    @JsonIgnore
    public boolean isNew() {
        return getId() == null;
    }
}

可以在此处找到完整的最小示例（包括测试）https://github.com/mab/auditable 使用 2.1.11.RELEASE 测试成功，使用 2.2.0.RELEASE 失败。

Answer 1

对我来说，最好的解决方案是从事件 UUID 生成切换到基于回调的生成。通过Ordered的实现，我们可以设置新的回调在AuditingEntityCallback之后执行。

public class IdEntityCallback implements BeforeConvertCallback<IdentifiableEntity>, Ordered {
    @Override
    public IdentifiableEntity onBeforeConvert(IdentifiableEntity entity, String collection) {
      if (entity.isNew()) {
        entity.setId(UUID.randomUUID());
      }
      return entity;
    }

    @Override
    public int getOrder() {
      return 101;
    }
}

我使用MongoConfiguration 注册了回调。对于更通用的解决方案，您可能需要查看 AuditingEntityCallback 与 `MongoAuditingBeanDefinitionParser 的注册。

@Configuration
@EnableMongoAuditing
public class MongoConfiguration {
  @Bean
  public IdEntityCallback registerCallback() {
    return new IdEntityCallback();
  }
}

Answer 2

MongoTemplate 在doInsert() 上以下列方式工作

• this.maybeEmitEvent - 发出一个事件（onBeforeConvert、onBeforeSave 等），这样任何AbstractMappingEventListener 都可以像使用GenerateUUIDListener 一样捕捉并采取行动
• this.maybeCallBeforeConvert - 在转换 回调 之前调用，例如 mongo auditing

就像你在MongoTemplate.classsrc (831-832) 的源代码中看到的那样

protected <T> T doInsert(String collectionName, T objectToSave, MongoWriter<T> writer) {
        BeforeConvertEvent<T> event = new BeforeConvertEvent(objectToSave, collectionName);
        T toConvert = ((BeforeConvertEvent)this.maybeEmitEvent(event)).getSource(); //emit event
        toConvert = this.maybeCallBeforeConvert(toConvert, collectionName); //call some before convert handlers
        ...
}

MongoAudit 仅通过检查entity.isNew() == true 是否将createdAt 标记为新实体

因为您的代码 (UUID) 已经设置了 Id，所以未填充 createdAt（实体不被视为新实体）

您可以执行以下操作（按从好到坏的顺序排列）：

• 忘记UUID 并使用String 作为您的ID，让mongo 自己创建和管理它的实体ID（这实际上是MongoTemplate 的工作方式第811-812 行）
• 在代码级别保留UUID，在从数据库中插入和检索时从/到String
• 创建一个自定义存储库，如post
• 留在2.1.11.RELEASE
• 将updateAt设置为GenerateUUIDListener以及id（重命名为NewEntityListener或smth），基本实现审计
• 实现一个新的 isNew() 逻辑，它不仅仅依赖于实体id

在 2.1.11.RELEASE 版本中，方法的顺序被翻转 (MongoTemplate.class 804-805)，因此您的代码运行良好

作为一种抽象方法，事件的本质是一种发送后忘记（异步兼容），因此更改对象本身是一种非常糟糕的做法，有 NO 被授予者计算顺序，如果有的话

这就是为什么审计基于回调而不是事件，这就是为什么 Pivotal 不（需要）保持版本之间的顺序