Mybatis에서 custom MapTypeHandler 사용해 보기

mysql / mariadb를 사용하면서 db table에 JsonType column (LongText 유형에 json_valid 제약 조건이 걸려있는 column)을 사용하는 경우 해당 column은 json 형태로 데이터를 저장할 수 있다.

json data는 java object에선 특정 도메인 또는 Map으로 지정하여 사용할 수 있고 Spring Data Jpa를 사용하는 경우 @JdbcTypeCode(SqlTypes.JSON) 을 해당 값에 지정하면 된다.

Mybatis에서는 db table column의 json data를 java의 Map으로 변환해 주는 처리가 없어서 mysql 쿼리 사용 시 오류가 발생한다.

https://mybatis.org/mybatis-3/configuration.html#typehandlers

이 경우 custom MapTypeHandler 를 구현하여 사용하면 해결된다.

MapTypeHandler 는 다음과 같다.

import java.sql.CallableStatement;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.util.Map;

import org.apache.ibatis.type.BaseTypeHandler;
import org.apache.ibatis.type.JdbcType;
import org.apache.ibatis.type.MappedTypes;
import org.springframework.http.converter.json.Jackson2ObjectMapperBuilder;

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;

@MappedTypes(Map.class)
public class MapTypeHandler extends BaseTypeHandler<Map<String, Object>> {

    private final ObjectMapper mapper;

    public MapTypeHandler(Jackson2ObjectMapperBuilder builder) {
        this.mapper = builder.createXmlMapper(false).build();
    }

    @Override
    public void setNonNullParameter(PreparedStatement ps, int i, Map<String, Object> parameter, JdbcType jdbcType) throws SQLException {
        ps.setString(i, this.toJson(parameter));
    }

    @Override
    public Map<String, Object> getNullableResult(ResultSet rs, String columnName) throws SQLException {
        return this.toMap(rs.getString(columnName));
    }

    @Override
    public Map<String, Object> getNullableResult(ResultSet rs, int columnIndex) throws SQLException {
        return this.toMap(rs.getString(columnIndex));
    }

    @Override
    public Map<String, Object> getNullableResult(CallableStatement cs, int columnIndex) throws SQLException {
        return this.toMap(cs.getString(columnIndex));
    }

    private String toJson(Map<String, Object> object) {
        try {
            return mapper.writeValueAsString(object);
        } catch (Exception e) {
            throw new RuntimeException(e);
        }
    }

    @SuppressWarnings("unchecked")
    private Map<String, Object> toMap(String content) {
        if (content == null) {
            return null;
        }

        try {
            return mapper.readValue(content, Map.class);
        } catch (JsonProcessingException e) {
            e.printStackTrace();
        }

        return null;
    }

}

해당 MapTypeHandler bean을 등록해 주고

@Bean
MapTypeHandler mapTypeHandler(Jackson2ObjectMapperBuilder builder) {
    return new MapTypeHandler(builder);
}

MyBatis의 SqlSessionFactory 선언 시 해당 typeHandler를 추가해 준다.

sqlSessionFactoryBean.addTypeHandlers(mapTypeHandler);

MyBatis xml mapper 파일에서 호출 시 해당 column의 type을 다음처럼 지정해 주면 된다.
(MapTypeHandler 에서 @MappedTypes 로 지정한 type이다.)

#{c.extraData,javaType=map},