脚本之家 服务器常用软件
快捷导航
您的位置：首页 → 软件编程 → java → Spring Data JPA审计数据库变更

Spring Data JPA的Audit功能审计数据库的变更

 更新时间：2021年06月26日 09:48:03   作者：南瓜慢说  
数据库审计是指当数据库有记录变更时，可以记录数据库的变更时间和变更人等，这样以后出问题回溯问责也比较方便，本文讨论Spring Data JPA审计数据库变更问题，感兴趣的朋友一起看看吧

我最新最全的文章都在 南瓜慢说 www.pkslow.com ，欢迎大家来喝茶！

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 Security的Context来获取登陆用户的名字，当然可以有其它方案，如获取请求头的某个字段等。

注意注解@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审计数据库变更内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

相关文章

  • java实现二维码生成的几个方法（推荐）

    java实现二维码生成的几个方法（推荐）

    本篇文章主要介绍了java实现二维码生成的几个方法（推荐），具有一定的参考价值，有兴趣的可以了解一下。
    2016-12-12
  • 学习JVM之java内存区域与异常

    学习JVM之java内存区域与异常

    关于JVM内存区域的知识对于初学者来说其实是很重要的，了解Java内存分配的原理，这对于以后JAVA的学习会有更深刻的理解。下面来看看详细介绍。
    2016-07-07
  • Java动态加载类示例详解

    Java动态加载类示例详解

    这篇文章主要给大家介绍了关于Java动态加载类的相关资料，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
    2021-02-02
  • String.intern()作用与常量池关系示例解析

    String.intern()作用与常量池关系示例解析

    这篇文章主要为大家介绍了String.intern()作用与常量池关系示例解析,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2023-08-08
  • servlet之cookie简介_动力节点Java学院整理

    servlet之cookie简介_动力节点Java学院整理

    Cookie技术诞生以来，它就成了广大网络用户和Web开发人员争论的一个焦点。下面这篇文章主要给大家介绍了关于servlet之cookie简介的相关资料，文中介绍的非常详细，需要的朋友可以参考借鉴，下面来一起看看吧。
    2017-07-07
  • java数据结构与算法之插入算法实现数值排序示例

    java数据结构与算法之插入算法实现数值排序示例

    这篇文章主要介绍了java数据结构与算法之插入算法实现数值排序的方法,结合简单实例形式分析了插入算法的节点操作与排序相关实现技巧,需要的朋友可以参考下
    2016-08-08
  • Mybatis-Spring源码分析图解

    Mybatis-Spring源码分析图解

    这篇文章主要介绍了Mybatis-Spring源码分析,本文通过实例代码图文相结合给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
    2021-11-11
  • Java对类私有变量的暴力反射技术讲解

    Java对类私有变量的暴力反射技术讲解

    今天小编就为大家分享一篇关于Java对类私有变量的暴力反射技术讲解，小编觉得内容挺不错的，现在分享给大家，具有很好的参考价值，需要的朋友一起跟随小编来看看吧
    2019-03-03
  • Spring源码学习之动态代理实现流程

    Spring源码学习之动态代理实现流程

    这篇文章主要给大家介绍了关于Spring源码学习之动态代理实现流程的相关资料，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
    2021-03-03
  • 基于java实现租车管理系统

    基于java实现租车管理系统

    这篇文章主要为大家详细介绍了基于java实现租车管理系统，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
    2020-12-12

最新评论