Mybatis——TypeHandler 类型转换器

本文深入探讨MyBatis框架中的TypeHandler机制,包括TypeHandler接口、BaseTypeHandler抽象类和具体实现如StringTypeHandler。解析了不同TypeHandler如何处理Java类型与数据库类型的转换。
jdbcType:定义了数据库中的数据类型。
javaType:定义了java中的数据类型。
TypeHandler:承担了jdbcType和javaType之间的互相转换。

一、TypeHandler 接口源码


/*
 * TypeHandler接口
 * @ BaseTypeHandler<T>
 * */
public interface TypeHandler<T> {
	//通过PreparedStatement设置SQL参数
    void setParameter(PreparedStatement var1, int var2, T var3, JdbcType var4) throws SQLException;
	//根据列名获取结果集
    T getResult(ResultSet var1, String var2) throws SQLException;
	//根据下标获取结果集
    T getResult(ResultSet var1, int var2) throws SQLException;
	//存储过程
    T getResult(CallableStatement var1, int var2) throws SQLException;
}

在mybatis中typeHandler都要(BaseTypeHander)实现org.apache.ibatis.type.TypeHandler接口,或接继承BaseTypeHander。

二、BaseTypeHandler 抽象类源码

//
// Source code recreated from a .class file by IntelliJ IDEA
// (powered by Fernflower decompiler)
//

package org.apache.ibatis.type;

import java.sql.CallableStatement;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.SQLException;
import org.apache.ibatis.executor.result.ResultMapException;
import org.apache.ibatis.session.Configuration;

public abstract class BaseTypeHandler<T> extends TypeReference<T> implements TypeHandler<T> {
    protected Configuration configuration;

    public BaseTypeHandler() {}

    public void setConfiguration(Configuration c) {
        this.configuration = c;
    }
	
    public void setParameter(PreparedStatement ps, int i, T parameter, JdbcType jdbcType) throws SQLException {
    	
        if (parameter == null) {
            if (jdbcType == null) {
            	// jdbcType 为null是抛出异常,jdbcType不能为空
                throw new TypeException("JDBC requires that the JdbcType must be specified for all nullable parameters.");
            }
            try {
            	// 设置空参
                ps.setNull(i, jdbcType.TYPE_CODE);
            } catch (SQLException var7) {
                throw new TypeException("Error setting null for parameter #" + i + " with JdbcType " + jdbcType + " . Try setting a different JdbcType for this parameter or a different jdbcTypeForNull configuration property. Cause: " + var7, var7);
            }
        } else {
            try {
            	//setNonNullParameter是一个虚方法,需要BaseTypeHandler子类去实现
                this.setNonNullParameter(ps, i, parameter, jdbcType);
            } catch (Exception var6) {
                throw new TypeException("Error setting non null for parameter #" + i + " with JdbcType " + jdbcType + " . Try setting a different JdbcType for this parameter or a different configuration property. Cause: " + var6, var6);
            }
        }

    }
	
    public T getResult(ResultSet rs, String columnName) throws SQLException {
        Object result;
        try {
        	//getNullableResult是一个虚方法,需要BaseTypeHandler子类去实现
            result = this.getNullableResult(rs, columnName);
        } catch (Exception var5) {
            throw new ResultMapException("Error attempting to get column '" + columnName + "' from result set.  Cause: " + var5, var5);
        }

        return rs.wasNull() ? null : result;
    }

    public T getResult(ResultSet rs, int columnIndex) throws SQLException {
        Object result;
        try {
        	是一个虚方法,需要BaseTypeHandler子类去实现
            result = this.getNullableResult(rs, columnIndex);
        } catch (Exception var5) {
            throw new ResultMapException("Error attempting to get column #" + columnIndex + " from result set.  Cause: " + var5, var5);
        }

        return rs.wasNull() ? null : result;
    }

    public T getResult(CallableStatement cs, int columnIndex) throws SQLException {
        Object result;
        try {
        	//getNullableResult是一个虚方法,需要BaseTypeHandler子类去实现
            result = this.getNullableResult(cs, columnIndex);
        } catch (Exception var5) {
            throw new ResultMapException("Error attempting to get column #" + columnIndex + " from callable statement.  Cause: " + var5, var5);
        }

        return cs.wasNull() ? null : result;
    }
	
	//4个子类需要实现的虚方法
    public abstract void setNonNullParameter(PreparedStatement var1, int var2, T var3, JdbcType var4) throws SQLException;

    public abstract T getNullableResult(ResultSet var1, String var2) throws SQLException;

    public abstract T getNullableResult(ResultSet var1, int var2) throws SQLException;

    public abstract T getNullableResult(CallableStatement var1, int var2) throws SQLException;
}

三、StringTypeHandler源码

public class StringTypeHandler extends BaseTypeHandler<String> {
    public StringTypeHandler() {
    }

    public void setNonNullParameter(PreparedStatement ps, int i, String parameter, JdbcType jdbcType) throws SQLException {
        ps.setString(i, parameter);
    }

    public String getNullableResult(ResultSet rs, String columnName) throws SQLException {
        return rs.getString(columnName);
    }

    public String getNullableResult(ResultSet rs, int columnIndex) throws SQLException {
        return rs.getString(columnIndex);
    }

    public String getNullableResult(CallableStatement cs, int columnIndex) throws SQLException {
        return cs.getString(columnIndex);
    }
}

mybatis内部实现的TypeHandler

typeHandlerjavaType
NClobTypeHandlerstring
ClobReaderTypeHandlerReader
OffsetTimeTypeHandlerOffsetTime
ByteObjectArrayTypeHandlerByte[]
DateOnlyTypeHandlerDate
BlobTypeHandlerbyte[]
DateTypeHandlerDate
IntegerTypeHandlerInteger
SqlTimeTypeHandlerTime
NStringTypeHandlerString
CharacterTypeHandlerCharacter
ArrayTypeHandlerObject
EnumOrdinalTypeHandlerE extends Enum < E >
StringTypeHandlerString
BigDecimalTypeHandlerBigDecimal
SqlTimestampTypeHandlerTimestamp
BooleanTypeHandlerBoolean
BlobInputStreamTypeHandlerInputStream
BlobByteObjectArrayTypeHandlerByte[]
EnumTypeHandlerE extends Enum< E >
MonthTypeHandlerMonth
FloatTypeHandlerFloat
ByteTypeHandlerByte
TimeOnlyTypeHandlerDate
YearMonthTypeHandlerYearMonth
InstantTypeHandlerInstant
ObjectTypeHandlerObject
ClobTypeHandlerString
DoubleTypeHandlerDouble
ShortTypeHandlerShort
LongTypeHandlerLong
LocalDateTypeHandlerLocalDate
UnknownTypeHandlerObject
BigIntegerTypeHandlerBigInteger
ByteArrayTypeHandlerbyte[]
OffsetDateTimeTypeHandlerOffsetDateTime
JapaneseDateTypeHandlerJapaneseDate
LocalDateTimeTypeHandlerLocalDateTime
ZonedDateTimeTypeHandlerZonedDateTime
SqlDateTypeHandlerDate
YearTypeHandlerYear
LocalTimeTypeHandlerLocalTime
### 关于 MyBatisPlus 中集合类型转换 MyBatis-Plus 是一个用于简化数据库操作的增强工具,基于 MyBatis 进行扩展[^1]。对于集合类型的处理,通常涉及到查询结果映射到 Java 对象列表的情况。 #### 配置教程 为了实现自定义的集合类型转换,可以通过创建 `TypeHandler` 来完成特定的数据类型之间的转换逻辑。下面是如何配置和使用 TypeHandler 实现集合类型转换的例子: ##### 步骤 1: 创建自定义 TypeHandler 类 假设有一个场景是从数据库读取 JSON 字符串并将其解析成 List<String> 类型,则可以编写如下所示的一个简单的 TypeHandler: ```java import com.baomidou.mybatisplus.core.handlers.AbstractJsonTypeHandler; import org.apache.ibatis.type.JdbcType; public class StringListTypeHandler extends AbstractJsonTypeHandler<List<String>> { @Override protected List<String> parse(String json) { // 解析JSON字符串为List<String> return JsonUtils.parseArray(json, String.class); } @Override public void setNonNullParameter(PreparedStatement ps, int i, List<String> parameter, JdbcType jdbcType) throws SQLException { // 将List<String>转为JSON字符串存储至数据库 ps.setString(i, JsonUtils.toJson(parameter)); } } ``` 这里利用了 `AbstractJsonTypeHandler` 提供的基础功能来减少重复代码量,并通过重写两个主要方法实现了双向转换的功能[^2]。 ##### 步骤 2: 注册 TypeHandler 可以在 XML 映射文件中指定该处理器应用于某个字段上;也可以全局注册此处理器使其自动应用到所有匹配类型的属性之上。以下是两种方式的具体做法: ###### 方法 A - 局部声明 (XML) 在 Mapper 文件中的 SQL 语句里直接指明要使用的 handler: ```xml <resultMap id="exampleResultMap" type="Example"> <!-- ... --> <collection property="stringListField" ofType="String" javaType="list" column="json_column_name" typeHandler="com.example.StringListTypeHandler"/> </resultMap> ``` ###### 方法 B - 全局配置 (Java Config 或者 application.yml) 如果希望在整个项目范围内生效而不必每次都手动设置的话,那么可以选择这种方式来进行一次性配置: ```yaml mybatis-plus: configuration: type-handlers-package: com.example.typehandlers ``` 这会告诉框架去扫描指定包下的所有类并将它们作为潜在可用的手动处理器实例化出来[^3]。 #### 使用示例 当完成了上述配置之后,在执行 CRUD 操作时就可以像平常一样对待这些经过特殊处理过的字段了——无论是保存还是检索数据都不再需要额外考虑底层细节部分。 ```java // 假设我们有这样一个实体对象 @Entity @Table(name = "t_example") public class ExampleEntity implements Serializable { private static final long serialVersionUID = 1L; @TableId(value = "id", type = IdType.AUTO) private Long id; /** * 存储的是JSON格式化的字符串形式的数组, * 经过上面提到的TypeHandler会被自动转化为实际的对象结构。 */ private List<String> stringListField; // getter & setter ... } // 然后你可以这样调用 DAO 接口进行增删改查操作 exampleMapper.insert(new ExampleEntity().setStringListField(Arrays.asList("a","b"))); List<ExampleEntity> examples = exampleMapper.selectList(null); for (var e : examples){ System.out.println(e.getStringListField()); } ```
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值