[JPA] @Converter

@Converter

컨버터를 사용하면 엔티티의 데이터를 변환에서 데이터베이스에 저장할 수 있다. 

 

예를 들어서 회원의 VIP여부를 자바의 boolean 타입을 사용하고 싶다고 하자.

JPA를 사용하면 자바의 boolean 타입은 방언에 따라 다르겠지만, 데이터베이스에 저장될 때 0 또는 1로 저장된다.

그런데 데이터베이스에 숫자 대신 Y 또는 N으로 저장하고 싶으면 어떻게 해야할까?

그럴 때 사용할 수 있는 것이 바로 컨버터다.

 

 

 

사용

@Getter
@NoArgsConstructor(access = AccessLevel.PROTECTED)
@Entity
public class Member {

    @Id @GeneratedValue
    @Column(name = "MEMBER_ID")
    private Long id;

    private String name;


    @Convert(converter = BooleanToYNConverter.class)
    private boolean vip;
    


}

@Converter
public class BooleanToYNConverter implements AttributeConverter<Boolean, String > {


    @Override
    public String convertToDatabaseColumn(Boolean attribute) {
        return (attribute != null && attribute) ? "Y" : "N";
    }

    @Override
    public Boolean convertToEntityAttribute(String dbData) {
        return "Y".equals(dbData);
    }
}

컨버터 클래스는 @Converter 어노테이션을 사용하고, AttributeConverter 인터페이스를 구현해야 한다.

그리고 제네릭에 현재 타입과 변환할 타입을 지정해야 한다.

여기서는 Boolean을 String 으로 바꾸기 때문에 <Boolean, String>을 적어주었다.

 

AttributeConverter&lt;X,Y&gt; 인터페이스

 

 

추가로 @Convert는 다음과 같이 클래스 레벨에도 설정할 수 있다.

@Convert(converter = BooleanToYNConverter.class, attributeName = "vip")
@Getter
@NoArgsConstructor(access = AccessLevel.PROTECTED)
@Entity
public class Member {

    @Id @GeneratedValue
    @Column(name = "MEMBER_ID")
    private Long id;

    private String name;

    private boolean vip;

}

단 이때는 attributeName을 꼭 지정해 주어야 한다.

 

 

 

글로벌 적용

모든 Boolean 타입에 자동으로 컨버터를 적용하려면 다음과 같이 @Converter의 autoApply 속성을 true로 설정해주면 된다.

@Converter(autoApply = true)
public class BooleanToYNConverter implements AttributeConverter<Boolean, String > {


    @Override
    public String convertToDatabaseColumn(Boolean attribute) {
        return (attribute != null && attribute) ? "Y" : "N";
    }

    @Override
    public Boolean convertToEntityAttribute(String dbData) {
        return "Y".equals(dbData);
    }
}

 

글로벌 설정에서 제외하고 싶거나 상속 받은 컨버터를 사용하지 않으려면 @Convert의 disableConversion 속성을 false로 주자.

 

 

 

 

📔 Reference

[자바 ORM 표준 JPA 프로그래밍]