Mybatis之类型处理器

时间  2020-02-27
标签 mybatis 类型 处理器 栏目 MyBatis 繁體版
原文   原文链接

前言

上文Mybatis之XML如何映射到方法中讲到了类型处理器，分别用在两个地方设置参数到数据库和从结果集中取出数据，根据不一样的数据类型从类型注册器里面获取具体的类型处理器，分别进行处理；本文将重点介绍一下类型处理器，注册器，如何处理数据以及如何扩展。java

类型处理器

类型处理器Mybatis提供了接口TypeHandler，而且Mybatis实现了主流数据库支持类型的处理器实现，具体有哪些类型以下所示：git

处理器 java类型 数据库类型
BooleanTypeHandler Boolean,boolean BOOLEAN,BIT
ByteTypeHandler Byte,byte TINYINT
ShortTypeHandler Short,short SMALLINT
IntegerTypeHandler Integer,int INTEGER
LongTypeHandler Long,long BIGINT
FloatTypeHandler Float,float FLOAT
DoubleTypeHandler Double,double DOUBLE
StringTypeHandler String CHAR,VARCHAR
ClobTypeHandler String CLOB,LONGVARCHAR
NStringTypeHandler String NVARCHAR,NCHAR
NClobTypeHandler String NCLOB
ArrayTypeHandler Object ARRAY
BigDecimalTypeHandler BigDecimal REAL,DECIMAL,NUMERIC
BlobTypeHandler byte[] BLOB,LONGVARBINARY
UnknownTypeHandler Object OTHER或者未指定类型
DateTypeHandler Date TIMESTAMP
DateOnlyTypeHandler Date DATE
TimeOnlyTypeHandler Date TIME
SqlDateTypeHandler java.sql.Date DATE
SqlTimeTypeHandler java.sql.Time TIME
SqlTimestampTypeHandler java.sql.Timestamp TIMESTAMP
EnumTypeHandler 枚举类 VARCHAR或兼容的字符串类型

上面全部的类型处理器均可以在TypeHandlerRegistry注册器中找到，再来看一下TypeHandler提供的接口方法：github

public interface TypeHandler<T> {

  void setParameter(PreparedStatement ps, int i, T parameter, JdbcType jdbcType) throws SQLException;

  T getResult(ResultSet rs, String columnName) throws SQLException;

  T getResult(ResultSet rs, int columnIndex) throws SQLException;

  T getResult(CallableStatement cs, int columnIndex) throws SQLException;

}

四个方法分别表示：setParameter用来设置写入数据库的参数，getResult用来处理结果集和存储过程，能够经过字段名称和下标来处理；以上处理器并无直接实现TypeHandler，而是继承于公共的BaseTypeHandler，以StringTypeHandler为例只须要实现很简单的操做：sql

@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 rs.getString(columnName);
  }

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

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

分别表示往PreparedStatement中设置字符串参数，从ResultSet获取指定字段名称或者下标的字符串数据，以及从存储过程当中获取指定下标字符串数据。数据库

处理器注册器

全部处理器在启动的时候都注册到了TypeHandlerRegistry中，须要根据javaType或者jdbcType获取处理器时直接在注册器中获取便可，注册器中保存了相关的对应关系以下所示：apache

private final Map<JdbcType, TypeHandler<?>> JDBC_TYPE_HANDLER_MAP;
  private final Map<Type, Map<JdbcType, TypeHandler<?>>> TYPE_HANDLER_MAP;
  private final TypeHandler<Object> UNKNOWN_TYPE_HANDLER = new UnknownTypeHandler(this);
  private final Map<Class<?>, TypeHandler<?>> ALL_TYPE_HANDLERS_MAP ;
  private static final Map<JdbcType, TypeHandler<?>> NULL_TYPE_HANDLER_MAP = Collections.emptyMap();
  private Class<? extends TypeHandler> defaultEnumTypeHandler = EnumTypeHandler.class;

以上定义的几个变量的含义大体以下：
JDBC_TYPE_HANDLER_MAP：jdbcType对应的类型处理器Map；
TYPE_HANDLER_MAP：一个javaType对应多个jdbcType类型，这也好理解好比String类型能够对象数据库里面的char，varchar，clob等；而后每一个jdbcType对应各自的类型处理器；
UNKNOWN_TYPE_HANDLER：在没有配置jdbcType的状况下使用默认的UnknownTypeHandler处理器，此类会更新客户端参数来自动匹配相应的处理器；
ALL_TYPE_HANDLERS_MAP：全部的类型处理器类名称对应类型处理器；
NULL_TYPE_HANDLER_MAP：空Map，用来作断定是否为空的；
defaultEnumTypeHandler：枚举处理器；segmentfault

有对应关系，这样在设置参数和处理结果集的时候能够直接根据javaType或者jdbcType获取对应的类型处理器，根据具体的处理器处理相关参数。mybatis

处理数据

用到类型处理器主要在两个地方分别是设置参数的时候和处理结果集的时候，下面分别看一下两种场景；app

1.设置参数

在文章Mybatis之XML如何映射到方法中咱们将到了BoundSql，ParameterMapping以及处理参数的DefaultParameterHandler，看一段里面的核心代码：ide

TypeHandler typeHandler = parameterMapping.getTypeHandler();
 JdbcType jdbcType = parameterMapping.getJdbcType();
 if (value == null && jdbcType == null) {
     jdbcType = configuration.getJdbcTypeForNull();
 }
 try {
     typeHandler.setParameter(ps, i + 1, value, jdbcType);
 } catch (TypeException e) {
     ...省略...
 }

直接从ParameterMapping中获取具体的类型处理器，这里面的类型处理器是在解析xxMapper.xml根据设置的类型来决定的，下面以一个实例来讲明一下：

<select id="selectBlogMap" parameterType="hashmap" resultType="blog">
        select id,title from blog where id = #{id} and author=#{author,javaType=string,jdbcType=VARCHAR}
    </select>

如上实例有个参数须要设置分别是id和author，由于id没有指定具体的javaType和jdbcType因此解析的时候id的类型处理器是UnknownTypeHandler，而author指定了具体的类型因此能够解析的时候指定StringTypeHandler类型处理器；那id是未知的类型处理器如何处理Long类型哪，能够看到UnknownTypeHandler内部有一个resolveTypeHandler方法：

private TypeHandler<? extends Object> resolveTypeHandler(Object parameter, JdbcType jdbcType) {
    TypeHandler<? extends Object> handler;
    if (parameter == null) {
      handler = OBJECT_TYPE_HANDLER;
    } else {
      handler = typeHandlerRegistry.getTypeHandler(parameter.getClass(), jdbcType);
      // check if handler is null (issue #270)
      if (handler == null || handler instanceof UnknownTypeHandler) {
        handler = OBJECT_TYPE_HANDLER;
      }
    }
    return handler;
  }

能够看到没有配置类型的状况下，直接根据传递过来的参数类型从类型注册器中获取具体的处理器，好比这里的id是Long类型，因此最后获取的实际处理器是LongTypeHandler；

2.处理结果集

结果集咱们能够配置resultType和resultMap，在映射结果集的时候首先是须要经过对象工厂建立对象的，这个在上文Mybatis之对象工厂中详细介绍了，建立完对象以后须要往属性中设置值，至于如何获取值就是经过TypeHandler来实现的；如何获取对应的TypeHandler，使用resultType和resultMap有不一样的方式：
1.resultType
根据指定的类型，结果集中的属性映射到类中的属性，而后获取类中属性的类型，能够参考部分代码：

final String property = metaObject.findProperty(propertyName, configuration.isMapUnderscoreToCamelCase());
if (property != null && metaObject.hasSetter(property)) {
      if (resultMap.getMappedProperties().contains(property)) {
        continue;
      }
      final Class<?> propertyType = metaObject.getSetterType(property);
      if (typeHandlerRegistry.hasTypeHandler(propertyType, rsw.getJdbcType(columnName))) {
           final TypeHandler<?> typeHandler = rsw.getTypeHandler(propertyType, columnName);
           autoMapping.add(new UnMappedColumnAutoMapping(columnName, property, typeHandler, propertyType.isPrimitive()));
      } 
      ......
}

首先经过结果集中的属性获取到类对象中的属性名称，而后获取属性被定义的类型，经过此类型到注册器TypeHandlerRegistry中获取相应的处理器，最后经过调用处理器中的getResult方法获取对应的值，把值经过反射的方式赋值给经过对象工厂建立的对象。

2.resultMap
resultMap能够直接在xml中指定相关的类型，好比：

<resultMap id="blogResultMap" type="blog" autoMapping="true">
        <result property="id" column="id" javaType="long" jdbcType="BIGINT"/>
        <result property="title" column="title" javaType="string" jdbcType="VARCHAR"/>
    </resultMap>

直接给属性指定javaType和jdbcType，这样在解析xml的时候直接能够分配相关的类型处理器；固然也能够不指定，若是不指定的话处理方式相似resultType的方式，也须要根据resultMap中指定的type类型，获取相关属性的类型，而后在获取TypeHandler。

扩展处理器

扩展处理器有两种状况分别是：已有的类型处理器好比StringTypeHandler，咱们建立一个新的去覆盖它；另外就是建立一个以前没有处理类型的处理器，好比常见的枚举类型处理器；下面分别来扩展实现。

1.覆盖扩展

实现本身的MyStringTypeHandler，继承于BaseTypeHandler，以下所示：

@MappedTypes({ String.class })
@MappedJdbcTypes(JdbcType.VARCHAR)
public class MyStringTypeHandler extends BaseTypeHandler<String> {

    @Override
    public void setNonNullParameter(PreparedStatement ps, int i, String parameter, JdbcType jdbcType)
            throws SQLException {
        System.out.println("MyStringTypeHandler->setNonNullParameter");
        ps.setString(i, parameter);
    }
；
    @Override
    public String getNullableResult(ResultSet rs, String columnName) throws SQLException {
        System.out.println("MyStringTypeHandler->getNullableResult");
        return rs.getString(columnName);
    }

    @Override
    public String getNullableResult(ResultSet rs, int columnIndex) throws SQLException {
        System.out.println("MyStringTypeHandler->getNullableResult");
        return rs.getString(columnIndex);
    }

    @Override
    public String getNullableResult(CallableStatement cs, int columnIndex) throws SQLException {
        System.out.println("MyStringTypeHandler->getNullableResult");
        return cs.getString(columnIndex);
    }
}

须要指定注解MappedTypes和MappedJdbcTypes，分别表示javaType和jdbcType；而后实现BaseTypeHandler中四个抽象方法便可；固然也能够不用注解的方式，能够在configuration中进行类型的配置：

<typeHandlers>
        <typeHandler javaType="string" jdbcType="VARCHAR" handler="com.mybatis.myTypeHandler.MyStringTypeHandler" />
    </typeHandlers>

指定了javaType="string"以及jdbcType="VARCHAR" 的状况下使用MyStringTypeHandler进行处理；这样配完以后可能有一些问题，好比参数在没有指定jdbcType的状况下，仍是会用默认的String类型，这是为何了那，由于在TypeHandlerRegistry中初始化了String处理器：

register(String.class, new StringTypeHandler());

没有指定jdbcType的状况下会初始化null->StringTypeHandler；因此要解决这个问题，咱们还能够继续添加一行以下所示：

<typeHandlers>
        <typeHandler javaType="string" handler="com.mybatis.myTypeHandler.MyStringTypeHandler" />
    </typeHandlers>

2.枚举处理器扩展

Mybatis提供了两个默认的枚举类型处理器分别是：EnumTypeHandler和EnumOrdinalTypeHandler；分别表示用枚举字符串名称做为参数，另外一个是使用整数下标做为参数传递；使用也很简单，使用以下配置：

<typeHandler javaType="com.mybatis.vo.AuthorEnum" handler="org.apache.ibatis.type.EnumTypeHandler" />

若是默认的两种方式不能知足，那能够自定义本身的枚举类型处理器，以下经过处理器经过id来获取枚举，代码以下：

public class AuthorEnumTypeHandler implements TypeHandler<AuthorEnum> {

    @Override
    public void setParameter(PreparedStatement ps, int i, AuthorEnum parameter, JdbcType jdbcType) throws SQLException {
        System.out.println("AuthorEnumTypeHandler->setParameter");
        ps.setInt(i, parameter.getId());
    }

    @Override
    public AuthorEnum getResult(ResultSet rs, String columnName) throws SQLException {
        int id = Integer.valueOf(rs.getString(columnName));
        System.out.println("AuthorEnumTypeHandler->getResult");
        return AuthorEnum.getAuthor(id);
    }

    @Override
    public AuthorEnum getResult(ResultSet rs, int columnIndex) throws SQLException {
        int id = rs.getInt(columnIndex);
        System.out.println("AuthorEnumTypeHandler->getResult");
        return AuthorEnum.getAuthor(id);
    }

    @Override
    public AuthorEnum getResult(CallableStatement cs, int columnIndex) throws SQLException {
        int id = cs.getInt(columnIndex);
        System.out.println("AuthorEnumTypeHandler->getResult");
        return AuthorEnum.getAuthor(id);
    }
}

总结

本文首先介绍了Mybatis默认有哪些类型处理器，以及每种处理器对应的java类型和jdbc类型；而后介绍了注册器是如何把保存javaType，jdbcType以及TypeHandler对应关系的；接下来介绍TypeHandler主要在两个地方分别是设置参数的时候和处理结果集；最后经过覆盖的方式和新建的方式来扩展处理器，并给出了实例。

完整代码

Github

相关文章
相关标签/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公众号
   欢迎关注本站公众号,获取更多信息
联系我们 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程