本文主要是介绍spring data-审计（auditing）功能，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！
前言
日常开发中，经常会遇到实体有创建时间，更新时间，创建人，更新人等字段。这些字段不是核心的业务字段，但是对于跟踪数据记录却非常重要。由于重要程度不是那么高，经常会忘了赋值，导致数据库存的是过期数据。
那么有没有自动化的方法来自动填充这些非核心的字段呢？
答案是肯定的，spring data提供一组注解来自动填充这些非核心字段。
审计注解
这些注解是：
- @CreatedDate：创建时间
- @LastModifiedDate：最后更新时间
- @CreatedBy：创建人信息
- @LastModifiedBy：最后更新人信息
在跟踪数据的字段上加上这些注解，后续spring data保存数据的时候会自动给这些字段填充数据而不用手动赋值。
下面是配置的一个例子：
@Document //mongo文档的注解
public class Lrd {@Idprivate String id;@Columnprivate String name;@CreatedDate //创建时间@Columnprivate Date createTime;@LastModifiedDate //最后更新时间@Columnprivate Date updateTime;@CreatedBy //创建人信息@Columnprivate String createUser;@LastModifiedBy //最后创建人信息@Columnprivate String updateUser;}
上面例子中，后续保存数据就只需要对name属性赋值即可，其他字段会自动填充：
Optional<Lrd> zlb = lrdMongo.findByName("zlb");
if (zlb.isEmpty()) {Lrd lrd = new Lrd();lrd.setName("zlb");lrd = lrdMongo.save(lrd);
} else {lrdMongo.save(zlb.get());
}
在数据库中的显示效果如下：
如果说时间数据从系统时间获得，那么用户数据从哪里获得呢？因为到目前为止，还没有讨论关于用户数据的任何信息。
用户数据
框架自动填充的用户数据，是由org.springframework.data.domain.AuditorAware接口提供的。程序需要注册实现这个接口的对象实例到容器中，并在开启审计功能的注解中引用这个对象：
实现接口的实例
@Component
public class Auditor implements AuditorAware<String> { //这里的类型和实体字段的类型一致@Override@NonNullpublic Optional<String> getCurrentAuditor() {return Optional.ofNullable(SecurityContextHolder.getContext()).map(SecurityContext::getAuthentication).filter(Authentication::isAuthenticated).map(Authentication::getPrincipal).map(User.class::cast).map(User::getUsername);}}
引用对象
@EnableJpaAuditing(auditorAwareRef = "auditor") //JPA
@EnableMongoAuditing(auditorAwareRef = "auditor") //Mongo
从上面的例子可以看出，用户数据最终是通过SecurityContextHolder.getContext()获取的。对于webmvc程序，这是默认的。但是如果是webflux程序，SecurityContextHolder.getContext()将拿不到用户的数据。
那么，这种情况又该怎么办呢？
webflux获取用户数据
查资料可以发现，webflux是通过ReactiveSecurityContextHolder.getContext()来获取SecurityContext的。这样的话，是否能够使用ReactiveSecurityContextHolder.getContext()来获取用户信息呢？
答案是否定的。因为org.springframework.data.domain.AuditorAware接口的返回值是Optional<T>而不是Mono<T>或Flux<T>，所以需要阻塞返回SecurityContext。而在webflux程序中阻塞操作是不被允许的，所以这个办法试了很多遍都没有成功。
后来想到了一个办法，在过滤器中把ReactiveSecurityContextHolder中的SecurityContext赋值给SecurityContextHolder，后续再操作SecurityContextHolder拿到用户数据。如下例所示：
/*** 注入SecurityContext过滤器*/static class SecurityContextFilter implements WebFilter {@NonNull@Overridepublic Mono<Void> filter(@NonNull ServerWebExchange exchange, @NonNull WebFilterChain chain) {return ReactiveSecurityContextHolder.getContext().switchIfEmpty(Mono.just(SecurityContextHolder.getContext()))//没有也注入一个，确保流程能继续.flatMap(new Function<SecurityContext, Mono<Void>>() {@Overridepublic Mono<Void> apply(SecurityContext securityContext) {SecurityContextHolder.setContext(securityContext);return chain.filter(exchange);}});}}
然后，把这个过滤器添加到过滤链上：
@Bean
public SecurityWebFilterChain springSecurityFilterChain(ServerHttpSecurity http) {http.addFilterBefore(new SecurityContextFilter(), SecurityWebFiltersOrder.LAST) //添加到最后，确保经过了验证和授权过滤器
}
这样，每次经过过滤器链到达控制器地请求，都给SecurityContextHolder赋了当前用户信息，后续自动填充时，就不会是空值了。
JPA
对于JPA的审计功能，除了上面的步骤之外，使用注解的话，还需要在每个实体类上使用@EntityListeners(AuditingEntityListener.class)注解才会生效。例如：
@Entity
@EntityListeners(AuditingEntityListener.class) //不要忘了这个注解哦
public class QuiltHello {@Id@GeneratedValueprivate Long id;@Columnprivate String name;@Columnprivate Integer number;@Version@Columnprivate Long version;@CreatedDate@Columnprivate Date createTime;@LastModifiedDate@Columnprivate Date updateTime;}
这篇关于spring data-审计（auditing）功能的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！
