[JPA] @Enumerated, @Converter

@Enumerated

자바 enum 타입을@Enumerated 애노테이션을 통해 엔티티 매핑할수 있다. 

@Enumerated 어노테이션에는

• EnumType.ORIGINAL : enum 순서(숫자) 값을 DB에 저장
• EnumType.STRING: enum 이름 값을 DB에 저장

두가지 타입이 있다. 

 

 

예로 들어,

@AllArgsConstructor
public enum UserRole {

    ROLE_ADMIN("관리자"),

    ROLE_USER("회원");

    private final String description;
}

@Column(nullable = false)
@Enumerated(EnumType.ORDINAL)
private UserRole roles;

해당 enum을 ORIDINAL로 지정하고 role속성을 각각 설정하면 DB에 

ROLE_ADMIN은 1 로 저장되고

ROLE_USER은 2 로 저장된다. 
STRING타입으로 지정하면 "ROLE_ADMIN", "ROLE_USER" 문자열로 저장된다. 

 

하지만 ORDINAL로 설정 후 enum값들의 순서가 변경된다면 데이터를 잘못 읽어오는 문제가 생길수도 있으며, 

STRING 설정은 나중에 문자열이 바뀌면 맞는 값이 없어서 DB에서 데이터를 가져올때 에러를 발생시킨다. 또한 문자열 자체가 저장되기 때문에 DB 공간 낭비가 발생한다.

 

이를 대체할 수 있는 좋은 방법은 converter 를 사용하는 것이다.

 

---

Attribute Converter

Attribute Converter는 Entity와 DB사이에서 속성의 변환을 담당한다.

예로 들어 성별 (gender)을 DB에 'w', 'm'으로 저장하고싶을때나 엔티티에는 boolean, 데이터베이스에는 YN 값을 저장하고 싶을때 사용한다.

 

 

명세에 있는 첫 번째 제네릭 X는 Entity의 Field 자료형, 두 번째 제네릭 Y는 Database Column 자료형을 나타낸다.  구현은 간단한데 2개의 메소드 convertToDatabaseColumn와 convertToEntityAttribute를 구현함으로써 Converter를 만들 수 있다.

 

@Converter
public class UserRoleTypeConverter implements AttributeConverter<UserRole, Integer> {

    @Override
    public Integer convertToDatabaseColumn(UserRole attribute) {
        if (attribute == null) return null;
        return (attribute == ROLE_ADMIN) ? 0 : 1;
    }

    @Override
    public UserRole convertToEntityAttribute(Integer dbData) {
        if (dbData == null) return null;
        return (dbData == 0) ? ROLE_ADMIN : ROLE_USER;
    }

 

필자는 UserRole의 Enum타입을 DB에 Integer로 저장하려한다.

 

이렇게 구현한 Converter을 JPA의 매핑 클래스에서 @Convert 애노테이션을 사용해서 값을 변환대상 프로퍼티에 컨버터를 지정해주면 된다. 

@Column(nullable = false)
@Convert(converter = UserRoleTypeConverter.class)
private UserRole roles;

 

하지만 @Converter를 쓸때 주의할점이 있는데 아래 블로그를 참고하면 좋을것같다.

 

https://msolo021015.medium.com/jpa%EC%9D%98-attributeconverter%EB%A5%BC-%EC%82%AC%EC%9A%A9%ED%95%A0-%EB%95%8C-%EC%A3%BC%EC%9D%98%ED%95%A0-%EC%A0%90-e27a824f3018

JPA의 AttributeConverter를 사용할 때 주의할 점

 

 

 

 

 

 

 

참고

• https://rachel0115.tistory.com/entry/JPA-JPA-AttributeConverter%EB%A5%BC-%EC%82%AC%EC%9A%A9%ED%95%98%EC%97%AC-%EC%9E%90%EB%8F%99%EC%9C%BC%EB%A1%9C-%EA%B0%92%EC%9D%84-%EB%B3%80%ED%99%98%ED%95%98%EA%B8%B0?category=1129692 
• https://small-stap.tistory.com/87