Mybatis实现自定义的类型转换器TypeHandler

此文其实是java操作Oracle类型XMLType总结二：使用Mybatis附带的一篇小结。

Mybatis实现自定义的转换器，十分的简单，其主要步骤分为三步，这里以操作XMLType类型为例。

第一步

新建一个转换类，实现TypeHandler接口，接口的泛型指定参数类型，不指定则为Object：

public class XmltypeTypeHandler implements TypeHandler<String>

该接口主要有以下4个方法：

public void setParameter(PreparedStatement ps, int i, String parameter, JdbcType jdbcType) public String getResult(ResultSet rs, String columnName) throws SQLException

public String getResult(ResultSet rs, int columnIndex) throws SQLException

public String getResult(CallableStatement cs, int columnIndex) throws SQLException

方法的作用看名字应该就能明白，setParameter是传入参数时的操作，在参数传入到数据库前需要做加工处理的代码，可以写在该方法内，其它三个均为获取查询结果方法，在得到jdbc的查询结果后可以转换为任意你想要的类型。

第二步

在mapper-config中，注册你实现的转换器类，其中jdbcType可以指定的类型在Mybatis的枚举类org.apache.ibatis.type.JdbcType中有明确的定义，不能为该枚举以外的值，不然会出错。这里因为枚举中没有我们需要的XMLType类型，所以指定为UNDEFINED。（也可以不指定具体的类型，在使用时用typeHandler指定具体的类即可）：

<typeHandlers>
    <typeHandler javaType="string" jdbcType="UNDEFINED" handler="com.tyyd.dw.context.XmltypeTypeHandler"/>
</typeHandlers>

第三步

在你的mapper映射文件中使用类型转换器：

insert into T_Content(
<include refid="fullColumns"/>
) values (
#{controlId,jdbcType=BIGINT},
#{xmlFile,javaType=string,jdbcType=UNDEFINED,typeHandler=com.tyyd.dw.context.XmltypeTypeHandler},
#{drmFile,jdbcType=BLOB}
)

注意传入的xmlFile参数，指定了javaType、jdbcType和typeHandler，表明我们要使用哪个类型处理器，当然你也可以只指定其中的某一项，但是该项存在必须唯一，如果一模一样存在多个又指定不清晰的话，Mybatis会因为不能进行区分而出现错误。

至此，一个mybatis的自定义类型转换器就实现完成了，需要注意的是，上面指定的类型处理器仅在插入数据时起作用，想要在查询时也使用自定义的类型处理器，需要在resultMap内属性的标签中进行指定，其指定的标签javaType、jdbcType和typeHandler名称和使用方式都是一样的，这里就不再赘述。

附上完整的类型转换器代码，因为XMLType类型要查询时，可以使用数据库的xmltype.getclobval()直接返回当成string来操作，所以返回的方法都没有进行特殊处理。(也可以使用xmltype.getstringval()函数返回string，但在实际使用过程中发现当字段为null时，getstringval()会出现ORA-06502:numeric or value error:character string buffer too small的错误，getclobval()则不会出现错误，所以推荐使用getclobval()函数)：

/**
 * oracle SYS.XMLTYPE 类型自定义处理器
 * 
 * User: liyd
 * Date: 13-12-27
 * Time: 下午4:53
 */
public class XmltypeTypeHandler implements TypeHandler<String> {
    @Override
    public void setParameter(PreparedStatement ps, int i, String parameter, JdbcType jdbcType)
                                                                                              throws SQLException {
        //防止为null时，创建XMLType出现错误
        if (StringUtils.isNotBlank(parameter)) {
            DelegatingConnection connection = (DelegatingConnection) ps.getConnection()
                .getMetaData().getConnection();
            XMLType xmltype = XMLType.createXML(connection.getDelegate(), parameter);
            ps.setObject(i, xmltype);
        } else {
            ps.setString(i, null);
        }
    }
    @Override
    public String getResult(ResultSet rs, String columnName) throws SQLException {
        //数据库sql查询时xmltype字段使用xmltype.getclobval()返回
        return rs.getString(columnName);
    }
    @Override
    public String getResult(ResultSet rs, int columnIndex) throws SQLException {
        return rs.getString(columnIndex);
    }
    @Override
    public String getResult(CallableStatement cs, int columnIndex) throws SQLException {
        return cs.getString(columnIndex);
    }
}

Mybatis实现自定义的类型转换器TypeHandler

第一步

第二步

第三步

selfly