spring jpa 审计功能自定义填充字段方式

spring jpa 审计功能自定义填充字段

spring data jpa 通过@createby等注解实现了审计功能（在新建或者修改的时候自动填充某些字段） 但是当我们有多个字段需要填充的时候就不满足了 这就需要我们自己实现相关接口来实现自动填充

有两种方式

• 一种是实现 auditable接口 但是这样会在实体类中莫名增加很多setter getter方法 会对序列化造成干扰 所以不推荐
• 我推荐的是第二种方法 重写listener

具体步骤

在configration 类开启审计功能

@springbootapplication
@enablejpaauditing
public 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 第一个是在保存的前置方法（新增 和 更新） 第二个是更新的前置方法 通过这两个方法就可以实现自己填充

@configurable
public 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

@component
public 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
 * 自动注入用户名
 */
@configuration
public class userauditoraware implements auditoraware<string> {  
    @override
    public optional<string> getcurrentauditor() {
        //todo: 根据实际情况取真实用户
        return optional.of("admin");
    }
}

2.在实体类中声明@entitylisteners和相应的注解

考虑到所有实体都需要声明，就写在baseentitymodel 中

@mappedsuperclass
@entitylisteners(auditingentitylistener.class)
public class baseentitymodel  implements serializable { 
    /**
     * 
     */
    private static final long serialversionuid = -6163675075289529459l; 
    @jsonignore
    string entityname = this.getclass().getsimplename();
 
    @createdby
    string createdby;
 
    @lastmodifiedby
    string modifiedby;
    /**
     * 实体创建时间
     */
    @temporal(temporaltype.timestamp)
    @createddate
    protected date datecreated = new date();
 
    /**
     * 实体修改时间
     */
    @temporal(temporaltype.timestamp)
    @lastmodifieddate
    protected date datemodified = new date(); 
     #省略getter setter
}

3.在application 中启用审计@enablejpaauditing

@springbootapplication
@enablejpaauditing
public class application {    
    public static void main(string[] args) throws exception {
        springapplication.run(application .class, args);
    }
 
    /**
     * 测试中如果无法自动识别,可能是包路径的问题，采用手动声明bean的方式
     * @return
     */
    @bean
    public userauditoraware setuserauditoraware(){
        return new userauditoraware();
    }
}

经过测试如果你的实体类上面的多个字段使用了@createdby这样的注解，只会有一个生效，也就是说在一次请求中，只会被调用一次

以上为个人经验，希望能给大家一个参考，也希望大家多多支持。