Gidhub BE Developer

MyBatis 공식 문서(Docs) 읽어보기 : Handling Enums

2020-06-07
goodGid
MyBatis

Prologue

Handling Enums

If you want to map an Enum, 
you'll need to use either EnumTypeHandler or EnumOrdinalTypeHandler.

Note EnumTypeHandler is special in the sense that unlike other handlers, 
it does not handle just one specific class, but any class that extends Enum

  • MyBatis 사용 시

    Enum Type에 매핑을 하려고 한다면

    EnumTypeHandler 혹은 EnumOrdinalTypeHandler을 사용해야 한다.

  • EnumTypeHandler는 일반적인 handlers와 다르게

    하나의 특별한 클래스만 다루는 게 아니라

    Enum 클래스를 extend 하는 모든 클래스를 다룬다.

    (= <E extends Enum> )

EnumTypeHandler.class

package org.apache.ibatis.type;

public class EnumTypeHandler<E extends Enum<E>> extends BaseTypeHandler<E> {
    private Class<E> type;

    public EnumTypeHandler(Class<E> type) {
        if (type == null) {
            throw new IllegalArgumentException("Type argument cannot be null");
        } else {
            this.type = type;
        }
    }

    public void setNonNullParameter(PreparedStatement ps, 
                                    int i, E parameter, 
                                    JdbcType jdbcType) throws SQLException {
        if (jdbcType == null) {
            ps.setString(i, parameter.name());
        } else {
            ps.setObject(i, parameter.name(), jdbcType.TYPE_CODE);
        }
    }
}

  • i번째 값을

    입력받은 parameter를 그대로 사용하는 게 아니라

    parameter.name()의 값으로 사용하는 걸 볼 수 있다.

  • 즉 이 경우에 parameter는 Enum이 될 테고

    Enum.name()이기 때문에

    사용자가 명시한 Enum 클래스가 적절한 값으로 convert 되는 걸 알 수 있다.

EnumOrdinalTypeHandler.class

package org.apache.ibatis.type;

public class EnumOrdinalTypeHandler<E extends Enum<E>> extends BaseTypeHandler<E> {
    private Class<E> type;
    private final E[] enums;

    public EnumOrdinalTypeHandler(Class<E> type) {
        if (type == null) {
            throw new IllegalArgumentException("Type argument cannot be null");
        } else {
            this.type = type;
            this.enums = (Enum[])type.getEnumConstants();
            if (this.enums == null) {
                throw new IllegalArgumentException(type.getSimpleName() + " does not represent an enum type.");
            }
        }
    }

    public void setNonNullParameter(PreparedStatement ps, 
                                    int i, E parameter, 
                                    JdbcType jdbcType) throws SQLException {
        // ordinal을 가져오기 때문에 Enum의 위치값으로 매핑된다.
        // 여기서 말하는 위치값이란 0,1,2,3, ... 이다.                              
        ps.setInt(i, parameter.ordinal());
    }
}

  • EnumTypeHandler 와 동작 과정은 비슷하다.

    하지만 EnumTypeHandler 는 parameter.name()이라면

    EnumOrdinalTypeHandler 는 클래스 명에서 알 수 있듯이

    parameter.ordinal() 값으로 convert 해주는 것을 알 수 있다.

Example

Summary

  • MyBatis의 Handling Enums 속성에 대해 알아봤다.

  • 영어로 작성되어있기 때문에 주관적으로 해석하고 의역을 하였다.

    혹시 글을 읽다 이상한 부분이 있다면 직접 문서를 읽어보는 걸 추천한다.

    ( 추가로 피드백까지 주면 매우 감사하겠습니다. )

  • 만약 영어로 된 문서를 읽기 힘들다면 한글로 번역된 사이트를 참고하자.

Reference

Recommend

Index