@Convert vs @JoinTable

문제의 상황

• [ ] 이번에 개발하고 있는 뇌졸중 증상 자가 점검 앱 애플리케이션에서 몸 상태를 기록하는 페이지가 있는데, "어지러움", "힘이 없음"처럼 간단하게 버튼을 클릭해서 기록할 수 있는 기능을 설계해야 한다.

• [ ] 프론트로부터 받아오는 데이터가 Enum 타입의 리스트일 때, 데이터베이스에 어떤 형태로 저장하는게 좋을까 ? → 중간 테이블을 추가로 만들어 @JoinTable 애너테이션을 사용해도 되겠지만, 같은 엔티티에 속해있던 2개의 필드(commonConditoinList, conditionDetails)를 다대다 관계로 쪼개기엔 성능적으로도 비즈니스적으로도 적합하지 않다 !

@Convert가 무엇이고, 어떻게 사용할까 ?

• [ ] @Convert는 엔티티 속성을 데이터베이스 컬럼에 저장하거나 불러올 때 변환하는 데 사용된다.
• [ ] Enum, List, Map과 같은 복잡한 타입을 데이터베이스에 저장할 때 사용한다. → 이번의 경우처럼 여러 Enum(CommonCondition) 값을 가지는 List를 하나의 문자열로 변환해 데이터베이스를 저장하고, 다시 List로 변환하여 불러오고자 할 때 사용하기 적합하다 !

// ConditionDetailsRecord.java
@Entity
@Getter
@Table(name = "condition_details_record")
public class ConditionDetailsRecord {

    @Id @GeneratedValue(strategy = GenerationType.IDENTITY)
    @Column(name = "condition_details_record_id")
    private Long id;
    
    private LocalDate recordAt;

    @Convert(converter = CommonConditionConverter.class)
    @Column(name = "common_conditions") // ['어지러움']
    private List<CommonCondition> commonConditionList;

• [ ] @Converter는 어떤 장단점이 있으며, 어떻게 사용하나 ?

장단점

• 장점: 사용자 정의 컨버터, 즉 JPA Converter를 상황에 맞게 정의하여 복잡한 타입을 간단한 타입으로 변환할 수 있다 !
• 단점: 변환 로직을 직접 구현해야 하며, 잘못 구현하면 데이터 일관성에 문제가 생길 수 있다.

사용법

• @Converter 애너테이션은 이 클래스가 JPA Converter임을 나타낸다.
• AttributeConverter 인터페이스를 구현하고 있다. → 이 인터페이스는 두 개의 제네릭 타입을 받는데, 첫 번째는 엔티티 속성의 타입 (List<CommonCondition>), 두 번째는 이 속성을 데이터베이스에 저장할 때 사용할 타입(String)입니다.

코드 설명

• List<CommonCondition>가 [DIZZYINESS, WEAKNESS]라면, 이 리스트는 데이터베이스에 "DIZZYINESS, WEAKNESS"로 저장됩니다.
• 반대로 "DIZZYINESS, WEAKNESS"라는 문자열이 데이터베이스에 저장되어 있다면, 이를 다시[DIZZYINESS, WEAKNESS] 리스트로 변환

// CommonConditionConverter.java
package inatools.backend.converter;

import inatools.backend.domain.CommonCondition;
import jakarta.persistence.AttributeConverter;
import jakarta.persistence.Converter;
import java.util.Arrays;
import java.util.List;
import java.util.stream.Collectors;

@Converter
public class CommonConditionConverter implements AttributeConverter<List<CommonCondition>, String> {

    @Override
    public String convertToDatabaseColumn(List<CommonCondition> attribute) {
        if (attribute == null || attribute.isEmpty()) {
            return "";
        }
        return attribute.stream()
                .map(Enum::name)
                .collect(Collectors.joining(","));
    }

    @Override
    public List<CommonCondition> convertToEntityAttribute(String dbData) {
        if (dbData == null || dbData.isEmpty()) {
            return List.of();
        }
        return Arrays.stream(dbData.split(","))
                .map(CommonCondition::valueOf)
                .collect(Collectors.toList());
    }

}