我最新最全的文章都在,欢迎大家来喝茶!

1 数据库审计

数据库审计是指当数据库有记录变更时,可以记录数据库的变更时间和变更人等,这样以后出问题回溯问责也比较方便。对于审计表记录的变更可以两种方式,一种是建立一张审计表专门用于记录,另一种是在数据库增加字段。本文所讨论的是第二种方案。

那如何在新增、修改、删除的时候同时增加记录呢?如果每张表都单独记录,代码就会显得很冗余。更好的方式应该是做切面或者事件监听,当数据有变更时统一进行记录。

2 spring data jpa审计

spring data jpa为我们提供了方便的audit功能,通过四个注解来标记字段:

(1) @createdby: 创建人

(2) @createddate: 创建时间

(3) @lastmodifiedby: 最后修改人

(4) @lastmodifieddate: 最后修改时间

接下来我们来看看怎么使用。

2.1 项目准备

通过docker启动postgresql数据库:

docker run -itd \
    --name pkslow-postgres \
    -e postgres_db=pkslow \
    -e postgres_user=pkslow \
    -e postgres_password=pkslow \
    -e pgdata=/var/lib/postgresql/data/pgdata \
    -p 5432:5432 \
    postgres:10

引入相关依赖:

<dependency>
  <groupid>org.springframework.boot</groupid>
  <artifactid>spring-boot-starter-web</artifactid>
</dependency>
<dependency>
  <groupid>org.springframework.boot</groupid>
  <artifactid>spring-boot-starter-data-jpa</artifactid>
</dependency>
<dependency>
  <groupid>org.postgresql</groupid>
  <artifactid>postgresql</artifactid>
</dependency>
<dependency>
  <groupid>org.springframework.boot</groupid>
  <artifactid>spring-boot-starter-security</artifactid>
</dependency>

spring security不是必须的,这里使用它来获取用户名。配置的用户为:

spring.security.user.name=pkslow
spring.security.user.password=123456

2.2 创建实体父类

其实父类不是必须的,你可以在每个想audit的实体类进行配置,但比较麻烦,不如创建一个父类,再让想审计的子类都继承它:

@mappedsuperclass
@entitylisteners(auditingentitylistener.class)
public class auditable<u> {
    @createdby
    @column(name = "created_by")
    private u createdby;

    @createddate
    @column(name = "created_date")
    private date createddate;

    @lastmodifiedby
    @column(name = "last_modified_by")
    private u lastmodifiedby;

    @lastmodifieddate
    @column(name = "last_modified_date")
    private date lastmodifieddate;
  // getter
  //setter
}

@mappedsuperclass可以让其它子实体类继承相关的字段和属性;

@entitylisteners设置监听类,会对新增修改进行回调处理。

有了父类之后,子类就简单了:

@entity
@table(name = "pkslow_users")
public class user extends auditable<string> {
    @id
    @generatedvalue(strategy = generationtype.auto)
    private long userid;
    private string name;
    private string email;
    private string country;
    private string website;
  //getter setter
}

2.3 如何获取名字

数据总是被修改的,我们要提供一个获取修改人名字的接口,配置如下:

@configuration
@enablejpaauditing(auditorawareref = "auditorprovider")
public class jpaauditingconfiguration {

    @bean
    public auditoraware<string> auditorprovider() {
        return () -> {
            string username = "system";
            securitycontext context = securitycontextholder.getcontext();
            if (context != null) {
                authentication authentication = context.getauthentication();
                if (authentication != null) {
                    username = authentication.getname();
                }
            }

            string result = username;
            return optional.ofnullable(result);
        };
    }
}

这里配置的是通过spring securitycontext来获取登陆用户的名字,当然可以有其它方案,如获取请求头的某个字段等。

注意注解@enablejpaauditing开启了审计功能。

2.4 测试

我们通过一个controller来新增数据,看看会有什么效果:

@restcontroller
@requestmapping("/user")
public class usercontroller {
    @autowired
    private userrepository userrepository;
    @postmapping
    public user save(@requestbody user user) {
        return userrepository.save(user);
    }
}

通过curl命令来测试如下:

$ curl 'http://localhost:8088/user' -x post \
> -h 'content-type: application/json' \
> -h 'authorization:basic cgtzbg93ojeymzq1ng==' \
> -d '{
>     "name":"larry",
>     "email":"admin@pkslow.com",
>     "country":"china",
>     "website":"www.pkslow.com"
> }'
{"createdby":"pkslow","createddate":"2021-01-15t15:08:47.035+0000","lastmodifiedby":"pkslow","lastmodifieddate":"2021-01-15t15:08:47.035+0000","userid":7,"name":"larry","email":"admin@pkslow.com","country":"china","website":www.pkslow.com}

查看数据库,已经生成了审计记录:

3 总结

代码请查看:https://github.com/larrydpk/pkslow-samples

到此这篇关于spring data jpa的audit功能审计数据库的变更的文章就介绍到这了,更多相关spring data jpa审计数据库变更内容请搜索www.887551.com以前的文章或继续浏览下面的相关文章希望大家以后多多支持www.887551.com!