JPA Attribute Converter 활용

Attribute Converter 란?

A class that implements this interface can be used to convert entity attribute state into database column representation and back again

이 인터페이스를 구현하는 클래스는 엔티티 속성 상태를 데이터베이스 열 표현으로 변환하고 다시 변환하는 데 사용할 수 있습니다.

즉, 엔티티에서의 Boolean 값이 데이터베이스에서는 0과 1로 이루어진 Int 값으로 표현되어야 할 경우 사용할 수 있습니다.

 

프로젝트에 도입한 이유

현재 프로젝트에서 Music Entity에 SuperGenres 와 SubGenres 가 있습니다.

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

    private String title;
    private String artist;
    @Enumerated(value = EnumType.STRING)
    private SuperGenre superGenre;
    @ElementCollection
    private List<String> subGenres;
    
    ...
}

SuperGenres는 추천 시스템에서 가중치 조정 등의 역할을 수행하며, SubGenres는 세부 장르를 사용자에게 단순히 보여주는 역할을 합니다.

SubGenres 데이터에 대해 검색, 수정, 삭제와 같은 기능이 없기 때문에, 이 데이터를 별도의 테이블로 관리하는 것은 크게 의미가 없으며 비효율적이라고 판단하였습니다. 

따라서, Entity에서는 List<String> 형태로 데이터를 관리하고, 데이터베이스에서는 JSON 형식의 리스트를 문자열로 관리하기 위해 Attribute Converter를 사용하였습니다.

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

    private String title;
    private String artist;
    @Enumerated(value = EnumType.STRING)
    private SuperGenre superGenre;
    @Convert(converter = SubGenreConverter.class)
    private List<String> subGenres;
    
    ...
}

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

    private final ObjectMapper objectMapper = new ObjectMapper();

    @Override
    public String convertToDatabaseColumn(final List<String> attribute) {
        try {
            return objectMapper.writeValueAsString(attribute);
        } catch (JsonProcessingException e) {
            throw new SubGenreConvertingException();
        }
    }

    @Override
    public List<String> convertToEntityAttribute(final String dbData) {
        try {
            return objectMapper.readValue(dbData, new TypeReference<>() {
            });
        } catch (JsonProcessingException e) {
            throw new SubGenreConvertingException();
        }
    }
}

---

https://techblog.woowahan.com/2600/

https://github.com/woowacourse/jwp-shopping-cart/pull/269