Spring?Data?JPA實現(xiàn)審計功能過程詳解

更新時間：2023年02月23日 10:09:34 作者：Bug解決者

Spring?Data?JPA為跟蹤持久性層的變化提供了很好的支持。通過使用審核，我們可以存儲或記錄有關(guān)實體更改的信息，例如誰創(chuàng)建或更改了實體以及何時進(jìn)行更改

在項目中每條數(shù)據(jù)在創(chuàng)建修改的時候，我們都需要記錄創(chuàng)建人，創(chuàng)建時間，修改人，修改時間等信息。如果每次新增的時候都去手動set，代碼冗余且顯得很不友好。

下面給大家分享如何使用Spring Data JPA完成審計功能：

實現(xiàn)該功能，主要涉及到下列注解：

@EnableJpaAuditing注解：啟用JPA審計功能開關(guān)。
@CreatedBy注解：創(chuàng)建人，當(dāng)實體被insert的時候，會設(shè)置值。
@LastModifiedBy注解：最后一次修改者，當(dāng)實體每次被update的時候，會設(shè)置值。
@CreatedDate注解：創(chuàng)建日期，當(dāng)實體被insert的時候，會設(shè)置值。
@LastModifiedDate注解：最后一次修改日期，當(dāng)實體每次被update的時候，會設(shè)置值。

如何使用

一、引入依賴；

<dependency>
     <groupId>org.springframework.boot</groupId>
     <artifactId>spring-boot-starter-data-jpa</artifactId>
</dependency>

二、實現(xiàn)AuditorAware接口，來自定義獲取用戶的信息；在實際項目中需要從用戶權(quán)限模塊中獲取到當(dāng)前登錄用戶的實際信息；

package com.xxkfz.simplememory.config;
import org.springframework.context.annotation.Configuration;
import org.springframework.data.domain.AuditorAware;
import java.util.Optional;
/**
 * @version 1.0.0
 * @ClassName SpringSecurityAuditorAware.java
 * @Description 通過實現(xiàn)AuditorAware<T>接口自定義獲取用戶信息
 */
@Configuration
public class SpringSecurityAuditorAware implements AuditorAware<String> {
    @Override
    public Optional<String> getCurrentAuditor() {
        return Optional.of("xxkfz");
    }
}

三、創(chuàng)建實體類，并標(biāo)記審計屬性；

package com.xxkfz.simplememory.entity;
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;
import javax.persistence.*;
import java.util.Date;
/**
 * @ClassName SysUser.java
 * @Description TODO
 */
@Data
@EntityListeners({AuditingEntityListener.class})
@Entity
@Table(name = "t_user")
public class SysUser {
    @Id
    @Column(name = "id")
    private String id;
    @Column(name = "username")
    private String username;
    @Column(name = "password")
    private String password;
    @CreatedBy
    @Column(name = "created_by")
    private String createdBy;
    @LastModifiedBy
    @Column(name = "last_modified_by")
    private String lastModifiedBy;
    @CreatedDate
    @Column(name = "created_date")
    private Date createdDate;
    @LastModifiedDate
    @Column(name = "last_modified_date")
    private Date lastModifiedDate;
    @Column(name = "real_name")
    private String realName;
}

四、創(chuàng)建JPA Repository接口實現(xiàn)，用于對數(shù)據(jù)訪問；

package com.xxkfz.simplememory.repository;
import com.xxkfz.simplememory.entity.SysUser;
import org.springframework.data.jpa.repository.JpaRepository;
import org.springframework.stereotype.Repository;
/**
 * @ClassName UserRepository.java
 * @Description JPA Repository接口實現(xiàn)，用于對數(shù)據(jù)庫的訪問
 */
@Repository
public interface UserRepository extends JpaRepository<SysUser, String> {
}

五、在啟動類上添加注解@EnableJpaAuditing

package com.xxkfz.simplememory;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.data.jpa.repository.config.EnableJpaAuditing;
@EnableJpaAuditing
@SpringBootApplication
public class SimpleMemoryApplication {
    public static void main(String[] args) {
        SpringApplication.run(SimpleMemoryApplication.class, args);
    }
}

六、編寫測試類，進(jìn)行測試；

package com.xxkfz.simplememory.controller.system;
import cn.hutool.core.lang.UUID;
import com.xxkfz.simplememory.entity.SysUser;
import com.xxkfz.simplememory.mapper.SysOrderMapper;
import com.xxkfz.simplememory.repository.UserRepository;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;
/**
 * @ClassName SysUserController.java
 * @Description TODO
 */
@RestController
@RequestMapping("/sys_user")
@Slf4j
public class SysUserController {
    @Autowired
    UserRepository userRepository;
    @GetMapping("save")
    public void save() {
        SysUser user = new SysUser();
        user.setId(UUID.fastUUID().toString());
        user.setUsername("公眾號【SimpleMemory】");
        SysUser sysUser = userRepository.save(user);
        log.info("sysUser === {}", sysUser);
    }
    @GetMapping("update")
    public void update() {
        SysUser sysUser = userRepository.getById("1");
        sysUser.setUsername("admin");
        SysUser updateSysUser = userRepository.save(sysUser);
        log.info("updateSysUser === {}", updateSysUser);
    }
}

到此這篇關(guān)于Spring Data JPA實現(xiàn)審計功能過程詳解的文章就介紹到這了,更多相關(guān)Spring Data JPA實現(xiàn)審計內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: