[Spring JPA] @Enumerated와 AttributeConverter

 

🏝 0. 서론

개발을 하다보면, 백엔드에서는 상세한 정보를 모두 담고 있는 객체를, 데이터베이스에서는 핵심적으로 분별가능한 파트만 저장하고 싶을 때가 있습니다.

 

하지만 데이터베이스에 넣을 수 있는 타입은 정해져있습니다. 따라서 엔티티의 필드로 데이터베이스가 인식하지 못하는 객체를 삽입하면 컴파일 에러를 마주할 수 있습니다. 

 

오늘은 이러한 간극을 해결해줄 두 가지 기술에 대해서 정리하려고 합니다. 

백엔드에서는 Enum 객체로, DB에서는 Enum의 상수값(순서값)이나 이름으로 저장할 수 있도록 변환해주는 @Enumerated와,

Enum 객체 뿐만 아니라 JPA가 지원하지 않는 타입을 변환가능하며, 심지어 두 개 이상의 속성을 갖는 객체를 한 개 필드에 매핑시킬 수 있는 AttributeConverter에 대해 정리합니다.

 

---

 

🪄 1. @Enumerated

@Enumerated는 엔티티 객체에서는 Enum 객체를 필드값으로 가질 수 있도록 하고, DB에는 Enum의 상수값(순서값)이나 이름으로 저장할 수 있도록 변환을 지원해주는 어노테이션

 

enum Gender{
	male,
    female;
}

... 엔티티 나머지 생략
private Gender gender; // JPA에서 인식할 수 없는 타입! 오류!

 

성별을 Enum 객체로 표현하고, @Entity 어노테이션이 붙은 엔티티 객체의 필드로 해당 Enum 객체를 사용하고 싶은 상황입니다.

Gender Enum을 확장해서 더욱 다양한 정보를 담는다면, 엔티티 객체 내의 필드의 접근만으로 다양한 활용이 가능할 것입니다.

하지만 JPA는 Gender라는 Enum 객체는 지원하지 않는 타입이기 때문에, 특수한 처리가 필요합니다.

 

@Enumerated(EnumType.STRING)
private Gender gender;

이렇게 @Enumerated 어노테이션을 활용하면, DB에 반영될 때는 Gender 객체가 삽입되는 것이 아닌, EnumType의 "이름"을 저장하게 됩니다.

 

위에서 설명했듯이, @Enumerated는 Enum의 상수값 혹은 이름을 저장하기 때문에 지원하는 EnumType 두 가지가 있습니다.

EnumType.STRING : Enum의 "이름"을 저장 (예제에서는 'male', 'female')
EnumType.ORDINAL : Enum의 "상수값"을 저장 (예제에서는 1, 2)

 

하지만 @Enumerated의 단점이 있습니다.

1) Enum 타입 내부의 순서 혹은 이름이 변경된 경우
만약 성별을 입력하지 않은 경우도 따지기 위해서 enum Gender{none, male, female}로 변경했다고 가정해봅시다. EnumType.ORDINAL로 설정한 경우에는, 기존의 1의 값을 표현하던 male이 2로 변경되었으므로 앞으로 DB에는 2로 저장될 것입니다. 또 기존에 female이었기 때문에 2로 저장되어 있던 값들이 male로 표현되어 나오게 됩니다. 이름이 변경되는 경우에도 이와 같은 혼선을 빚을 수 있기 때문에 위험합니다.

2) EnumType의 종류가 2개이다.
Java의 Enum은 class이기 때문에 많은 필드 값을 가질 수 있습니다. 상수값 표현과 이름은 전환이 가능하지만, 다른 필드로는 변경이 불가능합니다. 이름을 저장하는 것도, 구분가능한 최소 사이즈의 String으로 축약하지 못하고 이름 그대로 DB에 표현하기 때문에 공간을 차지하는 것도 단점입니다.

 

 

---

 

🪄 2. AttributeConverter

 

 

위의 문제를 해결하기 위해 가장 적합한 방법은, JPA에서 제공하는 AttributeConverter를 사용하는 방식입니다.

인터페이스의 형식으로 제공되며, 이것을 implements해 convert하는 로직을 완성시키기만 하면 됩니다.

 

public Y convertToDatabaseColumn (X attribute) : 
엔티티 객체의 Attribute값을 데이터베이스 컬럼으로 변환시키는 메서드입니다.

public X convertToEntityAttribute (Y dbData) : 
DB의 컬럼에 저장된 값을 엔티티 객체가 가질 Attribute 값으로 변환시키는 메서드입니다.

 

@Converter
public class GenderConverter implements AttributeConverter<Gender, String>{
	
   @Override
   public String convertToDatabaseColumn(Gender attribute){
   		return attribute.name();
   }
   
   @Override
   public Gender convertToEntityAttribute(String dbData){
   		return Gender.valueOf(dbData);
   }
}

1) AttributeConverter를 implements 하기

2) @Converter 어노테이션 명시

3) 재정의 해야 하는 두 메소드 로직 채우기

 

.. 엔티티 나머지 생략
@Convert(converter = GenderConverter.class)
private Gender gender;

4) @Convert 어노테이션을 통해 컨버터 클래스 지정.

 

AttributeConverter를 활용하면, 꼭 상수값 혹은 이름이 아니더라도 로직을 직접 구현하는 것으로 다양한 변환이 가능합니다.

Enum의 이름 그대로가 아닌 축약을 거쳐 변환도 가능하고, Enum 객체가 아니더라도 JPA에서 지원하지 않는 타입을 엔티티의 Attribute로 사용하고 싶다면 이를 통해서 구현이 가능합니다. 

 

로직을 구현할 수 있다는 장점에서, 두 개 이상의 속성을 갖는 객체도 한 필드에 매핑시킬 수 있습니다.

두 개 이상의 속성을 갖는 객체를 ToString 오버라이딩한 후에, DB에 삽입할 수 있고

DB에서 꺼내 올 때는 파싱 로직을 구현해서 다시 객체를 생성해 converting 할 수 있습니다.

 

이와 같이 유연하고 확장성이 좋은 AttributeConverter를 사용하는 것이 @Enumerated를 사용하는 것보다 좋을 것 같습니다.

AttributeConverter의 단점으로는 클래스의 추가적인 구현이 있다는 것 외에는 별로 찾아보기 어려운 것 같습니다.