mybatis源碼分析之TypeHandler

分析了MapperMethod從創建到執行的過程,MapperMethod的執行包括執行sql返回結果.

在執行sql和返回結果的過程中就會涉及到參數類型的轉換,這個過程是通過TypeHandler來處理的.關於TypeHandler官網有比較詳細的文檔http://www.mybatis.org/mybatis-3/zh/configuration.html#typeHandlers,文檔主要說明瞭如何使用TypeHandler,在下面的分析中將重點分析與TypeHandler有關的源碼.

1.配置

MyBatis有預設的類型處理器,如果需要自訂配置也相當簡單,在mybatis-config.xml裡添加如下配置:

<typeHandlers>
  <typeHandler handler="org.mybatis.example.ExampleTypeHandler"/>
</typeHandlers>

下面分析配置讀取設定的過程,在XMLConfigBuilder中

   /**
     * 读取配置文件组装configuration
     * @param root 配置文件的configuration节点
     */
  private void parseConfiguration(XNode root) {    try {      //issue #117 read properties first
      propertiesElement(root.evalNode("properties"));
      Properties settings = settingsAsProperties(root.evalNode("settings"));
      loadCustomVfs(settings);
      typeAliasesElement(root.evalNode("typeAliases"));
      pluginElement(root.evalNode("plugins"));
      objectFactoryElement(root.evalNode("objectFactory"));
      objectWrapperFactoryElement(root.evalNode("objectWrapperFactory"));
      reflectorFactoryElement(root.evalNode("reflectorFactory"));
      settingsElement(settings);      // read it after objectFactory and objectWrapperFactory issue #631
      environmentsElement(root.evalNode("environments"));
      databaseIdProviderElement(root.evalNode("databaseIdProvider"));
      typeHandlerElement(root.evalNode("typeHandlers"));
      mapperElement(root.evalNode("mappers"));
    } catch (Exception e) {      throw new BuilderException("Error parsing SQL Mapper Configuration. Cause: " + e, e);
    }
  }

在以上原始碼中有一行

typeHandlerElement(root.evalNode("typeHandlers"));

再來看typeHandlerElement這個方法

/**
   * 读取typeHandlers配置并注册
   * @param parent 配置文件typeHandlers节点
   * @throws Exception
   */
  private void typeHandlerElement(XNode parent) throws Exception {    if (parent != null) {      for (XNode child : parent.getChildren()) {        if ("package".equals(child.getName())) {
          String typeHandlerPackage = child.getStringAttribute("name");          typeHandlerRegistry.register(typeHandlerPackage);
        } else {
          String javaTypeName = child.getStringAttribute("javaType");
          String jdbcTypeName = child.getStringAttribute("jdbcType");
          String handlerTypeName = child.getStringAttribute("handler");
          Class<?> javaTypeClass = resolveClass(javaTypeName);
          JdbcType jdbcType = resolveJdbcType(jdbcTypeName);
          Class<?> typeHandlerClass = resolveClass(handlerTypeName);          if (javaTypeClass != null) {            if (jdbcType == null) {              typeHandlerRegistry.register(javaTypeClass, typeHandlerClass);
            } else {              typeHandlerRegistry.register(javaTypeClass, jdbcType, typeHandlerClass);
            }
          } else {            typeHandlerRegistry.register(typeHandlerClass);
          }
        }
      }
    }
  }

if和else中的程式碼邏輯對應了typeHandler的兩種設定方式.最後都會呼叫 

TypeHandlerRegistry,Configuration,BaseTypeHandler之間的關係.

2.設定參數

設定參數時先呼叫ParameterHandler.setParameters(),然後在setParameters()裡取得對應的typeHandler,最後呼叫typeHandler.setParameter()

再來看看BaseTypeHandler的setParameter方法

當parameter不為null時調用的是setNonNullParameter,也就是說子類需要實現setNonNullParameter

BigIntegerTypeHandler的源碼c.