Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[BE] createdAt 설정을 위한 BaseEntity 적용 #700

Merged
merged 1 commit into from
Oct 8, 2024
Merged

[BE] createdAt 설정을 위한 BaseEntity 적용 #700

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions server/src/main/java/server/haengdong/HaengdongApplication.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
import lombok.extern.slf4j.Slf4j;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.data.jpa.repository.config.EnableJpaAuditing;

@Slf4j
@SpringBootApplication
Expand Down
9 changes: 9 additions & 0 deletions server/src/main/java/server/haengdong/config/JpaConfig.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
package server.haengdong.config;

import org.springframework.context.annotation.Configuration;
import org.springframework.data.jpa.repository.config.EnableJpaAuditing;

@Configuration
@EnableJpaAuditing
public class JpaConfig {
}
Comment on lines +6 to +9
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

이 class는 어떤 용도인가요?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

먼저 @EnableJpaAuditing 애너테이션은 Spring Data Jpa 엔티티의 생성 및 수정 시간을 자동으로 관리하기 위한 감사 기능을 활성화하는 애너테이션 입니다. @CreatedDate로 엔티티의 생성 날짜 및 시간을 자동으로 설정합니다. @LastModifiedDate로 엔티티의 수정 날짜 및 시간을 자동으로 업데이트 합니다. 이 애너테이션은 AuditingHandler 및 관련 빈들을 애플리케이션 컨텍스트에 등록하며, JPA 메타 모델을 필요로 합니다.

이 class는 어떤 용도인가요?

@EnableJpaAuditing 애너테이션이 @SpringBootApplication 애너테이션이 붙어있는 HaengdongApplication 클래스에 붙여도 동작합니다. 그렇다면 왜 @EnableJpaAuditing 애너테이션을 별도의 JpaConfig 클래스에 분리하여 붙였을까요?

그 이유는 @SpringBootTest, @WebMvcTest 애너테이션을 사용하는 테스트에서 @SpringBootApplication 애너테이션을 통해 컴포넌트 스캔하여 컨텍스트를 설정하기 때문입니다. @SpringBootApplication 애너테이션은 @ComponentScan을 포함하고 있어서 해당 패키지를 포함한 하위 패키지에서 @Component, @Controller, @Service, @Repository 가 붙어있는 클래스들을 빈으로 등록합니다.

@Documented
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Import({JpaAuditingRegistrar.class})
public @interface EnableJpaAuditing {
    String auditorAwareRef() default "";

    boolean setDates() default true;

    boolean modifyOnCreate() default true;

    String dateTimeProviderRef() default "";
}

@EnableJpaAuditing 애너테이션은 내부적으로 @Import(JpaAuditingRegistrar.class)를 사용합니다. 이 @Import 애너테이션은 지정된 클래스를 Spring의 ApplicationContext에 등록하도록 지시합니다. JpaAuditingRegistrar 클래스는 JPA 감사 기능을 설정하는 데 필요한 빈을 등록하는 역할을 합니다. 이 클래스는 @Configuration 애너테이션을 통해 Spring의 설정 클래스로 인식됩니다. @EnableJpaAuditing이 사용된 클래스가 컴포넌트 스캔의 범위 내에 있으면, Spring Boot는 이 애너테이션을 감지하고 JpaAuditingRegistrar를 통해 JPA 감사 기능을 설정합니다. 이 과정에서 JpaAuditingHandler, AuditorAware, DateTimeProvider와 같은 관련 빈들이 생성됩니다.

문제는 @WebMvcTest 기반 테스트의 경우 @SpringBootApplication 애너테이션이 붙어있는 클래스를 통해 컨텍스트를 생성하는데, @EnableJpaAuditing 애너테이션이 존재하는 경우 JpaAuditingHandler 빈이 생성되고, 이 빈은 JPA 메타모델에 의존합니다. 하지만 @WebMvcTest 기반 테스트는 Service, Repository와 같은 다른 계층의 빈들은 로드하지 않고 웹 관련 빈들만 로드하기 때문에 JPA 엔티티, Repository 등이 로드되지 않아서 메타 모델이 비어있기 때문에 JPA metamodel must not be empty 에러가 발생합니다.

@WebMvcTest 기반의 테스트를 실행하여 @SpringBootApplication가 붙어있는 클래스를 찾고 해당 클래스를 기반으로 웹 관련 빈들만 컴포넌트 스캔하여 컨텍스트를 생성하는데, 이전처럼 @SpringBootApplication과 함께 두어 @EnableJpaAuditing애너테이션을 스캔하지 않도록 JpaConfig 클래스로 분리하여 JpaAuditingHandler 빈이 생성될 때 JPA 메타 모델을 의존할 수 없어서 발생하는 문제를 막을 수 있습니다.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

자세한 설명 감사합니다 👍

@WebMvcTest에서 빈 주입이 안되는 오류를 막기 위함이었군요. 처음 알았네요!

23 changes: 23 additions & 0 deletions server/src/main/java/server/haengdong/domain/BaseEntity.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
package server.haengdong.domain;

import jakarta.persistence.Column;
import jakarta.persistence.EntityListeners;
import jakarta.persistence.MappedSuperclass;
import java.time.Instant;
import lombok.Getter;
import org.springframework.data.annotation.CreatedDate;
import org.springframework.data.annotation.LastModifiedDate;
import org.springframework.data.jpa.domain.support.AuditingEntityListener;

@Getter
@EntityListeners(AuditingEntityListener.class)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

EntityListeners는 어떻게 동작하나요?

Copy link
Contributor

@kunsanglee kunsanglee Oct 7, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@EntityListeners는 JPA에서 엔티티의 생명주기(new, managed, detached, removed) 이벤트에 대한 콜백 메서드(특정 이벤트가 발생할 때 자동으로 호출)를 정의하기 위해 사용되는 애너테이션입니다. 이를 통해 엔티티의 상태 변경 시 특정 로직을 실행할 수 있습니다.

@Entity
@EntityListeners(UserListener.class)
public class User {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;

    private String name;

    // getters and setters
}

public class UserListener {

    @PrePersist
    public void prePersist(User user) {
        // 엔티티가 저장되기 전에 호출되는 메서드
        System.out.println("User is about to be persisted: " + user.getName());
    }

    @PreUpdate
    public void preUpdate(User user) {
        // 엔티티가 업데이트되기 전에 호출되는 메서드
        System.out.println("User is about to be updated: " + user.getName());
    }

    ...
}

@EntityListeners가 지원하는 주요 생명주기 이벤트

  • @PrePersist: 엔티티가 저장되기 전에 호출.
  • @PostPersist: 엔티티가 저장된 후 호출.
  • @PreUpdate: 엔티티가 업데이트되기 전에 호출.
  • @PostUpdate: 엔티티가 업데이트된 후 호출.
  • @PreRemove: 엔티티가 삭제되기 전에 호출.
  • @PostRemove: 엔티티가 삭제된 후 호출.
  • @PostLoad: 엔티티가 로드된 후 호출.

@EntityListeners는 엔티티에 생명주기 이벤트에 따라 Listener에 정의된 콜백 메서드를 수행합니다.

AuditingEntityListener는 Spring Data JPA가 제공하는 기본 리스너로, 엔티티의 생성 및 수정 시각과 관련한 필드를 자동으로 처리합니다. 이를 위해서 @EnableJpaAuditing 애너테이션을 사용하여 JPA 감사 기능을 활성화해야 합니다.

위 코드에서는 BaseEntity에 감사 필드를 정의하고, JPA 엔티티의 생명주기 이벤트에 따라 엔티티가 생성(@CreatedDate), 수정(@LastModifiedDate) 이벤트가 발생할 때 현재 시간이 자동으로 설정됩니다. BaseEntity 엔티티는 단독으로 생성하여 사용하지 않고, 다른 도메인 엔티티들이 상속받아서 엔티티 생명주기 이벤트가 발생할 때 자동으로 현재 시간을 설정할 수 있도록 도와주는 시스템 컬럼으로써 역할을 합니다.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

오!
이 어노테이션으로 엔티티의 상태 변화를 명확하게 파악하기 좋겠네요!

@MappedSuperclass
public abstract class BaseEntity {

@Column(updatable = false)
@CreatedDate
private Instant createdAt;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Instant는 무엇을 의미하나요?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Instant는 UTC time-zone을 바탕으로 나노초까지 시간을 나타내는 클래스입니다. 글로벌 서비스인 경우에 여러 지역의 시간을 UTC에 맞게 TimeStamp 형식으로 저장하여 많이 사용합니다.

LocalDateTime은 시간대가 없이 인스턴스의 TimeZone 기반으로 Offset을 생성 후 현재 시점 기준으로 LocalDate, LocalTime 객체를 생성하여 로컬 시간에 맞춰서 시간을 나타내는 클래스입니다. TimeZone이 다른 각각의 Region의 서버에서 LocalDateTime.now() 메서드를 사용하면 해당 로컬에 맞는 시간대가 반환됩니다. 단일 리전 서비스인 경우 LocalDateTime를 사용하는 것이 좋습니다.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

UTC 기반 시간이라 지역과 상관없이 적용할 수 있겠군요! 👍

행동대장의 글로벌화를 기원합니다.


@LastModifiedDate
private Instant updatedAt;
}
3 changes: 2 additions & 1 deletion server/src/main/java/server/haengdong/domain/bill/Bill.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
import lombok.AccessLevel;
import lombok.Getter;
import lombok.NoArgsConstructor;
import server.haengdong.domain.BaseEntity;
import server.haengdong.domain.member.Member;
import server.haengdong.domain.event.Event;
import server.haengdong.exception.HaengdongErrorCode;
Expand All @@ -27,7 +28,7 @@
@Getter
@NoArgsConstructor(access = AccessLevel.PROTECTED)
@Entity
public class Bill {
public class Bill extends BaseEntity {

private static final int MIN_TITLE_LENGTH = 1;
private static final int MAX_TITLE_LENGTH = 30;
Expand Down
3 changes: 2 additions & 1 deletion server/src/main/java/server/haengdong/domain/bill/BillDetail.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,13 @@
import lombok.AccessLevel;
import lombok.Getter;
import lombok.NoArgsConstructor;
import server.haengdong.domain.BaseEntity;
import server.haengdong.domain.member.Member;

@Getter
@NoArgsConstructor(access = AccessLevel.PROTECTED)
@Entity
public class BillDetail {
public class BillDetail extends BaseEntity {

@Id
@GeneratedValue(strategy = GenerationType.IDENTITY)
Expand Down
4 changes: 3 additions & 1 deletion server/src/main/java/server/haengdong/domain/event/Event.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,17 +7,19 @@
import jakarta.persistence.GeneratedValue;
import jakarta.persistence.GenerationType;
import jakarta.persistence.Id;
import java.time.Instant;
import java.util.Arrays;
import lombok.AccessLevel;
import lombok.Getter;
import lombok.NoArgsConstructor;
import server.haengdong.domain.BaseEntity;
import server.haengdong.exception.HaengdongErrorCode;
import server.haengdong.exception.HaengdongException;

@Getter
@NoArgsConstructor(access = AccessLevel.PROTECTED)
@Entity
public class Event {
public class Event extends BaseEntity {

private static final int MIN_NAME_LENGTH = 1;
private static final int MAX_NAME_LENGTH = 20;
Expand Down
3 changes: 2 additions & 1 deletion server/src/main/java/server/haengdong/domain/event/EventImage.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,12 @@
import lombok.AccessLevel;
import lombok.Getter;
import lombok.NoArgsConstructor;
import server.haengdong.domain.BaseEntity;

@Getter
@NoArgsConstructor(access = AccessLevel.PROTECTED)
@Entity
public class EventImage {
public class EventImage extends BaseEntity {

@Id
@GeneratedValue(strategy = GenerationType.IDENTITY)
Expand Down
3 changes: 2 additions & 1 deletion server/src/main/java/server/haengdong/domain/member/Member.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
import lombok.AccessLevel;
import lombok.Getter;
import lombok.NoArgsConstructor;
import server.haengdong.domain.BaseEntity;
import server.haengdong.domain.event.Event;
import server.haengdong.exception.HaengdongErrorCode;
import server.haengdong.exception.HaengdongException;
Expand All @@ -22,7 +23,7 @@
@NoArgsConstructor(access = AccessLevel.PROTECTED)
@Table(uniqueConstraints = {@UniqueConstraint(columnNames = {"event_id", "name"})})
@Entity
public class Member {
public class Member extends BaseEntity {

private static final int MIN_NAME_LENGTH = 1;
private static final int MAX_NAME_LENGTH = 8;
Expand Down
Loading