如何使 AuditorAware 与 Spring Data Mongo Reactive 一起使用

Question

Spring Security 5 提供了一个ReactiveSecurityContextHolder to fetch the SecurityContext from a Reactive context，但是当我想实现AuditorAware 并自动获得试听工作时，它不起作用。 目前我找不到AuditorAware 的Reactive 变体。

@Bean
public AuditorAware<Username> auditor() {
    return () -> ReactiveSecurityContextHolder.getContext()
        .map(SecurityContext::getAuthentication)
        .log()
        .filter(a -> a != null && a.isAuthenticated())
        .map(Authentication::getPrincipal)
        .cast(UserDetails.class)
        .map(auth -> new Username(auth.getName()))
        .switchIfEmpty(Mono.empty())
        .blockOptional();
}

我已经在我的引导Application 类中添加了@EnableMongoAuduting。

在 Mongo 文档类上。我添加了试听相关的注释。

@CreatedDate
private LocalDateTime createdDate;

@CreatedBy
private Username author;

当我添加一个帖子时，createdDate 已填充，但作者为空。

{"id":"5a49ccdb9222971f40a4ada1","title":"my first post","content":"content of my first post","createdDate":"2018-01-01T13:53:31.234","author":null}

完整代码为here，基于Spring Boot 2.0.0.M7。

更新： Spring Boot 2.4.0-M2/Spring Data Common 2.4.0-M2/Spring Data Mongo 3.1.0-M2 包括ReactiveAuditorAware，检查this new sample，注意：使用@EnableReactiveMongoAuditing来激活它。

Answer 1

已弃用：查看原帖中的更新解决方案

在提供官方 reactive AuditAware 之前，有一个替代方案可以通过 Spring Data Mongo 特定的ReactiveBeforeConvertCallback 来实现这些。

1. 不要使用@EnableMongoAuditing
2. 实现自己的ReactiveBeforeConvertCallback，这里我为那些需要审计的实体使用PersistentEntity接口。

public class PersistentEntityCallback implements ReactiveBeforeConvertCallback<PersistentEntity> {

    @Override
    public Publisher<PersistentEntity> onBeforeConvert(PersistentEntity entity, String collection) {
        var user = ReactiveSecurityContextHolder.getContext()
                .map(SecurityContext::getAuthentication)
                .filter(it -> it != null && it.isAuthenticated())
                .map(Authentication::getPrincipal)
                .cast(UserDetails.class)
                .map(userDetails -> new Username(userDetails.getUsername()))
                .switchIfEmpty(Mono.empty());

        var currentTime = LocalDateTime.now();

        if (entity.getId() == null) {
            entity.setCreatedDate(currentTime);
        }
        entity.setLastModifiedDate(currentTime);

        return user
                .map(u -> {
                            if (entity.getId() == null) {
                                entity.setCreatedBy(u);
                            }
                            entity.setLastModifiedBy(u);

                            return entity;
                        }
                )
                .defaultIfEmpty(entity);
    }
}

查看完整代码here。

Answer 2

我正在发布另一个解决方案，它使用输入 id 来支持更新操作：

@Component
@RequiredArgsConstructor
public class AuditCallback implements ReactiveBeforeConvertCallback<AuditableEntity> {

    private final ReactiveMongoTemplate mongoTemplate;

    private Mono<?> exists(Object id, Class<?> entityClass) {
        if (id == null) {
            return Mono.empty();
        }
        return mongoTemplate.findById(id, entityClass);
    }

    @Override
    public Publisher<AuditableEntity> onBeforeConvert(AuditableEntity entity, String collection) {
        var securityContext = ReactiveSecurityContextHolder.getContext();
        return securityContext
                .zipWith(exists(entity.getId(), entity.getClass()))
                .map(tuple2 -> {
                    var auditableEntity = (AuditableEntity) tuple2.getT2();
                    auditableEntity.setLastModifiedBy(tuple2.getT1().getAuthentication().getName());
                    auditableEntity.setLastModifiedDate(Instant.now());
                    return auditableEntity;
                })
                .switchIfEmpty(Mono.zip(securityContext, Mono.just(entity))
                        .map(tuple2 -> {
                            var auditableEntity = (AuditableEntity) tuple2.getT2();
                            String principal = tuple2.getT1().getAuthentication().getName();
                            Instant now = Instant.now();
                            auditableEntity.setLastModifiedBy(principal);
                            auditableEntity.setCreatedBy(principal);
                            auditableEntity.setLastModifiedDate(now);
                            auditableEntity.setCreatedDate(now);
                            return auditableEntity;
                        }));
    }
}

Answer 3

要填充 createdBy 属性，您需要将您的 auditAware bean 与注释 @EnableMongoAuditing 链接

在你的 MongoConfig 类中，定义你的 bean：

@Bean(name = "auditorAware")
public AuditorAware<String> auditor() {
    ....
}

并在注释中使用它：

@Configuration
@EnableMongoAuditing(auditorAwareRef="auditorAware")
class MongoConfig {
    ....
}