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


Posted in Java/Android onJune 26, 2021

我最新最全的文章都在 南瓜慢说 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 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}

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

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

3 总结

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

到此这篇关于Spring Data JPA的Audit功能审计数据库的变更的文章就介绍到这了,更多相关Spring Data JPA审计数据库变更内容请搜索三水点靠木以前的文章或继续浏览下面的相关文章希望大家以后多多支持三水点靠木!

Java/Android 相关文章推荐
深入理解以DEBUG方式线程的底层运行原理
Jun 21 Java/Android
ObjectMapper 如何忽略字段大小写
Jun 29 Java/Android
java泛型通配符详解
Jul 25 Java/Android
dubbo集成zipkin获取Traceid的实现
Jul 26 Java/Android
SpringDataJPA实体类关系映射配置方式
Dec 06 Java/Android
Java由浅入深通关抽象类与接口(上篇)
Apr 26 Java/Android
详解Spring Bean的配置方式与实例化
Jun 10 Java/Android
Java异常体系非正常停止和分类
Jun 14 Java/Android
Springboot中如何自动转JSON输出
Jun 16 Java/Android
Spring中bean集合注入的方法详解
Jul 07 Java/Android
Java代码规范与质量检测插件SonarLint的使用
Aug 05 Java/Android
Spring Boot 启动、停止、重启、状态脚本
详解Java分布式事务的 6 种解决方案
Jun 26 #Java/Android
自从在 IDEA 中用了热部署神器 JRebel 之后,开发效率提升了 10(真棒)
图解排序算法之希尔排序Java实现
Netty结合Protobuf进行编解码的方法
Java常用工具类汇总 附示例代码
Java多条件判断场景中规则执行器的设计
You might like
PHP默认安装产生系统漏洞
2006/10/09 PHP
PHP连接MSSQL2008/2005数据库(SQLSRV)配置实例
2014/10/22 PHP
php htmlentities()函数的定义和用法
2016/05/13 PHP
PHP实现的pdo连接数据库并插入数据功能简单示例
2019/03/30 PHP
laravel 解决paginate查询多个字段报错的问题
2019/10/22 PHP
JS Array对象入门分析
2008/10/30 Javascript
JQuery从头学起第三讲
2010/07/06 Javascript
js加密解密字符串可自定义密码因子
2014/05/13 Javascript
jQuery基于扩展实现的倒计时效果
2016/05/14 Javascript
JS实现的打字机效果完整实例
2016/06/20 Javascript
jQuery层级选择器_动力节点节点Java学院整理
2017/07/04 jQuery
基于jQuery实现无缝轮播与左右点击效果
2018/05/13 jQuery
vue实现动态按钮功能
2019/05/13 Javascript
JavaScript实现PC端四格密码输入框功能
2020/02/19 Javascript
如何配置vue.config.js 处理static文件夹下的静态文件
2020/06/19 Javascript
[02:41]2015国际邀请赛中国区预选赛观战指南
2015/05/20 DOTA
[02:12]2015国际邀请赛 SHOWOPEN
2015/08/05 DOTA
使用python获取CPU和内存信息的思路与实现(linux系统)
2014/01/03 Python
python使用MySQLdb访问mysql数据库的方法
2015/08/03 Python
Python简单计算数组元素平均值的方法示例
2017/12/26 Python
Python中时间datetime的处理与转换用法总结
2019/02/18 Python
Python里字典的基本用法(包括嵌套字典)
2019/02/27 Python
Python 正则表达式爬虫使用案例解析
2019/09/23 Python
Win10 安装PyCharm2019.1.1(图文教程)
2019/09/29 Python
Django 框架模型操作入门教程
2019/11/05 Python
在TensorFlow中屏蔽warning的方式
2020/02/04 Python
Python使用xlrd实现读取合并单元格
2020/07/09 Python
python入门:argparse浅析 nargs='+'作用
2020/07/12 Python
python模拟点击在ios中实现的实例讲解
2020/11/26 Python
党支部书记岗位责任制
2014/02/11 职场文书
高中生学习计划书
2014/09/15 职场文书
企业年会祝酒词
2015/08/11 职场文书
python简单验证码识别的实现过程
2021/06/20 Python
java设计模式--三种工厂模式详解
2021/07/21 Java/Android
浅谈JavaScript浅拷贝和深拷贝
2021/11/07 Javascript
利用正则表达式匹配浮点型数据
2022/05/30 Java/Android