sring data jpa审计 @EnableJpaAuditing @EntityListeners @CreatedBy

介绍

spring data jpa 的审计主要是做一些自动化填充参数使用的。 我们在使用建表中经常会加入 创建时间 修改时间 创建者 修改者 这四个字段。因此为了简化开发， 我们可以将其交给jpa来自动填充。

使用方法

使用方法是使用注解的方式来实现。 我们在真实项目中也会将基本对象都要使用的属性或者方法抽离出来。 我们这里可以写一个抽像类。 只要实现这个抽象类的entity对象，在执行jpa中的save 方法的时候 ，都会自动的将上面四个属性填充。

第一步

在启动类上添加注解 @EnableJpaAuditing

@SpringBootApplication()
// 启用JPA审计
@EnableJpaAuditing
public class XbootApplication {
	public static void main(String[] args) {
        SpringApplication.run(XbootApplication.class, args);
    }
}

第二步

@Data
@MappedSuperclass
@EntityListeners(AuditingEntityListener.class)
@JsonIgnoreProperties(value={"hibernateLazyInitializer","handler","fieldHandler"})
public abstract class XbootBaseEntity implements Serializable{

    private static final long serialVersionUID = 1L;

    @Id
    @TableId
    @ApiModelProperty(value = "唯一标识")
    private String id = String.valueOf(SnowFlakeUtil.getFlowIdInstance().nextId());

    @ApiModelProperty(value = "创建者")
    @CreatedBy
    private String createBy;

    @CreatedDate
    @JsonFormat(timezone = "GMT+8", pattern = "yyyy-MM-dd")
    @DateTimeFormat(pattern = "yyyy-MM-dd")
    @ApiModelProperty(value = "创建时间")
    private Date createTime;

    @ApiModelProperty(value = "更新者")
    @LastModifiedBy
    private String updateBy;

    @LastModifiedDate
    @JsonFormat(timezone = "GMT+8", pattern = "yyyy-MM-dd")
    @DateTimeFormat(pattern = "yyyy-MM-dd")
    @ApiModelProperty(value = "更新时间")
    private Date updateTime;

    @ApiModelProperty(value = "删除标志 默认0")
    private Integer delFlag = CommonConstant.STATUS_NORMAL;
}

结果@LastModifiedDate @CreatedDate @LastModifiedBy @CreatedBy 并在类上添加 @EntityListeners(AuditingEntityListener.class) 这个注解我们可以实现自动化填充。
在结果更改格式的注解，我们可以改变时间的格式。

第三步 实现AuditorAware接口

AuditorAware介绍

package org.springframework.data.domain;

import java.util.Optional;

public interface AuditorAware<T> {
    Optional<T> getCurrentAuditor();
}

这个接口是spring.data中的接口，他包含了一个抽象方法，返回值是一个泛型，因为我们在使用@createBy 和@LastModifiedBy的时候，里面的属性类型可以是任何类型。

实现接口代码示例

@Configuration
@Slf4j
public class UserAuditor implements AuditorAware<String> {

    @Autowired
    private SecurityUtil securityUtil;
    @Override
    public Optional<String> getCurrentAuditor() {

        UserDetails user;
        try {
            user = (UserDetails) SecurityContextHolder.getContext().getAuthentication().getPrincipal();
            //return Optional.ofNullable(user.getUsername());
            return Optional.ofNullable(securityUtil.getCurrUser().getNickName());
        }catch (Exception e){
            return Optional.empty();
        }
    }
}

实现逻辑可以自己定义。