springDataJpa入门教程（8）-JPA EnableJpaAuditing 审计功能

最新推荐文章于 2024-08-08 16:37:19 发布
最新推荐文章于 2024-08-08 16:37:19 发布
阅读量2.6k 收藏 14
点赞数
分类专栏： springDataJpa java
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/hgq0916/article/details/100608909
版权

springDataJpa入门教程

springDataJpa入门教程（8）-JPA EnableJpaAuditing 审计功能

在实际的业务系统中，往往需要记录表数据的创建时间、创建人、修改时间、修改人。每次手动记录这些信息比较繁琐，springDataJpa的审计功能可以帮助我们来做这些繁琐的配置，下面来讲一讲springDataJpa的审计功能怎么使用。有需要源码的朋友，请到git上下载源码，源码地址：源码下载地址。java学习交流群：184998348,欢迎大家一起交流学习。

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

package com.thizgroup.jpa.study.config;

import java.util.Optional;
import org.springframework.context.annotation.Configuration;
import org.springframework.data.domain.AuditorAware;

@Configuration//使用jpa审计功能，保存数据时自动插入创建人id和更新人id
public class UserAuditorAware implements AuditorAware<Long> {

  @Override
  public Optional<Long> getCurrentAuditor() {
    //从session中获取当前登录用户的id
    Long userId = 2L;
    return Optional.of(userId);
  }
}

2.在实体类中声明@EntityListeners和相应的注解
考虑到所有实体都需要声明，就写在BaseEntity中,其他的实体类通过继承BaseEntity来实现审计功能。

package com.thizgroup.jpa.study.model;


import java.io.Serializable;
import java.util.Date;
import javax.persistence.Column;
import javax.persistence.EntityListeners;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.MappedSuperclass;
import javax.persistence.Temporal;
import javax.persistence.TemporalType;
import lombok.Data;
import org.springframework.data.annotation.CreatedBy;
import org.springframework.data.annotation.CreatedDate;
import org.springframework.data.annotation.LastModifiedBy;
import org.springframework.data.annotation.LastModifiedDate;
import org.springframework.data.jpa.domain.support.AuditingEntityListener;

@MappedSuperclass//这个注解的意思是这个类jpa不会为它创建数据库表，
//jpa会将这个类的所有字段映射到它的子类的数据库表中
@Data
@EntityListeners(AuditingEntityListener.class)//对实体属性变化的跟踪，它提供了保存前，保存后，更新前，
// 更新后，删除前，删除后等状态，就像是拦截器一样，你可以在拦截方法里重写你的个性化逻辑。
public abstract class BaseEntity   implements Serializable {

  @Id
  @GeneratedValue(strategy = GenerationType.IDENTITY)
  protected Long id;

  @CreatedDate//自动填充创建时间
  @Temporal(TemporalType.TIMESTAMP)
  @Column(name = "create_date",columnDefinition = "timestamp")
  protected Date createDate;//创建时间

  @LastModifiedDate//自动填充修改时间
  @Temporal(TemporalType.TIMESTAMP)
  @Column(name = "modify_date",columnDefinition = "timestamp")
  protected Date modifyDate;//修改时间

  @CreatedBy//自动填充创建人
  @Column(name = "created_by",columnDefinition = "bigint")
  protected Long createdBy;//创建人

  @LastModifiedBy//自动填充修改人
  @Column(name = "last_modify_by",columnDefinition = "bigint")
  protected Long lastModifyBy;//修改人

}

然后在子类中继承BaseEntity，下面以User类为例，

package com.thizgroup.jpa.study.model;

import java.util.Date;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.Table;
import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;

@Entity
@Table(name = "tb_user")
@Data//使用lombok生成getter、setter
@NoArgsConstructor//生成无参构造方法
public class User extends BaseEntity{

  @Column(name = "name",columnDefinition = "varchar(64)")
  private String name;

  @Column(name = "mobile",columnDefinition = "varchar(64)")
  private String mobile;

  @Column(name = "email",columnDefinition = "varchar(64)")
  private String email;

  @Column(name = "age",columnDefinition = "smallint(64)")
  private Integer age;

  @Column(name = "birthday",columnDefinition = "timestamp")
  private Date birthday;

  //地址
  @Column(name = "address_id",columnDefinition = "bigint(20)")
  private Long addressId;

  @Builder(toBuilder = true)
  public User(Long id,String name, String mobile, String email, Integer age, Date birthday,
      Long addressId) {
    this.id = id;
    this.name = name;
    this.mobile = mobile;
    this.email = email;
    this.age = age;
    this.birthday = birthday;
    this.addressId = addressId;
  }
}
3.在Application 中启用审计@EnableJpaAuditing
package com.thizgroup.jpa.study;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.autoconfigure.domain.EntityScan;
import org.springframework.data.jpa.repository.config.EnableJpaAuditing;
import org.springframework.data.jpa.repository.config.EnableJpaRepositories;

@SpringBootApplication
//配置springDataJpa扫描Repository的包路径
@EntityScan(basePackages = {"com.thizgroup.jpa.study.model","com.thizgroup.jpa.study.dto"})
@EnableJpaRepositories("com.thizgroup.jpa.study.dao")
@EnableJpaAuditing//启动jpa审计功能
public class JpaApplication {

  public static void main(String[] args) {
    SpringApplication.run(JpaApplication.class,args);
  }

}

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

接下来，写个例子来测试一下，在UserService接口添加一个保存用户的方法，

package com.thizgroup.jpa.study.service;

import com.thizgroup.jpa.study.model.User;
import java.util.List;

/**
 * 用户服务
 */
public interface IUserService {
	  /**
   * 添加用户
   * @param user
   * @return
   */
  User addUser(User user);
}

然后在UserServiceImpl实现类实现该方法，

 @Override
  public User addUser(User user) {
    User savedUser = userRepository.save(user);
    return savedUser;
  }

写个单元测试来验证下jpa审计是否生效，

package com.thizgroup.jpa.study.service;

import com.thizgroup.jpa.study.JpaApplication;
import com.thizgroup.jpa.study.model.User;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.annotation.Rollback;
import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
import org.springframework.transaction.annotation.Propagation;
import org.springframework.transaction.annotation.Transactional;

@SpringBootTest(classes={JpaApplication.class})
@RunWith(SpringJUnit4ClassRunner.class)
@Transactional(readOnly = false,propagation = Propagation.REQUIRED)
public class UserServiceImplTest {

  @Autowired
  private IUserService userService;

   @Test
  @Rollback(value = false)
  public void addUserTest(){
    User user = User.builder()
        .name("李元芳")
        .email("yuanfang@qq.com")
        .birthday(DateUtils.parse("1998-09-08 12:14:15", "yyyy-MM-dd HH:mm:ss"))
        .age(30)
        .mobile("18755634343")
        .build();
    userService.addUser(user);
  }
}

运行一下单元测试，结果如下：
在这里插入图片描述
好了，至此，springDataJpa功能就介绍完了，有需要源码的朋友，请到git上下载源码，源码地址：https://github.com/hgq0916/springdatajpa-study.git。java学习交流群：184998348,欢迎大家一起交流学习。

上一篇：springDataJpa入门教程（7）-基于springDataJpa投影(Projection)返回自定义实体类对象
下一篇：springDataJpa入门教程（9）-spring jpa实体属性类型转换器AttributeConverter的用法
奔腾的野马
关注
  • 0
    点赞
  • 踩
  • 14
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
Spring Data Jpa 审计功能
北辰
07-01 296
Spring Data Jpa的审计功能需要引入下述依赖 <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-data-jpa</artifactId> <version>2.1.3.RELEASE</version> </dependency> 第一...
SpringData Jpa(1)SpringDataJpa入门
清茶与浊酒
07-16 176
一、SpringData Jpa 入门 maven依赖相关配置 <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-data-jpa</artifactId> </dependency> <dependency> <groupId>mysql</groupId> &
JPA EnableJpaAuditing 审计功能
weixin_33881753的博客
05-22 553
关于自动填充或更新实体中的 CreateDate、CreatedBy 等在之前有一篇 jeecg 默认为空的字段值是如何被填充的? 有提到通过拦截器的方式实现，但是今天带大家了解一下如果使用 JPA 的审计功能是如何简单实现该操作的。 JPA Audit 说明 在 Spring JPA 中，支持在字段或者方法上进行注解 @CreateDate、@CreatedBy、@LastMod...
【源码】Spring Data JPA原理解析之Auditing执行原理
JingAi_jia917的博客
06-24 943
本篇从源码的角度分享了Spring Data JPA中的Auditing审计功能的实现原理，重点分析了AuditingEntityListener、JpaAuditingRegistrar、AuditingBeanDefinitionRegistrarSupport、AuditHandler、AuditingHandlerSupport、AnnotationAuditingMetadata的源码
JPA之@EnableJpaAuditing注解
qq_41030039的博客
02-18 1万+
在Spring JPA中，支持在字段或方法上进行注解 @CreateDate、@CreatedBy、@LastModifiedDate、@LastModifiedBy。具体含义： **@CreateDate： ** 表示该字段是创建时间字段，在这个实体被insert的时候，会自动填充创建的时间，不用手动填充该字段。 **@CreatedBy： ** 表示该字段是创建人字段，在这个实体被insert...
Spring JPA Data Auditing
云淡风轻
10-18 1255
官方文档 baeldung 示例 注意： 来自官方文档： If you have multiple implementations registered in the ApplicationContext, you can select the one to be used by explicitly setting the auditorAwareRef attribute of
Spring Data JPA教程：审计（二）
RO_wsy的专栏
03-05 1万+
书接上文http://blog.csdn.net/ro_wsy/article/details/50767207本文解决第二个问题，我们将为实体加上创建者和修改者的信息。首先创建一个返回授权用户信息的组件。获取授权用户信息Spring Data JPA使用AuditorAware<T>接口获取用户信息，AuditorAware接口的泛型参数T描述了实体类中审计人的类型。现在开始创建一个返回用户信息的
spring-data-jpa-entity-graph:Spring Data JPA扩展允许在存储库上完全动态使用EntityGraph
05-06
没有spring-data-jpa-entity-graph的生活 仅通过注释支持EntityGraph。 因此，对于存储库方法，必须在编译之前最多选择一个EntityGraph。 这样可以避免您在考虑运行时上下文的情况下选择最佳的EntityGraph :broken_...
最详细的Spring-data-jpa入门（一）
热门推荐
此成非彼诚博客
08-13 9万+
刚进公司，人生地不熟，偷偷藏着本《mybatis入土为安》，以为可以靠mybatis混的轻松点，谁知天有不测风云，大家用的是JPA。我这个小白没有听说过，全英文名叫，就是java持久化api，是SUN公司推出的一套基于的规范。持久化想必如雷贯耳，都0202年了，谁还不用个持久化框架啊，举起mybatis。ORM呢？全英文名为：对象关系映射，简单来说为了不用JDBC那一套原始方法来操作数据库，ORM框架横空出世（mybatis、hibernate等等）。...
Spring Data JPA 简单查询--方法定义规则(详解)
08-30
Spring Data JPA 是一个强大的框架，它简化了与Java Persistence API (JPA) 的交互，尤其是在数据查询方面。本文将详细解析Spring Data JPA 的简单查询方法定义规则，帮助开发者更好地理解和利用这一特性。 首先，...
spring-data-jpa-examples-master.rar_spring data jpa
09-19
【标题】"spring-data-jpa-examples-master.rar_spring data jpa" 提供了一个关于Spring Data JPA的实际应用示例，这是一个广泛使用的Java框架，它简化了与数据库的交互，特别是通过JPA（Java Persistence API）进行...
spring-data-jpa-2.0.9.RELEASE-API文档-中文版.zip
06-25
赠送jar包：spring-data-jpa-2.0.9.RELEASE.jar； 赠送原API文档：spring-data-jpa-2.0.9.RELEASE-javadoc.jar； 赠送源代码：spring-data-jpa-2.0.9.RELEASE-sources.jar； 赠送Maven依赖信息文件：spring-data-jpa...
Spring Data JPA 之 Auditing
曾小二的博客
08-01 1359
Auditing是帮我们做审计⽤的，当我们操作⼀条记录的时候，需要知道这是谁创建的、什么时间创建的、最后修改⼈是谁、最后修改时间是什么时候，甚⾄需要修改记录……
springboot的jpa审计Auditing
最新发布
cnzzs的博客
08-08 389
一、开启jpa审计EnableJpaAuditingConfig.java登录后复制 package com.imddy.tehuoexch.config; import org.springframework.context.annotation.Configuration; import org.springfra...
Spring boot 启用 Spring Data JPA Auditing（审计功能）
weixin_43861942的博客
04-14 1811
一、Auditing功能简介 先贴上Spring Data JPA的官方文档：https://docs.spring.io/spring-data/jpa/docs/2.0.9.RELEASE/reference/html/ 项目中每条数据在创建修改的时候，我们都需要记录它创建人，创建时间，修改人，修改时间。如果每次新增的时候都去手动set，代码冗余且显得很不友好 spring data JPA ...
快速学习Spring Data JPA -- 第七章JPA扩展Auditing
xlecho的博客
10-29 1053
xl_echo编辑整理，交流学习请加1280023003 百战不败，依不自称常胜，百败不颓，依能奋力前行。——这才是真正的堪称强大！！ 整个JPA框架的东西很多，前面的一至六章其实已经可以满足我们工作中的大部分需求。那么还有一小部分比较不常用的我们就开始归纳到第七章及后面的章节。本章我们主要讲Auditing及其事件详解，了解它的主要作用及使用。 Auditing的作用可以直接归纳为帮助我们...
Spring Data——JPA的Auditing（审计）功能
程序员阿皓的博客
04-27 386
在保存或更新User对象时，JPA会自动填充这些审计信息。可以通过配置实现自定义的审计信息填充逻辑，比如从当前登录用户中。在这个示例中，定义了一个User实体类，其中使用了Spring Data JPA提供的注解来实现审计功能。通过使用JPA的审计功能，可以在实体类中自动记录这些审计信息，而无需手动处理。JPA的审计（Auditing）功能允许开发人员跟踪实体的。注解用于自动记录创建时间和修改时间；注解用于记录创建者和修改者。
JPA Audit and Envers
nvd11的专栏
09-04 448
而使用ValidityAuditStrategy，在新增一条变更记录时，会更新上一条变更记录的REVEND，REVEND_TSTMP为当前的版本号以及变更时间。在一些数据敏感的项目， 特别是配置表， 我们需要记录每一次对表的甚至每个值的改动， 并把改动的数据存放到另一张表中。如果对Audit 的要求不高， 只需要在表中记录是谁创建的， 谁最后修改，创建时间和最后修改时间。下面来看是怎么实现的， 我们会用user service 作为例子.执行上面的都测试用例， 可以见到1个新的AUD表被创建。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值