• MyBatis TypeHandler的笔记
  • 需求
  • 项目背景
  • 调研
  • 实现
    • 编码
    • 配置
      • 启用
        • 在Spring Boot的配置文件增加type-handlers-package的配置
        • 在Spring Boot指定MyBatisConfig文件的路径，之后在MyBatisConfig中配置typeHandlers
      • 限定JavaType 和 JdbcType

MyBatis TypeHandler的笔记

需求

对所有查询结果中的类型为String 的属性做一个HTML Decode处理。

项目背景

Spring Boot 2.0 + MyBatis3.4.6

调研

自定义TypeHandler 可以实现 org.apache.ibatis.type.TypeHandler 接口或者继承一个类org.apache.ibatis.type.BaseTypeHandler。之后设置JavaType和JdbcType来限定这个TypeHandler 的范围。

参考： mybatis 3官方文档

实现

编码

@MappedTypes(String.class)
@MappedJdbcTypes(value = {CLOB,CLOB,VARCHAR,LONGVARCHAR,NVARCHAR,NCHAR,NCLOB},includeNullJdbcType = true)
public class MyStringTypeHandle extends BaseTypeHandler<String> {
    @Override public void setNonNullParameter(PreparedStatement ps, int i, String parameter, JdbcType jdbcType)
        throws SQLException {
        ps.setString(i, parameter);
    }

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

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

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

配置

启用

启用该TypeHandler 可以有以下几种方式：

在Spring Boot的配置文件增加type-handlers-package的配置

type-handlers-package的配置的值为TypeHandler的包名即可，即在application.properties文件增加以下配置：

mybatis.type-handlers-package=com.xxx.typehandler

该配置会被org.mybatis.spring.boot.autoconfigure.MybatisAutoConfiguration读取，并调用org.mybatis.spring.SqlSessionFactoryBean来完成TypeHandler的初始化。

在Spring Boot指定MyBatisConfig文件的路径，之后在MyBatisConfig中配置typeHandlers

配置如下：

• 在application.properties文件增加以下配置：

mybatis.config-location=classpath:mybatis-config.xml

• 在mybatis-config.xml文件增加以下配置：

<configuration>
	<typeHandlers>
		<package name="com.xxx.typehandler"/>
	</typeHandlers>
</configuration>

注：如果在application.properties文件指定了mybatis.configuration ，又同时配置mybatis.config-location,则需要把application.properties的mybatis.configuration的配置移到mybatis-config.xml文件里。否则启用会校验失败。

• 也可以直接在mybatis-config.xml配置指定的typeHandler类

<configuration>
	<typeHandlers>
		<typeHandler handler="com.xxx.typehandler.MyStringTypehandler"/>
	</typeHandlers>
</configuration>

注：无法在application.properties文件直接配置typeHandler类，因为虽然org.mybatis.spring.SqlSessionFactoryBean有setTypeHandlers(TypeHandler<?>[] typeHandlers)方法，但org.mybatis.spring.boot.autoconfigure.MybatisAutoConfiguration并没有去application.properties读取相关的配置并设置调用该方法。

限定JavaType 和 JdbcType

在官方文档中有这么一段话：

使用上述的类型处理器将会覆盖已经存在的处理 Java 的 String 类型属性和 VARCHAR 参数及结果的类型处理器。 要注意 MyBatis 不会通过窥探数据库元信息来决定使用哪种类型，所以你必须在参数和结果映射中指明那是 VARCHAR 类型的字段， 以使其能够绑定到正确的类型处理器上。这是因为 MyBatis 直到语句被执行时才清楚数据类型。

通过类型处理器的泛型，MyBatis 可以得知该类型处理器处理的 Java 类型，不过这种行为可以通过两种方法改变：

• 在类型处理器的配置元素（typeHandler 元素）上增加一个 javaType 属性（比如：javaType=”String”）；
• 在类型处理器的类上（TypeHandler class）增加一个 @MappedTypes 注解来指定与其关联的 Java 类型列表。 如果在 javaType 属性中也同时指定，则注解方式将被忽略。

可以通过两种方式来指定被关联的 JDBC 类型：

• 在类型处理器的配置元素上增加一个 jdbcType 属性（比如：jdbcType=”VARCHAR”）；
• 在类型处理器的类上增加一个 @MappedJdbcTypes 注解来指定与其关联的 JDBC 类型列表。 如果在 jdbcType 属性中也同时指定，则注解方式将被忽略。

当在 ResultMap 中决定使用哪种类型处理器时，此时 Java 类型是已知的（从结果类型中获得），但是 JDBC 类型是未知的。 因此 Mybatis 使用 javaType=[Java 类型], jdbcType=null 的组合来选择一个类型处理器。 这意味着使用 @MappedJdbcTypes 注解可以限制类型处理器的范围，同时除非显式的设置，否则类型处理器在 ResultMap 中将是无效的。 如果希望在 ResultMap 中使用类型处理器，那么设置 @MappedJdbcTypes 注解的 includeNullJdbcType=true 即可。 然而从 Mybatis 3.4.0 开始，如果只有一个注册的类型处理器来处理 Java 类型，那么它将是 ResultMap 使用 Java 类型时的默认值（即使没有 includeNullJdbcType=true）。

其中javaType 用来限定Java的类型，jdbcType 是用来限定JDBC的类型，类型列表见枚举类org.apache.ibatis.type.JdbcType。 在查询的时候，对于每个字段在进行转换处理时，会根据先根据字段对应的Java实体类的属性类型获取改类型的对应的typeHandler Map，再根据jdbcType获取该字段JDBC类型的对应的typeHandler 。默认如果String没有自定义typeHandler，那么它的typeHandler Map为：

    register(String.class, new StringTypeHandler());  //对应的是JdbcType.NULL
    register(String.class, JdbcType.CHAR, new StringTypeHandler());
    register(String.class, JdbcType.CLOB, new ClobTypeHandler());
    register(String.class, JdbcType.VARCHAR, new StringTypeHandler());
    register(String.class, JdbcType.LONGVARCHAR, new ClobTypeHandler());
    register(String.class, JdbcType.NVARCHAR, new NStringTypeHandler());
    register(String.class, JdbcType.NCHAR, new NStringTypeHandler());
    register(String.class, JdbcType.NCLOB, new NClobTypeHandler());

如果只设置javaType，那么jdbcType为JdbcType.NULL 如果只设置了jdbcType，那么javaType为typeHandler指定的泛型类。 如果javaType和jdbcType都不设置，那么映射关系为jdbcType为JdbcType.NULL，javaType为typeHandler指定的泛型类。

可以通过多种方式设置javaType和jdbcType

• 通过@MappedTypes 和@MappedJdbcTypes

  @MappedTypes(String.class)
  @MappedJdbcTypes(value = {CLOB,CLOB,VARCHAR,LONGVARCHAR,NVARCHAR,NCHAR,NCLOB},includeNullJdbcType = true)
  public class MyStringTypeHandle extends BaseTypeHandler<String> {
  

  注：@MappedJdbcTypes 的includeNullJdbcType属性默认值为false,当设置为true时，在绑定完jdbcType之后，还会额外绑定一个JdbcType.NULL的映射。

• 在mybatis-config.xml的<typeHandlers>的<typeHandler>节点的属性上设置

<configuration>
	<typeHandlers>
		<typeHandler javaType="String" jdbcType="VARCHAR"handler="com.xxx.typehandler.MyStringTypehandler"/>
	</typeHandlers>
</configuration>

• MyBatis (1)

• MyBatis (1) ,
• Spring Boot (9)