`

Ibatis的类型处理器TypeHandler解析

 
阅读更多

原文来自: http://blog.csdn.net/lovingprince/article/details/2768849

 

Ibatis允许用户像在hibernate中一样定义自己的类型,但是,用户自定义类型需要与数据库中的字段类型进行对应。它的处理方法是允许我们扩展TypeHandler。Ibatis框架在处理该数据类型时就会自动调用TypeHandler进行类型转换,非常方便,ibatis中所有的类型都有它自己的TypeHandler,只是一些常用的数据类类型它已经给我们实现了而已。

在配置文件中,我们有两个地方可以配置这种处理器。

  第一个地方是sqlMap文件中标签ResultMap或者ParameterMap中的TypeHandler属性,这里配置的handler是局部属性,只会在该ResultMap中才会进行转换。

  1.     <resultMap id="UserOrder" class="UserOrderDO" groupBy="id">
  2.          ......
  3.         <result property="tripType" column="trip_Type"
  4.          typeHandler="com.taobao.et.biz.dal.common.EnumTypeHandlerCallBack"/>
  5.           ......
  6.     </resultMap>

 第二个地方是sqlMapConfig文件中的标签typeHandlers中配置typeHandle子标签,这里配置的标签是全局属性,任何只要匹配该子标签的地方都会自动使用该Handler.

  1. <typeHandlers>
  2. <typeHandler jdbcType="CLOB" javaType="java.lang.String" callback="org.springframework.orm.ibatis.support.ClobStringTypeHandler"/>
  3. </typeHandlers>

例如这里的全局配置,如果此时某个数据库字段的jdbcType是CLOB类型,并且映射的JavaType类型是字符串类型,那么就会自动调用这里的callback来实行类型转换。

 

    那么Ibatis是如何确定使用哪一个TypeHandler的呢?!

    它会在自己的局部区域寻找是否在配置文件中配置了Handler,找到了就使用这个handler,如果没有找到,就会查找是否有全局handler,也就是第二种方式配置的handler,这里要注意,可能我们也没有在全局配置文件中配置handler,此时,Ibatis就会根据实际类型配置默认的handler。

  我们来看一些关键代码,按照查找步骤,这里我去掉了异常,只看关键的部分。

  第一步:从局部Reultmap中取出配置属性。

  1.       String propertyName = childAttributes.getProperty("property");
  2.         String nullValue = childAttributes.getProperty("nullValue");
  3.         String jdbcType = childAttributes.getProperty("jdbcType");
  4.         String javaType = childAttributes.getProperty("javaType");
  5.         String columnName = childAttributes.getProperty("column");
  6.         String columnIndex = childAttributes.getProperty("columnIndex");
  7.         String statementName = childAttributes.getProperty("select");
  8.         String resultMapName = childAttributes.getProperty("resultMap");
  9.         String callback = childAttributes.getProperty("typeHandler");
  10.         callback = vars.typeHandlerFactory.resolveAlias(callback);
  11.         javaType = vars.typeHandlerFactory.resolveAlias(javaType);
  12.         TypeHandler handler = null;
  13.         if (callback != null) { // 注意这里,如果配置了就使用这个配置的handler
  14.             Object impl = Resources.classForName(callback).newInstance();
  15.             if (impl instanceof TypeHandlerCallback) {
  16.               handler = new CustomTypeHandler((TypeHandlerCallback) impl);
  17.             } else if (impl instanceof TypeHandler) {
  18.               handler = (TypeHandler) impl;
  19.             } else {
  20.               throw new NestedRuntimeException ("The class '' is not a valid implementation of TypeHandler or TypeHandlerCallback");
  21.             }
  22.         } else {//如果没有配置,就到这里来找
  23.                   handler = resolveTypeHandler(vars.client.getDelegate().getTypeHandlerFactory(), vars.currentResultMap.getResultClass(), propertyName, javaType, jdbcType, true);
  24.         }

 

第二步,如果局部配置中没有找到,就到下面去找。

 

  1. public TypeHandler resolveTypeHandler(TypeHandlerFactory typeHandlerFactory, Class clazz, String propertyName, String javaType, String jdbcType, boolean useSetterToResolve) {
  2.     TypeHandler handler = null;
  3.     if (clazz == null) {
  4.       // Unknown
  5.       handler = typeHandlerFactory.getUnkownTypeHandler();
  6.     } else if (DomTypeMarker.class.isAssignableFrom(clazz)) {
  7.       // DOM
  8.       handler = typeHandlerFactory.getTypeHandler(String.class, jdbcType);
  9.     } else if (java.util.Map.class.isAssignableFrom(clazz)) {
  10.       // Map
  11.       if (javaType == null) {
  12.         handler = typeHandlerFactory.getUnkownTypeHandler(); //BUG 1012591 - typeHandlerFactory.getTypeHandler(java.lang.Object.class, jdbcType);
  13.       } else {
  14.         try {
  15.           Class javaClass = Resources.classForName(javaType);
  16.           handler = typeHandlerFactory.getTypeHandler(javaClass, jdbcType);
  17.         } catch (Exception e) {
  18.           throw new NestedRuntimeException("Error.  Could not set TypeHandler.  Cause: " + e, e);
  19.         }
  20.       }
  21.     } else if (typeHandlerFactory.getTypeHandler(clazz, jdbcType) != null) {
  22.       // Primitive
  23.       handler = typeHandlerFactory.getTypeHandler(clazz, jdbcType);
  24.     } else {
  25.       // JavaBean
  26.       if (javaType == null) {
  27.         if (useSetterToResolve) {
  28.           Class type = PROBE.getPropertyTypeForSetter(clazz, propertyName);
  29.           handler = typeHandlerFactory.getTypeHandler(type, jdbcType);
  30.         } else {
  31.           Class type = PROBE.getPropertyTypeForGetter(clazz, propertyName);
  32.           handler = typeHandlerFactory.getTypeHandler(type, jdbcType);
  33.         }
  34.       } else {
  35.         try {
  36.           Class javaClass = Resources.classForName(javaType);
  37.           handler = typeHandlerFactory.getTypeHandler(javaClass, jdbcType);
  38.         } catch (Exception e) {
  39.           throw new NestedRuntimeException("Error.  Could not set TypeHandler.  Cause: " + e, e);
  40.         }
  41.       }
  42.     }
  43.     return handler;
  44.   }
  45. 相信大家已经很明白了,其实要找一个Handler,主要就是需要javaType和jdbcType,而这两个参数要么通过反射得到,要么通过配置文件中得到。因此,为了明确我们一般都在配置文件中进行申明。
  46. 最后来看一点 typeHandlerFactory.getTypeHandler(clazz, jdbcType)是怎么实现的。
    1.   public TypeHandler getTypeHandler(Class type, String jdbcType) {
    2.     Map jdbcHandlerMap = (Map) typeHandlerMap.get(type);//首先根据JAVA类型
    3.     TypeHandler handler = null;
    4.     if (jdbcHandlerMap != null) {
    5.       handler = (TypeHandler) jdbcHandlerMap.get(jdbcType);//每个JDBC类型
    6.       if (handler == null) {
    7.         handler = (TypeHandler) jdbcHandlerMap.get(null);
    8.       }
    9.     }
    10.     return handler;
    11.   }
  47. 其实一个Handler=javaType+jdbcType 。

分享到:
评论

相关推荐

    ibatis源码

    Ibatis的核心组件包括SqlMapConfig.xml配置文件、SqlSession管理、Executor执行器、Statement处理和TypeHandler类型处理器等。接下来,我们将详细探讨这些关键部分。 1. **SqlMapConfig.xml配置文件**:这是Ibatis...

    3、mybatis类型的定义方式

    自定义类型处理器需要实现`org.apache.ibatis.type.TypeHandler`接口,并重写`setNonNullParameter`、`getNullableResult`和`getResultFromCursor`方法。 ```java public class CustomTypeHandler implements ...

    ibatis.util包

    7. **TypeHandlerRegistry**: 这是Ibatis的核心组件之一,负责管理所有的类型处理器(TypeHandler)。TypeHandler是Ibatis中处理Java类型和数据库类型之间转换的关键,`TypeHandlerRegistry`可以根据Java类型或JDBC...

    ibatis2.3源码

    7. **TypeHandler**:类型处理器用于处理Java类型的转换,确保Java对象和数据库之间的数据类型匹配。 8. **插件机制**:iBATIS提供了一种插件机制,允许用户自定义拦截器来扩展其功能。 通过深入研究iBATIS 2.3的...

    Ibatis学习笔记,文档,资源6合1

    除此之外,Ibatis还提供了TypeHandler机制,用于处理Java类型与数据库类型的转换,确保数据的正确存取。例如,日期、枚举等复杂类型可以通过自定义TypeHandler进行处理。 总的来说,Ibatis的学习涵盖了数据库操作、...

    iBATIS框架主要的类层次结构.pdf

    对于参数映射,iBATIS根据`Statement`中的SQL语句解析参数,按顺序存储在`Map`中,并根据`ParameterMap`定义的Java数据类型创建`TypeHandler`,负责类型转换。`DataExchange`对象在此过程中扮演角色,将参数值复制到...

    mybatis如何使用Java8的日期LocalDate和LocalDateTime详解

    &lt;typeHandler handler="org.apache.ibatis.type.LocalDateTimeTypeHandler" /&gt; &lt;typeHandler handler="org.apache.ibatis.type.LocalDateTypeHandler" /&gt; ... ... ``` 4. SQL映射文件: 在XML映射文件中...

    boot+mybatis、mybatis中枚举转换器、前后端分离项目统一返回格式、boot集成quraz框架实现定时任务

    为解决此问题,我们可以创建一个自定义的TypeHandler,实现`org.apache.ibatis.type.TypeHandler`接口。这个类型处理器负责将枚举值转化为字符串(存储)和从字符串恢复为枚举(读取)。在MyBatis的配置中注册这个...

    mybatis-resource:mybatis源码阅读

    9. **TypeHandler类型处理器** TypeHandler负责Java类型与数据库类型的转换,如日期、自定义对象等的处理。MyBatis提供了多种内置TypeHandler,同时也支持自定义TypeHandler。 10. **插件机制** MyBatis的插件...

Global site tag (gtag.js) - Google Analytics