[Spring Data JPA] Auditing

🪄 Auditing?

Auditing은 ‘감시’라는 뜻을 갖고 있는데, Spring Data에서는 Auditing으로 누가 Entity를 생성하고 변경했는지에 대한 시점을 투명하게 추적할 수 있게 해주는 메타데이터를 제공한다. 생성된 모든 Entity에 생성된 시간과 수정된 시간을 일일이 적어주는 것은 번거롭고 귀찮기도 하지만, 다음과 같은 문제점이 생긴다.

모든 객체에 다 필요함 ⇒ 코드를 일일이 다 작성해줘야 됨 ⇒ 실수로 빼먹음 / 코드 중복

🪄 Using Auditing

✨ add dependencies in build.gradle

dependencies {
    implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
}

🪄 Use Auditing with code

👩🏻‍💻 BaseTime.java

• 객체를 생성하고 수정할 때 저장되는 시간을 기록해줄 BaseTime Entity를 생성한다.

import lombok.Getter;
import org.springframework.data.annotation.CreatedDate;
import org.springframework.data.annotation.LastModifiedDate;
import org.springframework.data.jpa.domain.support.AuditingEntityListener;

import javax.persistence.Column;
import javax.persistence.EntityListeners;
import javax.persistence.MappedSuperclass;
import java.time.LocalDateTime;

@Getter
@MappedSuperclass
@EntityListeners(AuditingEntityListener.class)
public abstract class BaseTime {
		
    @CreatedDate
    @Column(updatable = false)
    private LocalDateTime createdAt;

    @LastModifiedDate 
    private LocalDateTime modifiedAt;
}

✨ @EntityListeners(AuditingEntityListener.class)

• 클래스레벨에 위치하며, 생성시간, 수정시간을 자동화하겠다고 알려준다.
• AuditingEntityListner 안에 touchForCreate / touchForUpdate 이 구현되어 있다.

✨ @MappedSuperclass

• 객체에는 상속이 있지만 테이블에는 상속이 없는데 어떻게 매핑할까? 이 때 @MappedSuperclass를 사용하면 된다.
• 상속받은 상위클래스의 필드변수들이 컬럼과 매핑된다.

✨ @CreatedDate

• Entity가 생성되고 저장될 때 시간이 자동으로 저장된다.

✨ @Column(updatable = false)

• 생성 시간은 생성할 때 한 번만 기록되는 시간으로 수정되면 안 되기 때문에 updatable을 false로 한다. 실수로 값을 바꿔도 수정된 값이 저장되지 않는다.

✨ @ LastModifiedDate

• Entity 값을 수정하고 저장할 때 변경된 시간이 자동으로 저장된다.

👩🏻‍💻 AuditingEntity.java

• Entity 클래스에 BaseTime를 상속한다.

import lombok.Getter;
import lombok.NoArgsConstructor;
import lombok.Setter;
import auditing.BaseTime;

import javax.persistence.*;

@Entity
@Getter
@Setter
@NoArgsConstructor
public class AuditingEntity extends BaseTime {
    @Id @GeneratedValue
    @Column(name = "auditing_id")
    private Long id;

    private String name;
    private String hobby;
}

👩🏻‍💻 SpringBootApplication.java

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

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

✨ @EnableJpaAuditing

• 마지막으로 Spring Data JPA에서 Auditing을 사용하려면 SpringBoot에 클래스 레벨에 @EnableJpaAuditing을 적어서 알려줘야 한다.

✅ Ref.

https://docs.spring.io/spring-data/jpa/docs/1.7.0.DATAJPA-580-SNAPSHOT/reference/html/auditing.html