[Spring] [BaseTimeEntity, JPA Auditing]을 통한 생성시간/수정시간 자동화

서론

보통 엔티티(entity)에는 해당 데이터의 생성 시간과 수정시간을 포함한 컬럼이 항상 존재합니다. 언제 만들어졌는지, 언제 수정되었는지 등은 차후 유지보수에 있어 굉장히 중요한 정보이며, 데이터 분석에 유용하기 때문입니다. 그렇다 보니 매번 DB에 삽입(insert) 하기 전, 갱신(update) 하기 전에 날짜 데이터를 등록/수정하는 코드가 여기저기 들어가게 됩니다.

하지만 모든 엔티티마다 생성시간과 수정시간을 넣는다면 코드가 매우 지저분해지고 객체지향적이지 못합니다. 이러한 문제는 JPA Auditing를 사용하면 쉽게 해결할 수 있습니다.

 

LocalDate 사용

Java8부터 LocalDate와 LocalDateTime이 등장했습니다. 사실 그동안은 Java의 기본 날짜 타입인 Date를 사용해 왔지만 Java8 이후부터는 문제가 있던 Date를 고친 LocalDate와 LocalDateTime를 무조건 사용하셔야 합니다.

Java8이 나오기 전까지 사용되었던 Date와 Calendar 클래스는 다음과 같은 문제점들이 있었습니다.

불변(변경이 불가능한) 객체가 아니다.
 -> 멀티스레드 환경에서 언제든 문제가 발생할 수 있다.
Calendar는 월(Month) 값 설계가 잘못되었다.
 -> 10월을 나타내는 Calendar.OCTOBER의 숫자 값은 '10'이 아니라 '9'로 설계되어있다.

따라서 그동안 JodaTime이라는 오픈소스를 사용해서 문제점을 피했었지만, Java8 이후부터는 LocalDate를 통하여 해결이 가능합니다.

자세한 내용은 네이버 D2에서 참고가 가능합니다. https://d2.naver.com/helloworld/645609

또한 LocalDate와 LocalDateTime이 데이터베이스에 제대로 매핑되지 않는 이슈는 Hibernate 5.2.10 버전에서 해결되었습니다. 따라서 스프링 부트 1.x를 쓴다면 별도로 Hibernate 5.2.10 버전 이상을 사용하도록 설정이 필요하지만, 스프링 부트 2.x 버전을 사용하면 기본적으로 해당 버전을 사용 중이라 별다른 설정 없이 바로 적용하면 됩니다.

 

예제

@Getter
@MappedSuperclass // BaseEntity를 상속한 엔티티들은 아래 필드들을 컬럼으로 인식하게 된다.
@EntityListeners(AuditingEntityListener.class)  // Auditing(자동으로 값 매핑) 기능 추가
public abstract class BaseTimeEntity {

    @CreatedDate
    private LocalDateTime createdTime;

    @LastModifiedDate
    private LocalDateTime lastModifiedTime;
}

먼저 BaseTimeEntity를 추상 클래스 형태로 생성합니다. BaseTimeEntity 클래스는 모든 Entity의 상위 클래스가 되어 Entity들의 생성 시간과, 수정 시간을 자동으로 관리하는 역할입니다.

각 코드의 어노테이션을 설명하면 아래와 같습니다.

• @MappedSuperclass: JPA Entity 클래스들이 BaseTimeEntity을 상속할 경우 필드들(createdTime, lastModifiedTime)도 컬럼으로 인식하도록 합니다.
• @EntityListeners(AuditingEntityListener.class): BaseTimeEntity 클래스에 Auditing 기능을 포함시킵니다.
• @CreatedDate: Entitiy가 최초로 생성되어 저장될 때 시간이 자동으로 저장됩니다.
• @LastModifiedDate: 조회한 Entity의 값을 변경할 때 시간이 자동으로 저장됩니다.

 

@Entity
@AllArgsConstructor
@NoArgsConstructor
public class User extends BaseTimeEntity {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Integer id;

    private String name;
    private String password;

    @Builder
    public User(String name, String password) {
        this.name = name;
        this.password = password;
    }
}

 

그 후 Entity 클래스인 User가 BaseTimeEntity를 상속받도록 작성합니다.

@SpringBootApplication
@EnableJpaAuditing
public class ApiPracticeApplication {

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

    @Bean
    public LocaleResolver localeResolver() {
        SessionLocaleResolver localeResolver = new SessionLocaleResolver();
        localeResolver.setDefaultLocale(Locale.KOREA);
        return localeResolver;
    }

}

마지막으로 JPA Auditing 어노테이션들을 모두 활성화할 수 있도록 Apllication 클래스에 위와 같이 활성화 어노테이션인 @EnableJpaAuditing을 추가합니다.

 

테스트

@SpringBootTest
class UserTest {

    @Autowired
    private UserRepository userRepository;

    @Test
    void BaseEntity_테스트(){
        // given
        LocalDateTime nowTime = LocalDateTime.now();

        User user = User.builder()
                .name("안주형")
                .password("password1")
                .build();

        //when
        userRepository.save(user);

        //then
        assertThat(user.getCreatedTime()).isAfter(nowTime);

    }

테스트 코드는 위와 같습니다. nowTime은 user클래스가 생성되기 이전에 저장되기 때문에 user클래스의 createdTime 보다 항상 작게 나와야 할 것입니다. 따라서 assertThat(user.getCreatedTime()).isAfter(nowTime); 을 통해 검증을 할 것입니다.

테스트 수행 결과

테스트 수행결과는 예상했던 대로 무사히 통과되었습니다.

 

참고

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