手写 MyBatis 全貌地图：从源码架构拆解到渐进式实现的完整学习指南

手写 MyBatis 全貌地图从源码架构拆解到渐进式实现的完整学习指南【免费下载链接】CodeGuide:books: 本代码库是作者小傅哥多年从事一线互联网 Java 开发的学习历程技术汇总旨在为大家提供一个清晰详细的学习教程侧重点更倾向编写Java核心内容。如果本仓库能为您提供帮助请给予支持(关注、点赞、分享)项目地址: https://gitcode.com/gh_mirrors/code/CodeGuide本文以 CodeGuide 仓库中《手写 Mybatis》系列文档为骨架梳理 MyBatis 框架的核心执行脉络与工程架构设计。文章核心回答三个问题为什么学习源码要看全貌地图而非逐行硬啃一个能串联全部核心流程的 ORM 框架由哪些功能模块组成这些模块在源码中如何运用设计原则与设计模式落地读完后你将获得一份可对照手写代码与官方源码的完整地图并掌握从解析、绑定、反射、缓存到事务、整合 Spring 的渐进式实现路径。一、为什么手写一个 MyBatis不少开发者有过这样的疑问有人跟我说手写 Spring 难手写 Mybatis 易但真正动手拆解之后事情并没有那么简单。在 CodeGuide 仓库中作者小傅哥在手写完 Spring 后开始对 MyBatis 下手。最初以为 Spring 那么大都写下来了MyBatis 能有多难但随着梳理、拆解、细化 MyBatis 框架源码的架构模型后发现如果说只是为了体现一个 ORM 框架的核心结构和功能七八个类就能实现但假如要串联出重要核心脉络流程的完整 ORM 框架至少需要在 100 个类以上才能把 MyBatis 这些功能全部串联出来。那为什么几个类就能搞定的事却要手写一堆代码来实现这里有一个非常重要的认知学习源码的目的不是为了面试、为了熟悉流程、为了跟风。学习源码更重要的是学习这些源码在面对复杂系统问题时如何设计工程架构运用了什么设计原则和哪些设计模式而这些思想在代码中又是如何落地的。这才是学习源码应该重视的内容也是能真正帮助研发人员提高编码思维高度的东西。所以整个《手写 Mybatis》专栏采用了渐进式的开发方式逐步拆解 MyBatis 核心功能模块层层展开 MyBatis 的设计和实现。好奇驱动学习手写 MyBatis 的起点往往来自一个朴素的好奇为什么在使用 Mybatis 的时候只需定义一个接口不用写实现类就能使用 XML 中或者注解上配置好的 SQL 语句就能完成对数据库 CRUD 的操作呢答案的核心是接口代理把每一个数据库操作的 DAO 接口都用操作数据库的代理类实现并注册到 Spring 容器让用户去使用。MyBatis 屏蔽了 JDBC 中手动建链、编码 SQL、执行操作、封装返回结果等繁琐细节开发者只需要简单配置即可对定义的 DAO 接口进行数据库操作。二、源码全貌地图打开战争迷雾在手写完 MyBatis 框架以后作者梳理了一张全貌地图用于预览整个 MyBatis 框架的执行脉络体系。有了这张打开了战争迷雾地图的指引再学习 MyBatis 的技术就变得非常清晰了。这张全貌地图的价值在于它是整个《手写 Mybatis》的全貌地图规划了逐步实现的功能模块分章节细化各个模块的实现流程最终实现出一个丰富、全面、细致的 ORM 框架学习过程中可以参考这张图来对照手写的代码以及 Mybatis 的源码更有利于对框架的理解通常如果你不是支离破碎的拼凑式学习而是成体系地建设自己的知识栈那么学习后也一定能梳理出一套属于自己的技术地图。仓库中 mybatis-source-code-analysis-diagram.md 进一步展示了这套源码解析图的创作过程——每一张图对应一次源码讲解视频课覆盖代理和工厂、会话数据源、动态上下文、一二级缓存等核心主题。三、小册目录4 大部分、22 章渐进式实现《手写 Mybatis》小册的目录规划决定了整个框架的实现顺序。仓库中 docs/md/spring/develop-mybatis 目录完整收录了这 22 章的内容章节核心主题说明第1章开篇介绍手写 Mybatis 能给你带来什么、学习路线第2章创建简单的映射器代理工厂用 JDK 动态代理包装 DAO 接口第3章实现映射器的注册和使用MapperRegistry 注册机第4章XML 的解析和注册使用解析 mybatis-config、mapper XML第5章数据源的解析、创建和使用DataSource 工厂体系第6章数据源池化技术实现PooledDataSource 连接池第7章SQL 执行器的定义和实现Executor 执行器体系第8章把反射用到出神入化MetaObject 元对象反射工具包第9章细化 XML 语句构建器完善静态 SQL 解析第10章使用策略模式调用参数处理器TypeHandler 类型处理器第11章流程解耦封装结果集处理器ResultSetHandler第12章完善 ORM 框架增删改查操作完整 CRUD第13章通过注解配置执行 SQL 语句Select/Insert 等注解第14章解析和使用 ResultMap 映射参数配置结果映射第15章返回 Insert 操作自增索引值自增主键第16章解析含标签的动态 SQL 语句trim/if 等 9 种标签第17章Plugin 插件功能实现拦截器链第18章一级缓存会话内缓存第19章二级缓存跨会话缓存第20章整合 Spring与 Spring 容器集成第21章完结全流程回顾第22章Mybatis 设计模式源码中 10 种设计模式分析覆盖的功能模块包括解析、绑定、反射、缓存、事务以及注解、数据源、MetaObject 等。在 22 章课程中会逐步带着读者手写出一套串联所有核心流程的 MyBatis 框架阅读学习后会对 ORM 源码有透彻清晰的了解。源码渐进式迭代开发这套源码最核心的学习方式是渐进式迭代每一个章节的代码都会在上一章节的基础上进行扩展和迭代。这样可以非常清晰地知晓每一个章节都在添加什么功能、改动了哪些代码、新增了什么模块。这样的方式让即使是小白读者也可以逐步学习掌握。例如从第2章开始工程结构还只有简单的MapperProxy和MapperProxyFactory两个类到第8章时cn.bugstack.mybatis包下已经扩展出 binding、builder、datasource、executor、io、mapping、reflection、session、transaction、type 等十余个包框架逐渐丰满。四、核心功能模块源码级拆解这一节结合仓库各章节文档拆解 MyBatis 手写实现中最关键的功能模块与底层原理。1. 映射器代理ORM 框架的第一个关联点章节第2章创建简单的映射器代理工厂设计一个 ORM 框架首先要考虑怎么把用户定义的数据库操作接口、XML 配置的 SQL 语句、数据库三者联系起来。最适合的操作就是代理——代理可以封装一个复杂的流程为接口对象的实现类。核心是两个类MapperProxy实现InvocationHandler接口所有对 DAO 接口的实际调用都会进入invoke方法包装的逻辑。注意Object.class.equals(method.getDeclaringClass())的判断——Object 提供的 toString、hashCode 等方法不需要代理执行。MapperProxyFactory对MapperProxy的包装对外提供实例化代理对象的操作用到的就是简单工厂模式public class MapperProxyFactoryT { private final ClassT mapperInterface; public T newInstance(MapString, String sqlSession) { final MapperProxyT mapperProxy new MapperProxy(sqlSession, mapperInterface); return (T) Proxy.newProxyInstance(mapperInterface.getClassLoader(), new Class[]{mapperInterface}, mapperProxy); } }工厂操作把代理的创建封装起来避免每个创建代理类的地方都自己使用Proxy.newProxyInstance。在测试中DAO 方法queryUserName的调用会被代理接管返回你的被代理了模拟执行 Mapper.xml 中 SQL 语句的操作证明接口已经被代理类实现后续的数据库操作逻辑都可以在这一层扩展。2. 元对象反射工具包把反射用到出神入化章节第8章把反射用到出神入化在实现数据源池化时对属性的获取如果采用硬编码方式props.getProperty(driver)、props.getProperty(url)一旦出现扩展字段就难以维护。MyBatis 源码的解法是自研一套元对象反射工具类完成对象属性的反射填充。这套工具包由以下组件构成Reflector 反射器解耦对象信息从 Class 中拆解出 getter、setter、字段、构造函数并缓存使用ConcurrentHashMap保证线程安全最终将 get/set 方法包装为可调用的Invoker。Invoker 调用者统一反射调用策略包括MethodInvoker方法调用、GetFieldInvokergetter有返回值、SetFieldInvokersetter返回 null。MetaClass 元类包装 Reflector提供getGetInvoker(name)、getSetInvoker(name)等便捷方法。ObjectWrapper 对象包装器为不同对象类型提供不同包装策略包括BeanWrapper、MapWrapper、CollectionWrapper。MetaObject 元对象整合对象工厂、对象包装工厂对外提供getValue(String name)、setValue(String name, Object value)操作支持班级[0].学生.成绩这样多层级属性路径的递归拆解。改造后的UnpooledDataSourceFactory#setProperties不再硬编码而是通过反射设置属性public void setProperties(Properties props) { MetaObject metaObject SystemMetaObject.forObject(dataSource); for (Object key : props.keySet()) { String propertyName (String) key; if (metaObject.hasSetter(propertyName)) { String value (String) props.get(propertyName); Object convertedValue convertValue(metaObject, propertyName, value); metaObject.setValue(propertyName, convertedValue); } } }测试验证对Teacher对象执行metaObject.setValue(students[0].id, 001)后对象序列化结果为{name:小白,price:0.0,students:[{id:001}]}单个属性和对象/集合属性均可正常操作。这套工具类与业务逻辑无强关联可以独立抽出复用。3. 数据源解析、创建、池化章节第5章数据源的解析、创建和使用、第6章数据源池化技术实现MyBatis 的数据源通过environments配置解析创建environments defaultdevelopment environment iddevelopment transactionManager typeJDBC/ dataSource typePOOLED property namedriver valuecom.mysql.jdbc.Driver/ property nameurl valuejdbc:mysql://127.0.0.1:3306/mybatis?useUnicodetrue/ property nameusername valueroot/ property namepassword value123456/ /dataSource /environment /environments数据源体系包含DataSourceFactory工厂接口以及UnpooledDataSource非池化、PooledDataSource池化、DruidDataSourceFactory第三方适配等实现。typePOOLED与typeUNPOOLED均可通过反射工具类统一设置属性切换数据源类型无需改动业务代码。4. 动态 SQL组合模式解析标签章节第16章解析含标签的动态 SQL 语句在实际使用场景中往往需要根据入参对象中的字段是否有值判断后才被设置到 SQL 语句上。在 MyBatis XML 动态 SQL 配置中共提供了 9 种标签trim/where/set/foreach/if/choose/when/otherwise/bind让使用者可以组合出各类场景的 SQL 语句。SqlNode接口的实现就是每一个组合结构中的规则节点通过规则节点的组装完成一棵规则树——这正是组合模式。例如IfSqlNodepublic class IfSqlNode implements SqlNode { private ExpressionEvaluator evaluator; private String test; private SqlNode contents; Override public boolean apply(DynamicContext context) { // 如果满足条件则apply并返回true if (evaluator.evaluateBoolean(test, context.getBindings())) { contents.apply(context); return true; } return false; } }对应的 XML 配置示例select idqueryActivityById parameterTypecn.bugstack.mybatis.test.po.Activity resultMapactivityMap flushCachefalse useCachetrue SELECT activity_id, activity_name, activity_desc, create_time, update_time FROM activity trim prefixwhere prefixOverridesAND | OR suffixOverridesand if testnull ! activityId activity_id #{activityId} /if /trim /selectXMLScriptBuilder中通过nodeHandlerMap维护标签与 Handler 的映射parseDynamicTags遍历 XML 子节点遇到元素节点则委派给对应的NodeHandler处理并标记isDynamic true。5. 缓存一级缓存与二级缓存章节第18章一级缓存、第19章二级缓存在数据库的一次会话中可能需要反复执行完全相同的查询语句。与从内存获取相比相同的数据再查询数据库的代价很大。一级缓存即在一个会话周期内添加缓存操作当会话结束commit/close/clear时清空缓存。一级缓存的查询流程定义在BaseExecutor#query中先根据CacheKey从localCache查询命中直接返回未命中则走queryFromDatabase查询数据库。同时通过queryStack计数避免递归清理ms.isFlushCacheRequired()判断是否需要清理局部缓存。二级缓存则基于一级缓存刷新操作在Configuration#newExecutor中通过装饰器模式实现——当cacheEnabled开启时用CachingExecutor包装SimpleExecutorpublic Executor newExecutor(Transaction transaction) { Executor executor new SimpleExecutor(this, transaction); // 配置开启缓存创建 CachingExecutor(默认就是有缓存)装饰者模式 if (cacheEnabled) { executor new CachingExecutor(executor); } return executor; }五、从源码中提炼10 种设计模式章节第22章Mybatis 设计模式在 MyBatis 两万多行的框架源码实现中使用了大量设计模式来解耦工程架构中面对复杂场景的设计。经过整理可以归纳出如下 10 种设计模式类型设计模式源码落点场景说明创建型工厂模式SqlSessionFactory、DefaultSqlSessionFactory、MapperProxyFactory、DataSourceFactory会话工厂负责获取数据源环境配置、构建事务工厂、创建执行器最终返回会话实现类创建型单例模式Configuration、ErrorContext、LogFactoryConfiguration 贯穿整个会话生命周期映射、缓存、入参出参、拦截器、注册机、对象工厂等都在其中初始化创建型建造者模式SqlSessionFactoryBuilder、XMLConfigBuilder、XMLMapperBuilder、XMLStatementBuilder、ResultMap#Builder所有 XML 解析到各类对象的封装都使用 Builder提供最佳边界隔离结构型适配器模式logging.Log接口及 Slf4jImpl 等实现统一 Log4j、Log4j2、Slf4J 等不同日志框架的接口差异结构型代理模式MapperProxy、Plugin、DriverProxy完成 DAO 接口的具体实现类方法操作任何 CRUD 调用都会被代理接管结构型组合模式SqlNode接口及各子类9 种动态 SQL 标签组成规则树结构型装饰器模式CachingExecutor包装SimpleExecutor用缓存执行器包装简单执行器实现二级缓存行为型模板模式BaseExecutor、BaseTypeHandler把查询、修改操作定义出标准流程子类实现特定步骤行为型策略模式TypeHandler及LongTypeHandler等按不同类型获取 JDBC 结果值避免大量 if 判断行为型迭代器模式PropertyTokenizer解析班级[0].学生.成绩这类对象关系路径以策略模式为例TypeHandlerT接口定义了setParameter、getResult等方法LongTypeHandler、StringTypeHandler、DateTypeHandler分别实现自己的策略在处理 JDBC 执行返回结果时按类型获取对应值。值得注意的是单纯背下这 10 种设计模式用处有限更有价值的是每说一个设计模式能联想到它在 MyBatis 框架哪个流程的源码实现上以及这套实现思路能否迁移到自己的业务流程开发中。六、学习源码的方法论不要拿绣花针搅拌一缸水大部分开发人员都清楚学习源码是提高技术的好方式但很多人不知道对一个源码框架该从哪下手很多时候即使阅读源码也感觉拿绣花针搅拌一缸水没啥收获还弄得挺疲惫。为什么读不懂框架源码与平常的业务需求开发相比框架源码中运用了大量的设计原则和设计模式对系统功能进行解耦和实现也使用了不少如反射、代理、字节码等相关技术。当还以业务开发中实例化对象调用方法的视角去找寻源码流程时可能根本找不到它何时发起调用、怎么传参、在哪赋值一连串的问题就把人劝退在学习路上。成体系学习优于拼凑网盘里几百 G 拼凑的资料没有完整脉络甚至部分已过时只是放着心安一份源码的成体系拆解渐进式学习可能需要 1~2 个月的时间但你总会在学习完后在头脑中构建出一套完整的关于此类知识的技术架构无论从哪里入口都能清楚各个分支流程的走向只追求快是最大的学习障碍。成体系地建设知识栈学习后也一定能梳理出自己的技术地图再用这些套路去学习其他源码内容就变得容易了。结合手写代码与官方源码对照学习推荐的实践路径是参考全貌地图对照手写代码与 MyBatis 官方源码同步学习每完成一个章节动手编写、测试并调试对不清楚的方法单独开发和验证最后尝试将学到的工具类如 MetaObject 反射工具包和设计模式迁移到自己的业务组件中实现学以致用。七、总结全貌地图是学习源码的导航一张图预览 MyBatis 框架的执行脉络分章节细化各模块实现流程对照手写代码与官方源码让学习从乱撞变成开图推进。手写是理解设计的最佳路径MyBatis 核心功能解析、绑定、反射、缓存、事务、注解、数据源、MetaObject需要 100 个类才能串联完整渐进式迭代开发让每个功能的引入都清晰可见。设计模式是框架的精华10 种设计模式在 MyBatis 源码中各有落点学习的关键是建立模式 → 源码位置 → 业务迁移的联想能力。仓库中 docs/md/spring/develop-mybatis 目录完整收录了《手写 Mybatis》22 章全部文档配合 第1章开篇介绍 与 第22章设计模式分析 两篇免费章节即可开启这条嘎嘎稳的源码学习之路。【免费下载链接】CodeGuide:books: 本代码库是作者小傅哥多年从事一线互联网 Java 开发的学习历程技术汇总旨在为大家提供一个清晰详细的学习教程侧重点更倾向编写Java核心内容。如果本仓库能为您提供帮助请给予支持(关注、点赞、分享)项目地址: https://gitcode.com/gh_mirrors/code/CodeGuide创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考