Spring Data Auditing 적용하기

중간 중간 허리 핍시다

✏️ Entity의 기록 남기기

현업에서는 운영상에 발생할 이슈들을 추적할때 사용하기 위해 Entity마다 `생성시간`,`변경시간`등을 남긴다고 한다.

이번 프로젝트에서는 User Entity에 생성시간인 `createdAt`, 변경시간인 `modifiedAt`이 존재한다.

Entity 기록 남기기

@Entity
@Getter
public class UserDetail{

    @Column(name = "created_at")
    private LocalDateTime createdAt;

    @Column(name = "modified_at")
    private LocalDateTime modifiedAt;

    ...
}

🔄 시간 생성 및 갱신하는 방법

1. 직접 값 넣어주기 ( 비추천 🙅‍♂️ )

// 1. 생성
UserDetail createUserDetail(){
    return UserDetail.builder()
        .nickname("닉네임")
        .createdAt(LocalDateTime.now())     // 직접 값 넣어주기
        .modifiedAt(LocalDateTime.now())    // 직접 값 넣어주기
        .build();
}

// 2. 업데이트
@Transactional
void updateUserExpiration(UserDetail userDetail, LocalDateTime expiration) {
    userDetail.updateModifiedAt(LocalDateTime.now());   // 변경감지 이용하기
}

 

가장 쉬운 방법으로 직접 값을 넣어줌으로써 생성하거나, 시간을 업데이트 할 수 있다.

하지만 이 방식은 원초적이며, 잘못된 데이터가 들어가는 가능성 또한 존재하기 때문에 추천하지 않는다.

 

2. 순수 JPA 이용하기

@Entity
@Getter
@MappedSuperClass
public class UserDetail{

    @Column(name = "created_at")
    private LocalDateTime createdAt;

    @Column(name = "modified_at")
    private LocalDateTime modifiedAt;

    @PrePersist
    public void prePersist(){            
        createdAt = LocalDateTime.now();
        modifiedAt = LocalDateTime.now();
    }

    @PreUpdate
    public void preUpdate(){             
        modifiedAt = LocalDateTime.now();
    }
    
}

• `PrePersist` : Entity가 비영속 상태에서 영속 상태로 넘어가는 시점에서 실행된다.
• `PreUpdate` : 영속 상태의 Entity를 업데이트 하기전에 실행된다.

위 2가지 어노테이션을 이용해서 생성 혹은 업데이트가 발생했을때 시간을 자동으로 저장할 수 있다. ( 자동화가 최고다 후욱후욱 )

 

😎 Auditing 사용하기

Auditing이란 `감시, 감사`을 뜻하며, Spring Data JPA에서 Entity의 시간을 대해 자동으로 값을 넣어주는 기능을 말한다.

동작원리는 Auditing을 적용한 Entity의 이벤트를 감지해 이벤트 발생 시간 값을 넣어주는 것이다.

 

사용과정을 살펴보자.

1. @EnableJpaAuditing

@SpringBootApplication
@EnableJpaAuditing
public class AttractionApplication {

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

2. BaseAuditingEntity 만들기 ( AuditableEntity )

@Getter
@EntityListeners(AuditingEntityListener.class)
@MappedSuperclass
public class AuditableEntity {

  @CreatedDate
  @Column(updatable = false)
  private LocalDateTime createdAt;

  @LastModifiedDate
  private LocalDateTime modifiedAt;

}

Auditing을 적용할 필드( createdAt과 modifiedAt )를 가지는 BaseAuditingEntity 정의한다.

그리고 원하는 동작에 맞는 어노테이션을 선택해 필드에 지정해준다.

어노테이션내용

@CreatedDate	데이터 생성 날짜 자동 저장
@LastModifiedDate	데이터 수정 날짜 자동 저장
@CreatedBy	데이터 생성자 자동 저장
@LastModifiedBy	데이터 수정자 자동 저장

3. BaseAuditingEntity 적용시키기

@Entity
@Getter
public class UserDetail extends AuditableEntity{
    ...
}

마지막으로 사용할 Entity가 BaseAuditingEntity를 상속하게 만들면,

Entity는 createdAt와 modifiedAt를 가지게 되고, 해당 필드는 자동으로 생성 & 갱신된다.

 

🙆‍♂️ 적용 결과

Auditing 적용 결과

적용해본 결과, 따로 LocalDateTime 값을 넣어주지 않아도 Entity 생성 시간이 잘 저장되었고,

업데이트가 되었을때 시간 또한 저장되어있는 것을 확인할 수 있다.

 

내가 느낀 장점

1. 정확한 시간 데이터를 얻는 것이 자동화 되어있다.
2. 다른 Entity에도 쉽게 적용할 수 있어, 확장 및 유지보수가 좋다.
3. 핵심 Entity로부터 추적하기 위한 필드(createAt,modifiedAt)를 분리할 수 있어 Entity가 깔끔해진다.

하지만 단점도 존재한다고 한다.

1. JPA에 의존하고 상속을 사용한다.
2. Auditing 하는 필드가 많아지면 검색 및 쿼리에 어려움이 있어 대형 프로젝트에서는 적합하지 않을 수도 있다.

그렇기 때문에 상황에 맞춰 Auditing을 도입할지 결정하면 좋을 것 같다. 🤩