JPA Auditing으로 생성일, 수정일 자동 생성

Auditing 이란?

엔티티는 나중에 유지보수를 위해서 생성일과 수정일을 필수적으로 가지고 있어야 용이합니다.

먼저 일반적으로 생성일과 수정일을 생성하는 방법입니다.

생성일

public Book saveBook(BookDto bookDto) {
    // BookDto -> Book 변환
    Book book = ...;

    book.setCreatedAt(LocalDateTime.now());

    ...
}

수정일

public Long updateBook(Long bookId, BookDto bookDto) {
    // 수정 로직

    book.setModifiedAt(LocalDateTime.now());

    ...
}

이런식으로 엔티티가 증가하면 증가할수록 단순 반복 코드가 늘어나게 됩니다.

이럴 때 Auditing을 사용하게 되면 훨씬 편리하게 사용할 수 있습니다!

JpaAuditing 적용

@MappedSuperClass
@EntityListners(AuditingEntityListener.class)
public abstract class Test {
    @CreatedDate
    LocalDateTime createdAt;

    @LastModifiedDate
    LocalDateTime modifiedAt;
}

이제 모든 엔티티에 해당 클래스를 상속 받도록 하면 됩니다.

마지막으로 JpaAuditing을 활성화되도록 어노테이션만 붙여주면 끝입니다.

@EnableJpaAuditing  // **
@SpringBootApplication
public class Application {
    ...
}

감사합니다.

 

Test 시 주의사항

@EnableJpaAuditing을 사용하기 위해서는 최소 하나의 엔티티가 필요합니다. 하지만 @WebMvcTest를 하면 Entity를 찾을 수 없어 에러가 발생하게 됩니다.

이때는 따로 @Configuration이 붙은 클래스에 분리시켜주면 해결할 수 있습니다.

@Configuration
@EnableJpaAuditing
public class AppConfig {

}

감사합니다.

 

REFERENCE

• 스프링 부트와 AWS로 혼자 구현하는 웹 서비스 - 이동욱