MyBatis--系统定义的TypeHandler、BaseTypeHandler和StringTypeHandler源码分析

小灰灰 2021-08-14 01:06 453阅读 0赞

#### 系统定义的TypeHandler ####

MyBatis 内部定义了许多有用的 typeHandler，如下表所示。

<table> 
 <thead> 
  <tr> 
   <th align="left">类型处理器</th> 
   <th align="left">Java类型</th> 
   <th align="left">JDBC类型</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left">BooleanTypeHandler</td> 
   <td align="left">java.lang.Boolean，boolean</td> 
   <td align="left">数据库兼容的 BOOLEAN</td> 
  </tr> 
  <tr> 
   <td align="left">ByteTypeHandler</td> 
   <td align="left">java.lang.Byte，byte</td> 
   <td align="left">数据库兼容的 NUMERIC 或 BYTE</td> 
  </tr> 
  <tr> 
   <td align="left">ShortTypeHandler</td> 
   <td align="left">java.lang.Short，short</td> 
   <td align="left">数据库兼容的 NUMERIC 或 SHORT INTEGER</td> 
  </tr> 
  <tr> 
   <td align="left">IntegerTypeHandler</td> 
   <td align="left">java.lang.Integer，int</td> 
   <td align="left">数据库兼容的 NUMERIC 或 INTEGER</td> 
  </tr> 
  <tr> 
   <td align="left">LongTypeHandler</td> 
   <td align="left">java.lang.Long，long</td> 
   <td align="left">数据库兼容的 NUMERIC 或 LONG INTEGER</td> 
  </tr> 
  <tr> 
   <td align="left">FloatTypeHandler</td> 
   <td align="left">java.lang.Float，float</td> 
   <td align="left">数据库兼容的 NUMERIC 或 FLOAT</td> 
  </tr> 
  <tr> 
   <td align="left">DoubleTypeHandler</td> 
   <td align="left">java.lang.Double，double</td> 
   <td align="left">数据库兼容的 NUMERIC 或 DOUBLE</td> 
  </tr> 
  <tr> 
   <td align="left">BigDecimalTypeHandler</td> 
   <td align="left">java.math.BigDecimal</td> 
   <td align="left">数据库兼容的 NUMERIC 或 DECIMAL</td> 
  </tr> 
  <tr> 
   <td align="left">StringTypeHandler</td> 
   <td align="left">java.lang.String</td> 
   <td align="left">CHAR、VARCHAR</td> 
  </tr> 
  <tr> 
   <td align="left">ClobReaderTypeHandler</td> 
   <td align="left">java.io.Reader</td> 
   <td align="left">——</td> 
  </tr> 
  <tr> 
   <td align="left">ClobTypeHandler</td> 
   <td align="left">java.lang.String</td> 
   <td align="left">CLOB、LONGVARCHAR</td> 
  </tr> 
  <tr> 
   <td align="left">NStringTypeHandler</td> 
   <td align="left">java.lang.String</td> 
   <td align="left">NVARCHAR、NCHAR</td> 
  </tr> 
  <tr> 
   <td align="left">NClobTypcHandler</td> 
   <td align="left">java.lang.String</td> 
   <td align="left">NCLOB</td> 
  </tr> 
  <tr> 
   <td align="left">BlobInputStreamTypeHandler</td> 
   <td align="left">java.io.InputStream</td> 
   <td align="left">——</td> 
  </tr> 
  <tr> 
   <td align="left">ByteArrayTypeHandler</td> 
   <td align="left">byte[]</td> 
   <td align="left">数据库兼容的字节流类型</td> 
  </tr> 
  <tr> 
   <td align="left">BlobTypeHandler</td> 
   <td align="left">byte[]</td> 
   <td align="left">BLOB、LONGVARBINARY</td> 
  </tr> 
  <tr> 
   <td align="left">DateTypeHandler</td> 
   <td align="left">java.util.Date</td> 
   <td align="left">TIMESTAMP</td> 
  </tr> 
  <tr> 
   <td align="left">DateOnlyTypeHandler</td> 
   <td align="left">java.util.Date</td> 
   <td align="left">DATE</td> 
  </tr> 
  <tr> 
   <td align="left">TimeOnlyTypeHandler</td> 
   <td align="left">java.util.Date</td> 
   <td align="left">TIME</td> 
  </tr> 
  <tr> 
   <td align="left">SqlTimestampTypeHandler</td> 
   <td align="left">java.sql.Timestamp</td> 
   <td align="left">TIMESTAMP</td> 
  </tr> 
  <tr> 
   <td align="left">SqlDateTypeHandler</td> 
   <td align="left">java.sql.Date</td> 
   <td align="left">DATE</td> 
  </tr> 
  <tr> 
   <td align="left">SqlTimeTypeHandler</td> 
   <td align="left">java.sql.Time</td> 
   <td align="left">TIME</td> 
  </tr> 
  <tr> 
   <td align="left">ObjectTypeHandler</td> 
   <td align="left">Any</td> 
   <td align="left">OTHER或未指定类型</td> 
  </tr> 
  <tr> 
   <td align="left">EnumTypeHandler</td> 
   <td align="left">Enumeration Type</td> 
   <td align="left">VARCHAR 任何兼容的字符串类型，存储枚举的名称（而不是索引）</td> 
  </tr> 
  <tr> 
   <td align="left">EnumOrdinalTypeHandler</td> 
   <td align="left">Enumeration Type</td> 
   <td align="left">任何兼容的 NUMERIC 或 DOUBLE 类型，存储枚举的索引（而不是名称）</td> 
  </tr> 
 </tbody> 
</table>

这些就是 MyBatis 系统已经创建好的 typeHandler。在大部分的情况下无须显式地声明 jdbcType 和 javaType，或者用 typeHandler 去指定对应的 typeHandler 来实现数据类型转换，因为 MyBatis 系统会自己探测。有时候需要修改一些转换规则，比如枚举类往往需要自己去编写规则。

在 MyBatis 中 typeHandler 都要实现接口 org.apache.ibatis.type.TypeHandler，接口的定义，如下所示:

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;
    }

其中 T 是泛型，专指 javaType，比如我们需要 String 的时候，那么实现类可以写为 implements TypeHandler<String>。

setParameter 方法，是使用 typeHandler 通过 PreparedStatement 对象进行设置 SQL 参数的时候使用的具体方法，其中 i 是参数在 SQL 的下标，parameter 是参数，jdbcType 是数据库类型。

其中有 3 个 getResult 的方法，它的作用是从 JDBC 结果集中获取数据进行转换，要么使用列名（columnName）要么使用下标（columnIndex）获取数据库的数据，其中最后一个 getResult 方法是存储过程专用的。

#### TypeHandler源码 ####

在编写 typeHandler 前，先来研究一下 MyBatis 系统的 typeHandler 是如何实现的，所以有必要先研究一下 MyBatis 系统的 typeHandler。如果读者打开源码，就可以发现它们都继承了 org.apache.ibatis.type.BaseTypeHandler，如下所示。

public abstract class BaseTypeHandler<T> extends TypeReference<T> implements TypeHandler<T> { 
    
        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;
    
    }

*  BaseTypeHandler 是个抽象类，需要子类去实现其定义的 4 个抽象方法，而它本身实现了 typeHandler 接口的 4 个方法。
 *  getResult 方法，非空结果集是通过 getNullableResult 方法获取的。如果判断为空，则返回 null。
 *  setParameter 方法，当参数 parameter 和 jdbcType 同时为空时，MyBatis 将抛出异常。如果能明确 jdbcType，则会进行空设置；如果参数不为空，那么它将采用 setNonNullParameter 方法设置参数。
 *  getNullableResult 方法用于存储过程。

**StringTypeHandler源码:**

@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);
    }

**代码注册TypeHandler：**  
在 MyBatis 中采用 org.apache.ibatis.type.TypeHandlerRegistry 类对象的 register 方法进行注册，如下所示。

public TypeHandlerRegistry()  { 
        register(Boolean.class, new BooleanTypeHandler());
        register(boolean.class, new BooleanTypeHandler());
        ....
        register(byte[].class, jdbcType.BLOB, new BlobTypeHandler());
        register(byte[].class, jdbcType.LONGVARBINARY, new BlobTypeHandler());
        ....
    }