当前位置: 首页 > news >正文

【Mytais系列】Type模块:源码

MyBatis 的 Type 模块(类型系统)是框架实现 Java 类型与数据库类型映射的核心模块,其源码设计精巧且高度可扩展。以下从核心接口注册机制类型解析流程等角度,深入解析其源码实现。


一、核心接口与类结构

1. TypeHandler<T> 接口

作用:定义 Java 类型与 JDBC 类型之间的转换逻辑。
源码位置org.apache.ibatis.type.TypeHandler
关键方法

public interface TypeHandler<T> {// 将 Java 类型参数设置到 PreparedStatement 中void setParameter(PreparedStatement ps, int i, T parameter, JdbcType jdbcType) throws SQLException;// 从 ResultSet 中获取值并转换为 Java 类型(根据列名或列索引)T getResult(ResultSet rs, String columnName) throws SQLException;T getResult(ResultSet rs, int columnIndex) throws SQLException;T getResult(CallableStatement cs, int columnIndex) throws SQLException;
}

实现类示例(内置处理器):

  • StringTypeHandler: 处理 StringVARCHAR
  • DateTypeHandler: 处理 DateTIMESTAMP
  • EnumTypeHandler: 处理枚举类型(按名称存储)
2. TypeHandlerRegistry

作用:全局注册所有 TypeHandler,维护类型映射关系。
源码位置org.apache.ibatis.type.TypeHandlerRegistry
核心数据结构

public final class TypeHandlerRegistry {// 存储 Java 类型 + JDBC 类型 → TypeHandler 的映射private final Map<JdbcType, TypeHandler<?>> jdbcTypeHandlerMap = new EnumMap<>(JdbcType.class);private final Map<Type, Map<JdbcType, TypeHandler<?>>> typeHandlerMap = new ConcurrentHashMap<>();// 默认 TypeHandler 注册(如 StringTypeHandler)public TypeHandlerRegistry() {register(String.class, new StringTypeHandler());register(Integer.class, new IntegerTypeHandler());// ... 其他内置处理器}
}

注册逻辑

public <T> void register(Class<T> javaType, TypeHandler<? extends T> typeHandler) {// 解析 @MappedJdbcTypes 和 @MappedTypes 注解MappedJdbcTypes mappedJdbcTypes = typeHandler.getClass().getAnnotation(MappedJdbcTypes.class);if (mappedJdbcTypes != null) {for (JdbcType jdbcType : mappedJdbcTypes.value()) {register(javaType, jdbcType, typeHandler);}}// 若未指定 JDBC 类型,注册为通用处理器register(javaType, null, typeHandler);
}
3. TypeAliasRegistry

作用:管理类型别名,简化 XML 配置中的类名书写。
源码位置org.apache.ibatis.type.TypeAliasRegistry
核心数据结构

public class TypeAliasRegistry {private final Map<String, Class<?>> typeAliases = new ConcurrentHashMap<>();// 内置别名注册(如 "string" → String.class)public TypeAliasRegistry() {registerAlias("string", String.class);registerAlias("int", Integer.class);// ... 其他内置别名}
}

别名解析流程

public <T> Class<T> resolveAlias(String alias) {if (alias == null) return null;String key = alias.toLowerCase(Locale.ENGLISH); // 别名不区分大小写Class<T> value;if (typeAliases.containsKey(key)) {value = (Class<T>) typeAliases.get(key);} else {// 尝试通过类加载器加载别名对应的类value = (Class<T>) Resources.classForName(alias);}return value;
}

二、类型处理流程

1. 参数设置(Java → JDBC)

当执行 SQL 时,MyBatis 通过 TypeHandler 将 Java 参数转换为 JDBC 类型。
核心入口org.apache.ibatis.scripting.defaults.DefaultParameterHandler
关键代码

public void setParameters(PreparedStatement ps) {for (int i = 0; i < parameterMappings.size(); i++) {Object parameterValue = ...; // 获取参数值TypeHandler typeHandler = parameterMapping.getTypeHandler();JdbcType jdbcType = parameterMapping.getJdbcType();typeHandler.setParameter(ps, i + 1, parameterValue, jdbcType); // 调用 TypeHandler}
}
2. 结果映射(JDBC → Java)

ResultSet 中读取数据时,MyBatis 通过 TypeHandler 将 JDBC 类型转换为 Java 类型。
核心入口org.apache.ibatis.executor.resultset.DefaultResultSetHandler
关键代码

private Object getPropertyMappingValue(ResultSet rs, ResultMapping resultMapping) {TypeHandler<?> typeHandler = resultMapping.getTypeHandler();String column = resultMapping.getColumn();return typeHandler.getResult(rs, column); // 调用 TypeHandler
}

三、类型解析与自动发现

1. 类型解析优先级

MyBatis 按以下顺序解析 TypeHandler

  1. 显式指定:在 XML 或注解中直接指定 typeHandler
  2. JDBC 类型匹配:根据 @MappedJdbcTypes 查找处理器。
  3. Java 类型匹配:根据参数/属性的 Java 类型查找默认处理器。

源码逻辑TypeHandlerRegistry.getTypeHandler):

public <T> TypeHandler<T> getTypeHandler(Type type, JdbcType jdbcType) {Map<JdbcType, TypeHandler<?>> jdbcHandlerMap = typeHandlerMap.get(type);if (jdbcHandlerMap != null) {TypeHandler<?> handler = jdbcHandlerMap.get(jdbcType);if (handler == null) {handler = jdbcHandlerMap.get(null); // 使用通用处理器}return (TypeHandler<T>) handler;}return null;
}
2. 自动注册机制

MyBatis 在启动时自动扫描并注册 TypeHandler

  • XML 配置:通过 <typeHandlers> 标签注册。
  • 包扫描:通过 <package name="..."/> 扫描包下的所有 TypeHandler
  • 注解驱动:通过 @MappedTypes@MappedJdbcTypes 注解声明作用范围。

源码入口org.apache.ibatis.builder.xml.XMLConfigBuilder.typeHandlerElement
关键代码

private void typeHandlerElement(XNode parent) {for (XNode child : parent.getChildren()) {if ("package".equals(child.getName())) {String packageName = child.getStringAttribute("name");typeHandlerRegistry.register(packageName); // 扫描包下的 TypeHandler} else {String javaTypeName = child.getStringAttribute("javaType");String jdbcTypeName = child.getStringAttribute("jdbcType");Class<?> handlerClass = resolveClass(child.getStringAttribute("handler"));register(javaTypeName, jdbcTypeName, handlerClass); // 注册单个 TypeHandler}}
}

四、自定义类型处理器的实现

1. 实现 TypeHandler 接口

示例:处理 List<String> 类型,存储为逗号分隔的字符串。

public class StringListTypeHandler implements TypeHandler<List<String>> {@Overridepublic void setParameter(PreparedStatement ps, int i, List<String> parameter, JdbcType jdbcType) throws SQLException {String value = String.join(",", parameter);ps.setString(i, value);}@Overridepublic List<String> getResult(ResultSet rs, String columnName) throws SQLException {String value = rs.getString(columnName);return Arrays.asList(value.split(","));}// 其他方法实现类似...
}
2. 注册自定义处理器

方式一:XML 配置

<typeHandlers><typeHandler handler="com.example.StringListTypeHandler" javaType="java.util.List" jdbcType="VARCHAR"/>
</typeHandlers>

方式二:注解驱动

@MappedTypes(List.class)
@MappedJdbcTypes(JdbcType.VARCHAR)
public class StringListTypeHandler implements TypeHandler<List<String>> { ... }

五、源码设计亮点

1. 双重注册机制
  • 精确匹配:根据 Java类型 + JDBC类型 查找处理器。
  • 通用匹配:若未指定 JDBC 类型,使用 Java类型 → 默认处理器
2. 类型推导与泛型处理
  • 泛型支持:通过 TypeReference<T> 解析泛型参数类型。
  • 复杂类型处理:支持 MapList 等集合类型的嵌套映射。
3. 线程安全设计
  • 无状态处理器TypeHandler 实现类通常设计为无状态(如 StringTypeHandler),可安全复用。
  • 并发容器TypeHandlerRegistry 使用 ConcurrentHashMap 管理映射关系。

六、类图与交互流程

1. 核心类图

2. 类型处理时序图


七、总结

MyBatis 的 Type 模块通过 TypeHandler 接口TypeHandlerRegistry 注册中心TypeAliasRegistry 别名管理,实现了灵活的类型映射机制。其源码设计注重扩展性(支持自定义处理器)、性能(高效的类型查找)和线程安全(并发容器与无状态对象),是 MyBatis 框架中处理数据类型的核心基础设施。理解其源码实现,有助于开发者更好地定制类型转换逻辑,解决复杂场景下的 ORM 问题。

相关文章:

  • centos7.0无法安装php8.2/8.3
  • 【大模型面试每日一题】Day 7:为什么大模型训练选择 Adam 而非 SGD?Adam 的关键改进是什么?
  • 使用PageHelper实现分页查询(详细)
  • LangChain:重构大语言模型应用开发的范式革命
  • 游戏引擎学习第255天:构建配置树
  • 定时器6计时功能
  • 【算法基础】插入排序算法 - JAVA
  • 【计算机视觉】目标检测:yoloV1~yoloV11项目论文及对比
  • SQL中的Subquery CTE Temporary Table 区别
  • Milvus(12):分析器
  • firewall docker 冲突问题解决(亲测有效)
  • C++ STL vector高级特性与实战技巧
  • STM32 DMA直接存储器存取
  • 利用Elixir中的原子特性 + 错误消息泄露 -- Atom Bomb
  • 手写 Vue 源码 === 搭建 Monorepo 环境
  • Webug4.0靶场通关笔记10- 第14关链接注入
  • 【Hot 100】 146. LRU 缓存
  • (笔记)List
  • 接口隔离原则(ISP)
  • 动态规划之多状态问题1
  • 谢晖不再担任中超长春亚泰队主教练:战绩不佳主动请辞
  • 青年与城市共成长,第六届上海创新创业青年50人论坛将举办
  • 机关食堂向游客开放的重庆荣昌区,“消费市场迎来历史性突破”
  • “模”范生上海,如何再进阶?
  • 央视热评:从银幕到生活,好故事如何“撬动”大市场
  • 特朗普关税风暴中的“稳”与“变”:新加坡国会选举观察