Spring Data JPA 에서 공통 auditing field를 만들 때 즐겨 쓰는 설계를 담은 추상 클래스의 코틀린 버전. Spring Boot 3.4.3 에서 테스트 완료.

AuditingFields.kt

import jakarta.persistence.Column
import jakarta.persistence.EntityListeners
import jakarta.persistence.MappedSuperclass
import org.springframework.data.annotation.CreatedBy
import org.springframework.data.annotation.CreatedDate
import org.springframework.data.annotation.LastModifiedBy
import org.springframework.data.annotation.LastModifiedDate
import org.springframework.data.jpa.domain.support.AuditingEntityListener
import java.time.LocalDateTime
import java.time.ZoneOffset

@EntityListeners(AuditingEntityListener::class)
@MappedSuperclass
abstract class AuditingFields {

    @CreatedDate
    @Column(nullable = false, updatable = false)
    var createdAt: LocalDateTime = DUMMY_DATETIME
        protected set

    @LastModifiedDate
    @Column(nullable = false)
    var modifiedAt: LocalDateTime = DUMMY_DATETIME
        protected set

    @CreatedBy
    @Column(nullable = false, updatable = false)
    var createdBy: String = DUMMY_AUDITOR
        protected set

    @LastModifiedBy
    @Column(nullable = false)
    var modifiedBy: String = DUMMY_AUDITOR
        protected set

    override fun toString(): String {
        return "AuditingFields(createdAt=$createdAt, modifiedAt=$modifiedAt, createdBy='$createdBy', modifiedBy='$modifiedBy')"
    }

    companion object {
        val DUMMY_DATETIME: LocalDateTime = LocalDateTime.ofEpochSecond(0, 0, ZoneOffset.UTC)
        const val DUMMY_AUDITOR: String = "dummy"
    }

}

• 프로퍼티명은 auditing 애노테이션의 결에 맞춰 작성.
• 모든 프로퍼티는 설계에 맞게 not null 속성을 갖는다.
• 모든 프로퍼티는 로직에서 쓰기(set)가 금지된다.
• 모든 프로퍼티는 사용자가 직접 입력하는 값이 없으므로 기본 생성자에 노출하지 않는다.
• 생성- 프로퍼티는 한 번 만들어진 후 업데이트(update)가 금지된다.
• DUMMY_DATETIME은 초기값의 별도 입력 없이 not null 속성을 만들기 위한 트릭이고, 이는 JPA Auditing에 의해 올바르게 덮어쓰여진다.
  • 만일 이 값이 사용될 경우 쉽게 알아볼 수 있도록 epoch 0초를 초기값으로 사용하였다.
• DUMMY_AUDITOR는 초기값의 별도 입력 없이 not null 속성을 만들기 위한 트릭이고, 이는 JPA Auditing에 의해 올바르게 덮어쓰여진다.
  • 만일 이 값이 사용될 경우 쉽게 알아볼 수 있도록 dummy를 초기값으로 사용하였다.
  • 대상 프로퍼티가 자동으로 채워지도록 하려면, AuditorAware 빈을 구현하여 등록해야 한다.
• 모든 프로퍼티에 값이 잘 들어가게 하려면, @EnableJpaAuditing을 빈 설정에 등록해야 한다.
• 내부 정보는 toString()에 의해 관찰 가능.