JPA Auditing 기능을 통해 Entity 공통 컬럼 자동화해보기

ORM 기술인 JPA를 사용하여 도메인을 관계형 데이터베이스 테이블에 매핑할 때 공통적으로 도메인들이 가지고 있는 필드나 컬럼들은 늘 존재합니다.
대표적으로 생성자, 수정자, 생성일자, 수정일자, 식별자 같은 필드 및 컬럼이 있습니다.

도메인마다 공통으로 존재한다는 의미는 결국 코드가 중복된다는 말과 일맥상통한데, 생성자, 수정자, 생성일자, 수정일자 같은 컬럼은 DB 관점에서 매우 중요한 데이터입니다.

그래서 JPA에서는 Audit이라는 기능을 제공하고 있습니다.
Audit은 감시하다라는 뜻으로 Spring Data JPA에서 시간에 대해서 자동으로 값을 넣어주는 기능입니다.
도메인을 영속성 컨텍스트에 INSERT 하거나 UPDATE 하는 경우 매번 시간 데이터를 입력하여 저장해야 하는데, audit을 이용하면 자동으로 시간을 매핑하여 테이블에 반영할 수 있습니다.

 

1. build.grade에 의존성 추가

dependencies {
  compile('org.springframework.boot:spring-boot-starter-web')
  compile('org.projectlombok:lombok')
  compile('org.springframework.boot:spring-boot-starter-data-jpa')
 }

기본적으로 스프링 부트에서 gradle로 의존성을 관리하게 될 경우 spring-boot-starter-data-jpa만 추가해도 Audit을 하는데는 문제가 없습니다.

 2. BaseEntity 생성

@Setter
@Getter
@MappedSuperclass
@EntityListeners(AuditingEntityListener.class)
public class BaseEntity {

  private String useYn = "Y";
  
  @CreationTimestamp
  @Column(updatable = false)
  private LocalDateTime rgstDt;
  
  @UpdateTimestamp
  private LocalDateTime mdfyDt;

  public BaseEntity() {
   ...
  }
  

@CreatedDate : Entity가 생성되어 저장될 때 시간이 자동 저장
@LastModifiedDate : 조회한 Entity의 값을 변경할 때 시간이 자동 저장

3. JPA Auditing 활성화

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

스프링 부트의 Entry 포인트인 실행 클래스에 @EnableJpaAuditing 어노테이션을 적용하여 JPA Auditing을 활성화 합니다.

4. 공통 BaseEntity 상속

@Getter
@NoArgsConstructor
@Entity
public class Board extends BaseEntity{

    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;

    @Column(length = 500, nullable = false)
    private String title;

    @Column(columnDefinition = "TEXT", nullable = false)
    private String content;
    
    @Column
    private String rgstId;

    @Column
    private String mdfyId;

}

이런 식으로 상속만 해주고 Board 테이블에 대한 Insert, Update 시 자동으로
RGST_DT, MDFY_DT 컬럼의 값을 채워주는 것을 확인할 수 있습니다.

다음 포스팅에서는 좀 더 나아가서 RGST_ID(생성자)와 MDFY_ID(수정자) JPA Auditing을 활용하여 자동화 적용하는 방법도 알아보겠습니다.