MyBatis系列 (1) ~ 启动
MyBatis作为一种优秀的持久层框架,在不少项目中都有使用。最近抽时间看了看MyBatis的源码,今天在这里聊聊MyBatis的启动解析过程,希望能对大家有所帮助。
一、 demo及代码。
1.MyBatis config 配置文件。
图1 MyBatis配置文件2.sql映射Mapper配置文件。
图2 mapper配置文件3.User类以及user建表语句。
图3 User类文件 图4 User表4.测试代码如下:
图5 测试代码二、MyBatis的启动。
最关键的就是解析xml文件,生成configuration对象。SqlSessionFactoryBuilder对象的build(reader)方法将会触发MyBatis的启动,具体过程如下:
1.在build方法内部将会创建一个XMLConfigBuilder类型的parser对象,之后将会调用parser的parse方法返回Configuration对象,再调用build方法生成DefaultSqlSessionFactory并返回。
图6 build方法2.XMLConfigBuilder构造函数。函数会先创建XMLMapperEntityResolver对象,再创建XPathParser对象,最后调用重载构造方法(见第5点)。
图7 XMLConfigBuilder构造函数3.XMLMapperEntityResolver类。XMLMapperEntityResolver内部定义了MyBatis的dtd。主要是“CONFIG”以及“MAPPER”。
图8 XMLMapperEntityResolver类4.XPathParser构造函数。利用commonConstructor方法设置属性,并利用createDocument方法把InputStream封装成document对象。
图9 XPathParser构造函数5.XMLConfigBuilder构造函数_2。在这个方法内部,首先会创建一个Configuration对象,并调用父类BaseBuilder的构造函数,设置configuration、typeAliasRegistry、typeHandlerRegistry属性。
图10 XMLConfigBuilder构造函数_26.Configuration类。Configuration内部定义了一些重要的对象,其实MyBatis的启动就是根据配置文件对Configuration属性设置不同的值。重要的属性如typeHandlerRegistry、typeAliasRegistry、mappedStatements、caches、parameterMaps等。在TypeHandlerRegistry与TypeAliasRegistry构造函数内部,注册了许多常见的TypeHandler和TypeAlias。并且在Configuration的构造函数也注册了许多常见MyBatis的TypeAlias。
图11 Configuration属性 图12 TypeHandlerRegistry构造函数 图13 TypeAliasRegistry构造函数 图14 Configuration构造函数7.parse方法。XMLConfigBuilder对象创建好以后,就调用parse方法根据配置文件设置configuration对象。parse方法方法如下,关键是调用parseConfiguration方法。
图15 parse方法8.parseConfiguration方法。parseConfiguration解析了configuration的配置文件,parseConfiguration方法和configuration配置文件相对应。基本上,每个元素都是一个单独的方法。
图16 parseConfiguration方法 图17 configuration配置文件结构9.mapperElement方法。parseConfiguration方法里,这里重点分析MyBatis如何解析sql映射文件,即mapperElement方法。根据“package”、“resource”、“url”、“class”采取不同的解析策略。package和class用MapperAnnotationBuilder解析,resource与url利用XMLMapperBuilder解析。由于demo是配置的resource,所以在此分析XMLMapperBuilder。
图18 mapperElement方法10.XMLMapperBuilder构造函数。其实XMLMapperBuilder与前面的XMLConfigBuilder非常相似。会先生成XMLMapperEntityResolver对象和XPathParser对象。在利用父类BaseBuilder的构造函数设置configuration、typeAliasRegistry、typeHandlerRegistry属性。
图19 XMLMapperBuilder构造函数 图20 BaseBuilder构造函数11.XMLMapperBuilder的parse方法。在parse方法内部,关键是调用configurationElement方法解析mapper配置文件。
图21 XMLMapperBuilder.parse方法12.configurationElement方法。在方法内部解析"cache","cache-ref","resultMap","parameterMap","sql","insert","update","delete","select"标签。
图22 configurationElement方法13.Statement的添加。configurationElement方法调用buildStatementFromContext方法。buildStatementFromContext调用XMLStatementBuilder.parseStatementNode()方法,在XMLStatementBuilder.parseStatementNode()方法内部解析"insert"、"update"、"delete"、"select"标签的属性(这里代码有点长),后面通过builderAssistant.addMappedStatement()把statement添加到configuration。
图23 buildStatementFromContext方法 图24 XMLStatementBuilder.parseStatementNode() 图25 statement添加到configuration至此,demo中xml对象的解析过程基本上就完了。后面把Configuration返回给build方法,创建并返回DefaultSqlSessionFactory对象。关于MyBatis如何是管理session的下次在介绍。