TypeHandler源码简单分析

简述

• 我们在使用mybatis时，经常会有这样的操作：传入参数到SQL语句中，SQL执行后，返回结果集并封装转化为某个类型，最常见的就是java类型和数据库类型之间的转换，这种转换由TypeHandler去控制实现。

• TypeHandler中分为jdbcType和javaType，jdbcType用于定义数据库类型，javaType用于定义Java类型

  
  
  

  TypeHandler作用
• 在Mybatis中已经帮我们创建了很多种TypeHandler来帮助我们处理类型之间的转换，如StringTypeHandler可以帮助我们完成String到VARCHAR的转换
• 在大部分情况下不需要显示的去声明javaType和jdbcType，或者用typeHandler去指定对应的TypeHander来实现数据类型转换，Mybatis会帮助我们去自动实现

源码分析

【TypeHandler接口】

• 在Mybatis中，不管你是自定义typeHandler还是Mybatis自带，都需要去实现org.apache.ibatis.type.TypeHandler接口，源码如下

/**
 * @author Clinton Begin
 */
public interface TypeHandler {

  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;

}

1. 在源码中，T表示泛型，比如我们需要String的时候，implements TypeHandler即可
2. setParameter方法顾名思义是用来设置参数，通过PreparedStatement对象进行设置，i是参数在SQL的下标，parameter是入参，jdbcType是对应的数据库类型
3. 有三个getResult方法，他们的作用是从JDBC结果集中获取数据进行转换，columnName是使用列名获取，columnIndex是使用下标获取，CallableStatement针对存储过程

【BaseTypeHandler】

• Mybatis内置的各种TypeHandler都继承了org.apache.ibatis.type.BaseTypeHandler类，源码如下

public abstract class BaseTypeHandler extends TypeReference implements TypeHandler {

  protected Configuration configuration;

  public void setConfiguration(Configuration c) {
    this.configuration = c;
  }

  @Override
  public void setParameter(PreparedStatement ps, int i, T parameter, JdbcType jdbcType) throws SQLException {
    if (parameter == null) {
      if (jdbcType == null) {
        throw new TypeException("JDBC requires that the JdbcType must be specified for all nullable parameters.");
      }
      try {
        ps.setNull(i, jdbcType.TYPE_CODE);
      } catch (SQLException e) {
        throw new TypeException("Error setting null for parameter #" + i + " with JdbcType " + jdbcType + " . " +
                "Try setting a different JdbcType for this parameter or a different jdbcTypeForNull configuration property. " +
                "Cause: " + e, e);
      }
    } else {
      try {
        setNonNullParameter(ps, i, parameter, jdbcType);
      } catch (Exception e) {
        throw new TypeException("Error setting non null for parameter #" + i + " with JdbcType " + jdbcType + " . " +
                "Try setting a different JdbcType for this parameter or a different configuration property. " +
                "Cause: " + e, e);
      }
    }
  }

  @Override
  public T getResult(ResultSet rs, String columnName) throws SQLException {
    T result;
    try {
      result = getNullableResult(rs, columnName);
    } catch (Exception e) {
      throw new ResultMapException("Error attempting to get column '" + columnName + "' from result set.  Cause: " + e, e);
    }
    if (rs.wasNull()) {
      return null;
    } else {
      return result;
    }
  }

  @Override
  public T getResult(ResultSet rs, int columnIndex) throws SQLException {
    T result;
    try {
      result = getNullableResult(rs, columnIndex);
    } catch (Exception e) {
      throw new ResultMapException("Error attempting to get column #" + columnIndex+ " from result set.  Cause: " + e, e);
    }
    if (rs.wasNull()) {
      return null;
    } else {
      return result;
    }
  }

  @Override
  public T getResult(CallableStatement cs, int columnIndex) throws SQLException {
    T result;
    try {
      result = getNullableResult(cs, columnIndex);
    } catch (Exception e) {
      throw new ResultMapException("Error attempting to get column #" + columnIndex+ " from callable statement.  Cause: " + e, e);
    }
    if (cs.wasNull()) {
      return null;
    } else {
      return result;
    }
  }

  public abstract void setNonNullParameter(PreparedStatement ps, int i, T parameter, JdbcType jdbcType) throws SQLException;

  public abstract T getNullableResult(ResultSet rs, String columnName) throws SQLException;

  public abstract T getNullableResult(ResultSet rs, int columnIndex) throws SQLException;

  public abstract T getNullableResult(CallableStatement cs, int columnIndex) throws SQLException;

}

1. BaseTypeHandler是一个抽象类，它实现了TypeHandler的所有接口，需要子类去实现它自定义的4个抽象方法
2. setParameter方法中，当parameter和jdbcType都为空时将抛出异常，如果能明确jdbcType，将会进行空设置（PreparedStatement的setNull方法）；如果paramter不为空，将使用setNonNullParameter去设置参数（该方法需要子类去实现）
3. getResult方法，非空结果集是通过getNullableResult方法去获取的，该方法需要子类去实现，同样是针对下标、列名以及存储过程三种的实现

【StringTypeHandler】

• 以具体实现类StringTypeHandler为例，源码如下

/**
 * @author Clinton Begin
 */
public class StringTypeHandler extends BaseTypeHandler {

  @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的setString实现

【TypeHandlerRegistry】

• 当具体的TypeHandler定义完成后，如何进行注册呢？Mybatis提供了一个org.apache.ibatis.type.TypeHandlerRegistry类来实现，具体源码可查看TypeHandlerRegistry源码简单分析