[Spring] JPA Auditing

thingzoo·2023년 6월 26일
0

Spring

목록 보기
29/54
post-thumbnail
post-custom-banner

데이터의 생성(created_at), 수정(modified_at) 시간은 포스팅, 게시글, 댓글 등 다양한 데이터에 매우 자주 활용된다. 하지만 각각의 Entity의 생성 수정 시간을 매번 작성하는건 너무 비효율적입니다. 그래서 Spring Data JPA에서는 시간에 대해서 자동으로 값을 넣어주는 기능인 JPA Auditing을 제공하고 있다.

적용 방법

Timestamped 클래스 생성

@Getter
@MappedSuperclass
@EntityListeners(AuditingEntityListener.class)
public abstract class Timestamped {

    @CreatedDate
    @Column(updatable = false)
    @Temporal(TemporalType.TIMESTAMP)
    private LocalDateTime createdAt;

    @LastModifiedDate
    @Column
    @Temporal(TemporalType.TIMESTAMP)
    private LocalDateTime modifiedAt;
}
  • @MappedSuperclass
    • JPA Entity 클래스들이 해당 추상 클래스를 상속할 경우 createdAt, modifiedAt 처럼 추상 클래스에 선언한 멤버변수를 컬럼으로 인식 가능
  • @EntityListeners(AuditingEntityListener.class)
    • 해당 클래스에 Auditing 기능 추가
  • @CreatedDate
    • Entity 객체가 생성되어 저장될 때 시간 자동 저장
    • 최초 생성 시간이 저장되고 그 이후에는 수정되면 안되기 때문에 updatable = false 옵션 추가
  • @LastModifiedDate
    • 조회한 Entity 객체의 값을 변경할 때 변경된 시간 자동 저장
    • 처음 생성 시간이 저장된 이후 변경이 일어날 때마다 해당 변경시간으로 업데이트
  • @Temporal
    • 날짜 타입(java.util.Date, java.util.Calendar)을 매핑할 때 사용
    • DB에는 Date(날짜), Time(시간), Timestamp(날짜와 시간)라는 세 가지 타입이 별도로 존재
      • DATE : ex) 2023-01-01
      • TIME : ex) 20:21:14
      • TIMESTAMP : ex) 2023-01-01 20:22:38.771000

@EnableJpaAuditing 추가

  • @SpringBootApplication 이 있는 class에
    • @EnableJpaAuditing 추가!
    • JPA Auditing 기능을 사용하겠다는 정보를 전달해주기 위해

적용하고자하는 Entity 클래스에서 Timestamped 상속

public class Memo extends Timestamped { ... }

ResponseDto 클래스에도 필드 추가해주기

public class MemoResponseDto {
    private Long id;
    private String username;
    private String contents;
    private LocalDateTime createdAt; // 추가
    private LocalDateTime modifiedAt; // 추가
}
profile
공부한 내용은 바로바로 기록하자!
post-custom-banner

0개의 댓글