[DEVLOG] 우당탕탕 제발모발 v2 개발기 - 탈모 진단 API 수정하기 (4) createdAt과 updatedAt, JPA AttributeConverter

 

😎 0. 이전 글

[DEVLOG] 우당탕탕 제발모발 v2 개발기 - 탈모 진단 API 수정하기 (3) DTO에 따른 응답 생성 클래스 만

 

 

 🤔 1. createdAt과 updatedAt

 

모든 엔티티는 일반적으로 createdAt과 updatedAt을 가집니다.

데이터를 저장할 때 '생성된 시간 정보'와 '수정된 시간 정보'는 여러모로 많이 사용되고 또 중요합니다.

JPA를 사용하면서 @CreatedDate, @LastModifiedDate를 사용하여 생성된 시간 정보, 수정된 시간 정보를 자동으로 저장할 수 있습니다.

 

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

    @Column(name = "created_at")
    @CreatedDate
    private LocalDateTime createdAt;

    @Column(name = "updated_at")
    @LastModifiedDate
    private LocalDateTime updatedAt;
}

 

대부분의 엔티티 클래스에서 사용되는 필드들이므로, 다음과 같이 구성하여 이 엔티티 객체를 상속받는 형식으로 구현하기로 했습니다.

abstract class : 공통적으로 사용하는 시간 정보는, 자기 자신만으로는 엔티티가 되지 않습니다. 오로지 다른 엔티티에 상속하는 것으로 attribute를 부여합니다. 따라서 인스턴스를 생성할 수 없도록 추상 클래스로 처리합니다.

@MappedSuperclass : 다른 JPA Entity 클래스들이 이 어노테이션이 붙은 클래스를 상속받으면, 필드인 createdAt과 updatedAt을 인식합니다.

@EntityListeners(AuditingEntityLIstener.class) : JPA Entity 에서 이벤트가 발생할 때마다 특정 로직을 실행 가능

 

이렇게 메인 어플리케이션 클래스에 @EnableJpaAuditing 어노테이션까지 달아줘야, JPA Auditing기능이 활성화되어 자동으로 createdAt과 updatedAt이 생성될 수 있습니다.

 

 

작성한 테스트 코드입니다. JBMBDiagnosisInfoEntity는 JBMBCommonTimeEntity를 상속받았습니다.

빌더 패턴을 통해 JBMBDiagnosisInfoEntity를 생성하고, createdAt과 updatedAt은 삽입하지 않았습니다.

repository를 통해 save를 한 후, createdAt과 updatedAt의 값이 notNull인지 확인하는 로직으로 구성했습니다.

또한 간단한 테스트가 끝나고 해당 데이터가 데이터베이스에 남아있는 것을 방지하기 위해 @Transactional을 설정했습니다.

 

 

테스트 결과는 성공적입니다. 내부 요소를 프린트 했을 때도 save하기 전과 후로 null -> not null 임을 확인할 수 있었습니다.

2022-12-27 10:40:38.303  INFO 2597 --- [    Test worker] o.m.j.i.logging.ProtocolLoggingProxy  : conn=4266(M) - 3.634 ms - Query: 
insert into jbmb_diagnosis_info (created_at, updated_at, diagnosis_state, diagnosis_type, user_num) 
values (?, ?, ?, ?, ?), parameters ['2022-12-27 10:40:38.285','2022-12-27 10:40:38.285','OPEN',false,0]

로그에서도 insert문이 들어갈 때, createdAt과 updatedAt값이 생성되어 들어가는 것을 확인할 수 있었습니다.

 

 

🤔 2. Enum과 JPA AttributeConverter

 

기존 DB를 우선 살펴보겠습니다.

-- jbmb.diagnosis_log definition

CREATE TABLE `diagnosis_log` (
  `diagnosis_id` int NOT NULL AUTO_INCREMENT,
  `active` tinyint NOT NULL,
  `created_at` datetime NOT NULL,
  `user_num` int NOT NULL,
  PRIMARY KEY (`diagnosis_id`)
);

 

'진단 아이디'를 PK로 가지고 있는 진단 기록 테이블입니다.

지난 글에서, active에 대한 column을 state로 변경하겠다고 했으므로, 이 부분에 대해서 수정할 예정입니다.

또한, 테이블 내에 생성된 시점을 표시하는 'created_at'은 있지만, 수정된 시점인 'updated_at'은 없어 방금 만든 공통 엔티티 클래스를 통해 추가할 예정입니다.

 

테이블 자체를 수정하지 않고, 새로운 테이블을 구성한 뒤 백엔드에서 v1 테이블과 v2 테이블 모두 값이 채워지도록 설계해 어플리케이션에서 API 교체 작업을 진행하더라도 문제 없이 진행해 볼 생각입니다.

 

또 진단 유형을 정의해야 합니다. 이제는 '열화상' 진단에 대해서도 구분이 가능해야 하니 말이죠.

변경할 예상 테이블은 다음과 같습니다.

-- create new table : jbmb_diagnosis_info

create table jbmb_diagnosis_info(
	diagnosis_id long not null auto_increment,
	user_id long not null,
	diagnosis_type bit not null,
	diagnosis_state VARCHAR(50) not null,
	
	created_at timestamp not null default current_timestamp,
	updated_at timestamp not null default current_timestamp on update current_timestamp,
	
	primary key(diagnosis_id)
);

DB 안에는 진단 타입과 상태는 텍스트 형태의 데이터가 들어가야 구분하기가 쉽습니다. 예를 들어, diagnosis_type이 1이거나 0이라면, 이것을 정리해놓은 문서가 없다면 1이 무엇을 뜻하는지, 0을 무엇을 뜻하는지 알 수가 없습니다.

 

백엔드 엔티티에서는 조금 다릅니다. DB에서는 해당 타입 혹은 상태를 텍스트의 형태로 저장했지만, 우리는 그것을 Enum으로 정의했습니다. 따라서 DB에서 엔티티로 데이터가 전달될 때는 VARCHAR 값이 Enum으로, 엔티티에서 DB에 저장될 때에는 Enum에서 VARCHAR로 변환이 되어야 합니다. 이러한 역할을 도와주는 것이 바로 AttributeConverter입니다.

 

@Enumerated와 AttributeConverter의 자세한 내용은 아래의 글을 참조하면 됩니다.

[Spring JPA] @Enumerated와 AttributeConverter

 

/* JBMBDiagnosisStateIdentifierConverter.java */
public class JBMBDiagnosisStateIdentifierConverter implements AttributeConverter<JBMBDiagnosisStateIdentifier, String> {

    @Override
    public String convertToDatabaseColumn(JBMBDiagnosisStateIdentifier attribute) {
        return attribute.name();
    }

    @Override
    public JBMBDiagnosisStateIdentifier convertToEntityAttribute(String dbData) {
        return JBMBDiagnosisStateIdentifier.valueOf(dbData);
    }

}

/* JBMBDiagnosisTypeIdentifierConverter.java */
public class JBMBDiagnosisTypeIdentifierConverter implements AttributeConverter<JBMBDiagnosisTypeIdentifier, Boolean> {

    @Override
    public Boolean convertToDatabaseColumn(JBMBDiagnosisTypeIdentifier attribute) {
        return attribute.isThermal();
    }

    @Override
    public JBMBDiagnosisTypeIdentifier convertToEntityAttribute(Boolean dbData) {
        return JBMBDiagnosisTypeIdentifier.getJBMBDiagnosisTypeWhetherIsThermal(dbData);
    }
}

 

@Data
@Entity
@NoArgsConstructor
@AllArgsConstructor
@Builder
@ToString(callSuper = true)
@EqualsAndHashCode(callSuper = true)
@Table(name = "jbmb_diagnosis_info")
public class JBMBDiagnosisInfoEntity extends JBMBCommonTimeEntity {

    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    @Column(name = "diagnosis_id")
    /* 진단 아이디 */
    private Long diagnosisID;

    @Column(name = "diagnosis_type", nullable = false)
    @Convert(converter = JBMBDiagnosisTypeIdentifierConverter.class)
    /* 진단 유형 (기본 / 열화상) */
    private JBMBDiagnosisTypeIdentifier diagnosisType;

    @Column(name = "diagnosis_state", nullable = false)
    @Convert(converter = JBMBDiagnosisStateIdentifierConverter.class)
    /* 진단 상태 (OPEN~CLOSE) */
    private JBMBDiagnosisStateIdentifier diagnosisState;

    @Column(name = "user_num", nullable = false)
    /* 사용자 식별 번호 */
    private int userNum;

}

 

다음은 실행결과입니다.

2022-12-26 20:09:06.121  INFO 30282 --- [  restartedMain] o.m.j.i.logging.ProtocolLoggingProxy     : conn=4057(M) - 160.911 ms - Query: 
    create table jbmb_diagnosis_info (
       diagnosis_id bigint not null auto_increment,
        created_at datetime(6),
        updated_at datetime(6),
        diagnosis_state varchar(255) not null,
        diagnosis_type bit not null,
        user_num integer not null,
        primary key (diagnosis_id)
    ) engine=InnoDB

diagnosis_state는 문자열이 들어가기 때문에 varchar로, diagnosis_type은 db에는 boolean 값이 들어가기 때문에 bit로 생성된 로그를 확인할 수 있었습니다.