小编给大家分享一下spring jpa审计功能如何自定义填充字段,希望大家阅读完这篇文章之后都有所收获,下面让我们一起去探讨吧!
spring jpa 审计功能自定义填充字段spring data jpa 通过@CreateBy等注解实现了审计功能(在新建或者修改的时候自动填充某些字段) 但是当我们有多个字段需要填充的时候就不满足了 这就需要我们自己实现相关接口来实现自动填充
有两种方式一种是实现 auditable接口 但是这样会在实体类中莫名增加很多setter getter方法 会对序列化造成干扰 所以不推荐
我推荐的是第二种方法 重写Listener
具体步骤在configration 类开启审计功能
@SpringBootApplication@EnableJpaAuditingpublic class Config() {}实现entity通用继承类 指定自定义的listener
@EntityListeners({CustomAuditingListener.class})public class Base{ private Long id; private Long creator; private String creatorName; private Long modifier; private String modifierName; ... 省略setter getter}实现自定义listener 其中有两个核心的接口 @PrePersist 和 @PreUpdate 第一个是在保存的前置方法(新增 和 更新) 第二个是更新的前置方法 通过这两个方法就可以实现自己填充
@Configurablepublic class CustomAuditingListener implements ConfigurableObject { public AuditListener() { } @Autowired private AuditHandler auditHandler; @PrePersist private void prePersist(Object obj) { auditHandler.prePersist(obj); } @PreUpdate private void preUpdate(Object obj) { auditHandler.preUpdate(obj); }}实现自定义的 AuditHandler
@Componentpublic class CustomAuditHandler implements AuditHandler { @Override public void prePersist(Object obj) { if (obj instanceof Base) { Base ae = (Base) obj; if (ae.getId() == null) { this.markForCreate(ae); } } } @Override public void preUpdate(Object obj) { if (obj instanceof Base) { Base ae = (Base) obj; this.markForUpdate(ae); } } public void markForCreate(Base be) { ae.setCreator("自己获取的用户id"); ae.setCreatorName("自己获取的用户名称"); } public void markForUpdate(Base ae) { ae.setModifier("自己获取的用户id"); ae.setModifierName("自己获取的用户名称"); }}*/启用Spring Data JPA审计功能突然发现 Spring Data JPA 有这么一个功能,英文是 Auditing
JPA Audit 说明在spring jpa中,支持在字段或者方法上进行注解@CreatedDate、@CreatedBy、
@LastModifiedDate、@LastModifiedBy,从字面意思可以很清楚的了解,这几个注解的用处。
@CreatedDate:表示该字段为创建时间时间字段,在这个实体被insert的时候,会设置值
@CreatedBy:表示该字段为创建人,在这个实体被insert的时候,会设置值
@LastModifiedDate、@LastModifiedBy同理。
如何使用审计功能首先申明实体类,需要在类上加上注解@EntityListeners(AuditingEntityListener.class),其次在application启动类中加上注解EnableJpaAuditing,同时在需要的字段上加上@CreatedDate、@CreatedBy、@LastModifiedDate、@LastModifiedBy等注解。
这个时候,在jpa.save方法被调用的时候,时间字段会自动设置并插入数据库,但是CreatedBy和LastModifiedBy并没有赋值,因为需要实现AuditorAware接口来返回你需要插入的值。
1.编写AuditorAware/** * 监听 * @CreatedBy * @LastModifiedBy * 自动注入用户名 */@Configurationpublic class UserAuditorAware implements AuditorAware { @Override public Optional getCurrentAuditor() { //TODO: 根据实际情况取真实用户 return Optional.of("admin"); }}2.在实体类中