文章详情

短信预约-IT技能 免费直播动态提醒

请输入下面的图形验证码

提交验证

短信预约提醒成功

JPA之@EnableJpaAuditing注解使用

2024-04-02 19:55

关注

@EnableJpaAuditing注解使用

在Spring JPA中,支持在字段或方法上进行注解 @CreateDate、@CreatedBy、@LastModifiedDate、@LastModifiedBy。具体含义:

如何实现自动填充功能,即如何使用审计?

1、在Xxx Application 启动类上添加 @EnableJpaAuditing:开启审计功能。


@EnableScheduling
@EnableJpaAuditing //利用jpa可以给MySQL列属性自动赋值,例如一些创建时间,修改时间
@EnableEurekaClient
@SpringBootApplication
public class CouponTemplateApplication {
    public static void main(String[] args) {
        SpringApplication.run(CouponTemplateApplication.class, args);
    }
 
    @Bean
    public UserAuditor setUserAuditorAware(){
        return new UserAuditor();
    }
}

2、实体类上添加 @EntityListeners(AuditingEntityListener.class):开启实体类监听。

3、在需要的字段上加上 @CreatedDate、@CreatedBy、@LastModifiedDate、@LastModifiedBy 等注解。


@Data
@NoArgsConstructor
@AllArgsConstructor
@Entity  //实体类
@EntityListeners(AuditingEntityListener.class) //监听器,自动赋值创建时间
@Table(name = "coupon_template")
@JsonSerialize(using = CouponTemplateSerialize.class) //绑定自定义的序列化器
public class CouponTemplate implements Serializable {
    
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    @Column(name = "id",nullable = false)
    @Basic //指定属于我们数据表的一个列,相反的@Transient,表示该列不属于数据表
    private Integer id;
    
    @Column(name = "available",nullable = false)
    private Boolean available;
    
    @Column(name = "expired",nullable = false)
    private Boolean expired;
    
    @Column(name = "name",nullable = false)
    private String name;
    
    @Column(name = "logo",nullable = false)
    private String logo;
    
    @Column(name = "intro",nullable = false)
    private String desc;
    
    
    @CreatedDate
    @Column(name = "create_time",nullable = false)
    private Date createTime;
}

4、实现 AuditorAware 接口来返回你需要插入的值。重点!


@Configuration
@Slf4j
public class UserAuditor implements AuditorAware<String> {
    
    @Override
    public Optional<String> getCurrentAuditor() {
        UserDetails user;
        try {
            user = (UserDetails) SecurityContextHolder.getContext().getAuthentication().getPrincipal();
            return Optional.ofNullable(user.getUsername());
        }catch (Exception e){
            return Optional.empty();
        }
    }
}

Springboot启用Spring Data JPA Auditing(审计功能)

Auditing功能简介

先贴上Spring Data JPA的官方文档

项目中每条数据在创建修改的时候,我们都需要记录它创建人,创建时间,修改人,修改时间。如果每次新增的时候都去手动set,代码冗余且显得很不友好

spring data JPA 为我们提供了审计功能,英文是 Auditing

在这里插入图片描述

Auditing包括了四个注解,从名字就能看出它们的作用

如何启用

1.启动类上加@EnableJpaAuditing注解

在这里插入图片描述

2.实体类上加@EntityListeners(AuditingEntityListener.class)

在这里插入图片描述

3.属性上面使用对应注解

在这里插入图片描述

使用CreatedBy和LastModifiedBy时

JPA并不知道你的这个字段的值是什么,需要自己实现AuditorAware接口


import org.springframework.context.annotation.Configuration;
import org.springframework.data.domain.AuditorAware;
import org.springframework.security.core.context.SecurityContextHolder;
import org.springframework.security.core.userdetails.UserDetails;
import java.util.Optional;

@Configuration
public class SpringSecurityAuditorAware  implements AuditorAware<String> {
    @Override
    public Optional<String> getCurrentAuditor() {
        UserDetails userDetails;
        try {
            userDetails =  (UserDetails)SecurityContextHolder.getContext().getAuthentication().getPrincipal();
            return Optional.ofNullable(userDetails.getUsername());
        }catch (Exception e){
            return Optional.empty();
        }
    }

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

阅读原文内容投诉

免责声明:

① 本站未注明“稿件来源”的信息均来自网络整理。其文字、图片和音视频稿件的所属权归原作者所有。本站收集整理出于非商业性的教育和科研之目的,并不意味着本站赞同其观点或证实其内容的真实性。仅作为临时的测试数据,供内部测试之用。本站并未授权任何人以任何方式主动获取本站任何信息。

② 本站未注明“稿件来源”的临时测试数据将在测试完成后最终做删除处理。有问题或投稿请发送至: 邮箱/279061341@qq.com QQ/279061341

软考中级精品资料免费领

  • 历年真题答案解析
  • 备考技巧名师总结
  • 高频考点精准押题
  • 2024年上半年信息系统项目管理师第二批次真题及答案解析(完整版)

    难度     813人已做
    查看
  • 【考后总结】2024年5月26日信息系统项目管理师第2批次考情分析

    难度     354人已做
    查看
  • 【考后总结】2024年5月25日信息系统项目管理师第1批次考情分析

    难度     318人已做
    查看
  • 2024年上半年软考高项第一、二批次真题考点汇总(完整版)

    难度     435人已做
    查看
  • 2024年上半年系统架构设计师考试综合知识真题

    难度     224人已做
    查看

相关文章

发现更多好内容

猜你喜欢

AI推送时光机
位置:首页-资讯-后端开发
咦!没有更多了?去看看其它编程学习网 内容吧
首页课程
资料下载
问答资讯