MyBatis(九):MyBatis类型处理器(TypeHandler)详解

本文主要是介绍MyBatis(九):MyBatis类型处理器(TypeHandler)详解，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

TypeHandler简介

TypeHandler，顾名思义类型转换器，就是将数据库中的类型与Java中的类型进行相互转换的处理器。

MyBatis 在设置预处理语句（PreparedStatement）中的参数或从结果集中取出一个值时，都会用类型处理器将获取到的值以合适的方式转换成 Java 类型

实现讲解

经常自定义类型转换器方式有两种，实现 TypeHandler 接口，或继承抽象类 BaseTypeHandle，并且可以指定转换后的字段类型。

其实BaseTypeHandler也是继承了TypeHandler接口，在实现的TypeHandler接口的方法中调用的是自身抽象方法，如下

public abstract class BaseTypeHandler<T> extends TypeReference<T> implements TypeHandler<T> {public T getResult(ResultSet rs, String columnName) throws SQLException {Object result;try {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 abstract T getNullableResult(ResultSet var1, String var2) throws SQLException;
}

抽象类BaseTypeHandler的抽象方法

// 执行之前，将Java类型转换为对应的jdbc类型，用于赋值sql中参数
public abstract void setNonNullParameter(PreparedStatement var1, int var2, T var3, JdbcType var4) throws SQLException;// 根据列名从resultSet中获取，将JDBC类型转换为Java类型
public abstract T getNullableResult(ResultSet var1, String var2) throws SQLException;// 根据下标从resultSet中获取，将JDBC类型转换为Java类型
public abstract T getNullableResult(ResultSet var1, int var2) throws SQLException;// 用于在执行完存储过程后，将JDBC类型转换为Java类型
public abstract T getNullableResult(CallableStatement var1, int var2) throws SQLException;

自定义类型处理器

假设现在有一个支付标识(0-否 1-是)字段，数据库中我们存入的是tinyint 0/1，但是前端显示却是是/否，使用TypeHandler就可以实现。具体步骤如下：

新建MyTypeHandler，继承BaseTypeHandler类

public class MyTypeHandler extends BaseTypeHandler<String> {/*** @Description 执行之前，将Java类型转换为对应的jdbc类型，用于赋值sql中参数**/@Overridepublic void setNonNullParameter(PreparedStatement preparedStatement, int i, String s, JdbcType jdbcType) throws SQLException {preparedStatement.setInt(i,Integer.valueOf(s));}/*** @Description 根据列名从resultSet中获取，将JDBC类型转换为Java类型**/@Overridepublic String getNullableResult(ResultSet resultSet, String s) throws SQLException {return this.convert(resultSet.getInt(s));}/*** @Description 根据下标从resultSet中获取，将JDBC类型转换为Java类型**/@Overridepublic String getNullableResult(ResultSet resultSet, int i) throws SQLException {return this.convert(resultSet.getInt(i));}/*** @Description 用于在执行完存储过程后，将JDBC类型转换为Java类型**/@Overridepublic String getNullableResult(CallableStatement callableStatement, int i) throws SQLException {return this.convert(callableStatement.getInt(i));}/*** @Description 对数据库中0/1进行转换**/private String convert(int flag){if (flag==1){return "是";}return "否";}
}

在Mapper中指定需要转换的字段，jdbcType指数据库中的类型，javaType指Java中的类型，typeHandler指定自定义的转换器

<result column="flag" property="flag" jdbcType="TINYINT" javaType="java.lang.String" typeHandler="com.rangers.MyTypeHandler"></result>

进行测试

    private SqlSession sqlSession ;private OrderMapper orderMapper;@Beforepublic void init() throws IOException {InputStream inputStream = Resources.getResourceAsStream("SqlMapConfig.xml");SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);sqlSession = sqlSessionFactory.openSession();orderMapper = sqlSession.getMapper(OrderMapper.class);}// 测试读取时转换@org.junit.Testpublic void testResult(){Order order = orderMapper.selectOne(1);System.out.println(order);}// 测试传入时转换@org.junit.Testpublic void testParameter(){// 假设前端传入字符串0/1List<Order> orders = orderMapper.selectOneByFlag("1");System.out.println(orders);}@Afterpublic void close(){sqlSession.close();}

[Order{id=2, time=Wed Mar 10 17:22:45 CST 2021, total=2.22, uid=1, flag=是}, Order{id=3, time=Wed Mar 10 17:22:57 CST 2021, total=3.33, uid=2, flag=是}]

全局字段转换与单个字段转换

全局转换：在核心配置文件中添加typeHandlers标签
```
<typeHandlers><typeHandler handler="com.rangers.MyTypeHandle"/>
</typeHandlers>
```
单个字段转换：指定jdbcType、javaType与typeHandler
```
<result column="flag" property="flag" jdbcType="TINYINT" javaType="java.lang.String" typeHandler="com.rangers.MyTypeHandler"></result>
```
通常在项目中使用的是单个字段进行转换，经常自定义类型处理器还有日期处理、加密字段处理、List处理，JSON处理等