编辑“︁Spring审计”︁

{{DISPLAYTITLE:Spring审计}}  
'''Spring审计'''是Spring框架中用于自动追踪实体变更（如创建时间、修改时间、操作用户等）的机制，常用于记录数据的历史操作。它通过注解和接口实现自动化管理，适用于需要合规性检查、版本控制或操作日志的场景。  

== 核心概念 ==  
Spring审计分为两类：  
* '''时间审计'''：记录实体的创建时间（<code>@CreatedDate</code>）和最后修改时间（<code>@LastModifiedDate</code>）。  
* '''用户审计'''：记录实体的创建者（<code>@CreatedBy</code>）和最后修改者（<code>@LastModifiedBy</code>）。  

审计数据通常存储在实体类的字段中，由Spring Data自动填充。  

== 实现步骤 ==  
=== 1. 启用审计功能 ===  
在配置类中添加<code>@EnableJpaAuditing</code>：  
<syntaxhighlight lang="java">  
@Configuration  
@EnableJpaAuditing  
public class AuditConfig {  
    @Bean  
    public AuditorAware<String> auditorProvider() {  
        return () -> Optional.of("currentUser"); // 模拟当前用户  
    }  
}  
</syntaxhighlight>  

=== 2. 定义审计字段 ===  
实体类中添加审计字段并标注注解：  
<syntaxhighlight lang="java">  
@Entity  
@EntityListeners(AuditingEntityListener.class)  
public class Product {  
    @Id  
    private Long id;  

    @CreatedDate  
    private LocalDateTime createdAt;  

    @LastModifiedDate  
    private LocalDateTime updatedAt;  

    @CreatedBy  
    private String createdBy;  

    @LastModifiedBy  
    private String updatedBy;  
}  
</syntaxhighlight>  

=== 3. 操作示例 ===  
保存实体时，字段自动填充：  
<syntaxhighlight lang="java">  
Product product = new Product();  
productRepository.save(product);  
// 输出：createdAt=2023-10-01T10:00, createdBy=currentUser  
</syntaxhighlight>  

== 实际案例 ==  
'''场景：电商订单追踪'''  
审计字段记录订单创建时间和修改人，便于纠纷排查：  
<mermaid>  
classDiagram  
    class Order {  
        +Long id  
        +@CreatedDate LocalDateTime placedAt  
        +@LastModifiedBy String updatedBy  
    }  
</mermaid>  

== 高级配置 ==  
=== 自定义审计逻辑 ===  
通过实现<code>AuditorAware<T></code>接口动态获取当前用户（如从Spring Security上下文）：  
<syntaxhighlight lang="java">  
public class SecurityAuditorAware implements AuditorAware<String> {  
    @Override  
    public Optional<String> getCurrentAuditor() {  
        return Optional.ofNullable(SecurityContextHolder.getContext())  
                .map(SecurityContext::getAuthentication)  
                .map(Authentication::getName);  
    }  
}  
</syntaxhighlight>  

=== 时区处理 ===  
使用<code>@DateTimeFormat</code>定义时间格式：  
<syntaxhighlight lang="java">  
@CreatedDate  
@DateTimeFormat(pattern = "yyyy-MM-dd HH:mm")  
private LocalDateTime createdAt;  
</syntaxhighlight>  

== 数学表示 ==  
审计时间可视为函数：  
<math>  
f(entity) = \begin{cases}  
t_0 & \text{当 } entity \text{ 被创建} \\  
t_n & \text{当 } entity \text{ 第 } n \text{ 次修改}  
\end{cases}  
</math>  

== 总结 ==  
Spring审计通过自动化记录关键操作信息，显著减少手动编码量。结合Spring Security可实现完整的操作追踪体系，适用于金融、医疗等合规性要求高的领域。

[[Category:后端框架]]
[[Category:Spring]]
[[Category:Spring数据]]