Auditing

🔍 What Is It?

Spring Data JPA Auditing provides automatic population of audit fields:

Temporal auditing:

• →@CreatedDate — set when entity is first persisted
• →@LastModifiedDate — updated on every modification

User auditing:

• →@CreatedBy — who created the entity
• →@LastModifiedBy — who last modified it

Setup requirements:

1. @EnableJpaAuditing on a @Configuration class
2. @EntityListeners(AuditingEntityListener.class) on entities
3. AuditorAware<T> bean for user auditing
4. Annotate fields with audit annotations

🎯 Why Do We Need It?

Without auditing, you'd manually set timestamps in every service method:

order.setCreatedAt(LocalDateTime.now()); // easy to forget
order.setUpdatedAt(LocalDateTime.now()); // must be in every update
order.setCreatedBy(currentUser);         // must get user everywhere

With Spring auditing, it's automatic. Forget to set it? Spring sets it anyway. This eliminates an entire class of bugs where audit fields are inconsistent or missing.

🏗️ What Happens in Real Projects?

Every enterprise entity has audit fields:

• →created_at, updated_at — on every table
• →created_by, updated_by — for compliance and debugging
• →Soft delete: deleted_at, deleted_by
• →Audit trail tables: separate table logging every change

Regulatory requirements (GDPR, SOX, HIPAA) often mandate audit trails.

⚙️ How It Works

AuditingEntityListener is a JPA entity listener. Before persist and merge operations, it reads the current auditor from AuditorAware and sets the annotated fields. Spring Security integration reads the current authenticated user automatically.

💻 Example

Auditing Setup — Base entity with auditing and AuditorAware integration.

// Base class — all entities extend this
@MappedSuperclass
@EntityListeners(AuditingEntityListener.class)
public abstract class BaseEntity {

    @CreatedDate
    @Column(name = "created_at", nullable = false, updatable = false)
    private LocalDateTime createdAt;

    @LastModifiedDate
    @Column(name = "updated_at")
    private LocalDateTime updatedAt;

    @CreatedBy
    @Column(name = "created_by", updatable = false, length = 100)
    private String createdBy;

    @LastModifiedBy
    @Column(name = "updated_by", length = 100)
    private String updatedBy;

    // Version for optimistic locking
    @Version
    private Long version;

    // Getters
    public LocalDateTime getCreatedAt() { return createdAt; }
    public LocalDateTime getUpdatedAt() { return updatedAt; }
    public String getCreatedBy() { return createdBy; }
    public String getUpdatedBy() { return updatedBy; }
    public Long getVersion() { return version; }
}

// Entity using the base class
@Entity
@Table(name = "orders")
public class Order extends BaseEntity {
    @Id
    @GeneratedValue(strategy = GenerationType.SEQUENCE)
    private Long id;
    // ... other fields
}

🤔 Common Confusions

🚨 Common Production Issues

✅ Best Practices

🏛️ Architect's Note

💬 Frequently Asked Questions

🎯 Key Takeaways

🔗 Related Topics

🎯 Practice this topic in interviews

↗ Where this topic fits