ibatis源码学习2_初始化和配置文件解析
问题
在详细介绍ibatis初始化过程之前,让我们先来思考几个问题。
1. ibatis初始化的目标是什么?
上文中提到过,ibatis初始化的核心目标是构造SqlMapClientImpl对象,主要是其内部重要属性delegate这个代理对象的初始化。delegate这个对象耦合了用户端的操作行为和执行环境,持有执行操作所需要的所有数据。
2. 如何解析ibatis的sqlmap配置文件和sqlmap映射文件?
可以采用通用的xml文件解析工具,如SAX等。
3. 如何将配置文件中每个节点值注入到SqlMapClientImpl对象中?
可以给不同类型节点设置对应的handler,遍历节点时,调用handler对象的处理方法,将节点值注入到SqlMapClientImpl对象的属性中。
带着上面的这些问题,我们开始探索ibatis的初始化过程。
核心类图
初始化过程主要涉及以下几个重要类,理解这些类的含义非常重要。主要类图如下:
1. Nodelet
该接口是对配置文件中节点处理方式的抽象,该接口仅有一个process()方法,表示对该类节点的处理方式。
2. NodeletParser
同SAX类似的一个xml解析器。不同点在于SAX对所有节点采用同样的处理方式,而NodeletParser可以针对不同的节点个性化配置相 应的处理方式。 NodeletParser内部维护了一个letMap,这个map维护着节点标识信息XPath和对应的处理方式Nodelet的关系。
3. XmlParserState
用于维护配置文件解析过程中的上下文信息,配置文件解析过程中产生的数据都放入XmlParserState中统一维护。
注意: ibatis2.3.0版本中没有这个类,它使用BaseParser的内部类Variables维护上下文信息。
4. SqlMapConfigParser
用于解析sqlMap配置文件,其内部组合了NodeletParser对象,用于完成sqlMap配置文件解析。该对象构造函数中,完成向NodeletParser属性中添加sqlMap配置文件中节点XPath和对应的Nodelet映射关系。比如<typeAlias>节点的处理方式如下:
- private void addTypeAliasNodelets() {
- parser.addNodelet("/sqlMapConfig/typeAlias", new Nodelet() {
- public void process(Node node) throws Exception {
- Properties prop = NodeletUtils.parseAttributes(node, state.getGlobalProps()); //解析节点信息
- String alias = prop.getProperty("alias");
- String type = prop.getProperty("type");
- state.getConfig().getTypeHandlerFactory().putTypeAlias(alias, type); //向XmlParserState写数据
- }
- });
- }
5. SqlMapParser
用于解析sqlMap映射文件,其内部组合了NodeletParser对象,用于完成sqlMap映射文件解析。和SqlMapConfigParser类似,在构造函数中向NodeletParser属性添加sqlMap映射文件中节点标识信息XPath和对应的Nodelet映射关系。比如<sql>节点的处理方式如下:
- private void addSqlNodelets() {
- parser.addNodelet("/sqlMap/sql", new Nodelet() {
- public void process(Node node) throws Exception {
- Properties attributes = NodeletUtils.parseAttributes(node, state.getGlobalProps());
- String id = attributes.getProperty("id");
- if (state.isUseStatementNamespaces()) {
- id = state.applyNamespace(id);
- }
- if (state.getSqlIncludes().containsKey(id)) {
- throw new SqlMapException("Duplicate <sql>-include '" + id + "' found.");
- } else {
- state.getSqlIncludes().put(id, node);
- }
- }
- });
- }
6. SqlStatementParser
用于生成sql对应的MappedStatement对象。其内部仅包含一个public方法parseGeneralStatement(Node node, GeneralStatement statement),用于生成MappedStatement对象。
下面以代码中常见的ibatis配置为例,说明ibatis框架的配置文件解析和初始化过程。
常见ibatis配置
- <bean id="sqlMapClient" class="org.springframework.orm.ibatis.SqlMapClientFactoryBean">
- <property name="dataSource" ref="dataSource"/>
- <property name="configLocation" value="classpath/sqlmap-ibatis.xml"/>
- </bean>
- <sqlMapConfig>
- <sqlMap resource="sqlmap/cases/CaseSQL.xml"/>
- ...
- </sqlMapConfig>
- <select id="QUERY-CASE-BY-CASE-ID" parameterClass="map" resultMap="RM-Case">
- SELECT ID ,GMT_MODIFIED ,GMT_CREATE ,STATUS
- FROM AVATAR_CASE
- WHERE ID = #caseId#
- </select>
初始化过程
1) SqlMapClientFactoryBean初始化
SqlMapClientFactoryBean的初始化方法afterPropertiesSet(),用于构建sqlMapClient对象:
- public void afterPropertiesSet() throws Exception {
- ...
- this.sqlMapClient = buildSqlMapClient(this.configLocations, this.mappingLocations, this.sqlMapClientProperties); //初始化核心方法,构建sqlMapClient对象 ...
- }
其中buildSqlMapClient()的实现:
- protected SqlMapClient buildSqlMapClient(
- Resource[] configLocations, Resource[] mappingLocations, Properties properties)
- throws IOException {
- ...
- SqlMapClient client = null;
- SqlMapConfigParser configParser = new SqlMapConfigParser();
- for (int i = 0; i < configLocations.length; i++) {
- InputStream is = configLocations[i].getInputStream();
- try {
- client = configParser.parse(is, properties); //通过SqlMapConfigParser解析配置文件,生成SQLMapClientImpl对象
- }
- ...
- return client;
- }
上面这段代码中,调用SqlMapConfigParser解析sqlMap配置文件sqlmap-ibatis.xml。
2) 调用SqlMapConfigParser进行解析
SqlMapConfigParser.parse(InputStream inputStream, Properties props)方法源码如下:
- public SqlMapClient parse(InputStream inputStream, Properties props) {
- if (props != null) state.setGlobalProps(props);
- return parse(inputStream);
- }
其中parse()方法源码如下:
- public SqlMapClient parse(InputStream inputStream) {
- ...
- parser.parse(inputStream); // 调用NodeletParser解析配置文件
- return state.getConfig().getClient(); //返回SqlMapClientImpl对象
- ...
- }
3) 调用NodeletParser进行解析
NodeletParser.parse()是配置文件解析的核心方法,这里被SqlMapConfigParser调用,用于解析sqlMap配置文件sqlmap-ibatis.xml。
- public void parse(InputStream inputStream) throws NodeletException {
- try {
- Document doc = createDocument(inputStream);
- parse(doc.getLastChild()); //从根节点开始解析
- }
- ...
- }
其中parse(Node node)方法源码如下:
- public void parse(Node node) {
- Path path = new Path();
- processNodelet(node, "/");
- process(node, path);
- }
这个方法中包含两个重要方法,processNodelet()根据当前节点的XPath进行相应处理,process()方法用于处理该节点相关信息(如Element,Attribute,Children等)。
首先看一下processNodelet(Node node, String pathString)的源码实现:
- private void processNodelet(Node node, String pathString) {
- Nodelet nodelet = (Nodelet) letMap.get(pathString);
- if (nodelet != null) {
- try {
- nodelet.process(node);
- }
- ...
- }
- }
注意:在SqlMapConfigParser类介绍中,我们提到过NodeletParser中letMap属性维护着节点XPath信息和节点信息处理方式的映射关系,所有的映射关系会在SqlMapConfigParser构造函数中加入。 这里根据节点的XPath,获取对应的处理方式Nodelet,再调用Nodelet.process()处理该节点信息。
再来看一下NodeletParser.process(Node node, Path path)的源码实现:
- private void process(Node node, Path path) {
- if (node instanceof Element) {
- //处理Element信息
- String elementName = node.getNodeName();
- path.add(elementName);
- processNodelet(node, path.toString());
- processNodelet(node, new StringBuffer("//").append(elementName).toString());
- //处理Attribute信息
- NamedNodeMap attributes = node.getAttributes();
- int n = attributes.getLength();
- for (int i = 0; i < n; i++) {
- Node att = attributes.item(i);
- String attrName = att.getNodeName();
- path.add("@" + attrName);
- processNodelet(att, path.toString());
- processNodelet(node, new StringBuffer("//@").append(attrName).toString());
- path.remove();
- }
- // 处理Children信息
- NodeList children = node.getChildNodes();
- for (int i = 0; i < children.getLength(); i++) {
- process(children.item(i), path); //递归处理子节点
- }
- path.add("end()");
- processNodelet(node, path.toString());
- path.remove();
- path.remove();
- } else if (node instanceof Text) {
- // Text
- path.add("text()");
- processNodelet(node, path.toString());
- processNodelet(node, "//text()");
- path.remove();
- }
- }
该方法中依次处理节点的Element、Attribute和Children信息,处理Children信息时采用的是递归的方式。处理每个节点时,首先构建当前节点的XPath信息,再调用processNodelet(node, path)对该节点进行处理。
4) 调用SqlMapParser解析sqlMap映射配置文件CaseSQL.xml。
当处理sqlMap配置文件sqlmap-ibatis.xml中的sqlMap节点时,会调用下面的Nodelet进行处理:
- protected void addSqlMapNodelets() {
- parser.addNodelet("/sqlMapConfig/sqlMap", new Nodelet() {
- public void process(Node node) throws Exception {
- ...
- Properties attributes = NodeletUtils.parseAttributes(node, state.getGlobalProps());
- String resource = attributes.getProperty("resource");
- String url = attributes.getProperty("url");
- ...
- new SqlMapParser(state).parse(reader); //调用SqlMapParser解析sqlMap映射文件
- }
- }
- });
- }
SqlMapParser的parse()方法实现如下
- public void parse(InputStream inputStream) throws NodeletException {
- parser.parse(inputStream);//调用NodeletParser解析配置文件
- }
这里和上面的SqlMapConfigParser解析方式类似,都是调用NodeletParser解析配置文件,不同点在于这两个类是针对不同的配置文件解析(SqlMapConfigParser针对sqlMap配置文件,SqlMapParser针对sqlMap映射文件),所以在各自构造函数插入letMap时,使用的key是自己配置文件里节点的XPath。
5) 调用SqlStatementParser生成MappedStatement。
当解析sqlMap映射文件的select节点时,将调用SqlStatementParser生成MappedStatement。
- protected void addStatementNodelets() {
- ...
- parser.addNodelet("/sqlMap/select", new Nodelet() {
- public void process(Node node) throws Exception {
- statementParser.parseGeneralStatement(node, new SelectStatement());
- }
- });
SqlStatementParser.parseGeneralStatement()的实现这里就不详述了,主要目的是构建MappedStatement,并将配置文件解析后的信息注入到XmlParserState中。
小结
ibatis初始化的核心目标是构建SqlMapClientImpl对象,主要思想如下:
1. 构建NodeletParser配置文件解析类,它维护了节点XPath和对应处理方式的映射关系,并提供了节点的通用处理方法。
2. SqlMapConfigParser和SqlMapParser在构造方法中向NodeletParser中添加节点XPath和对应处理方式的映射关系。
3. 配置文件解析采用递归方式进行,首先生成当前节点的XPath信息,再从NodeletParser获取对应的处理方式并执行。
4. 整个解析过程中每个节点生成的数据统一注入到XmlParserState,最终通过XmlParserStat获取SqlMapClientImpl对象并返回。
ibatis源码学习2_初始化和配置文件解析的更多相关文章
- ibatis源码学习1_整体设计和核心流程
背景介绍ibatis实现之前,先来看一段jdbc代码: Class.forName("com.mysql.jdbc.Driver"); String url = "jdb ...
- ibatis源码学习4_参数和结果的映射原理
问题在详细介绍ibatis参数和结果映射原理之前,让我们先来思考几个问题.1. 为什么需要参数和结果的映射?相对于全自动的orm,ibatis一个重要目标是,通过维护POJO与SQL之间的映射关系,让 ...
- Vue源码学习02 初始化模块init.js
接上篇,我们看到了VUE分了很多模块(initMixin()stateMixin()eventsMixin()lifecycleMixin()renderMixin()),通过使用Mixin模式,都是 ...
- Mybatis源码学习之parsing包(解析器)(二)
简述 大家都知道mybatis中,无论是配置文件mybatis-config.xml,还是SQL语句,都是写在XML文件中的,那么mybatis是如何解析这些XML文件呢?这就是本文将要学习的就是,m ...
- spring源码学习之默认标签的解析(一)
继续spring源码的学习之路,现在越来越觉得这个真的很枯燥的,而且我觉得要是自己来看源码,真的看不下去,不是没有耐心,而是真的没有头绪,我觉得结合着书来看,还是很有必要的,最起码大致的流程是能够捋清 ...
- spring源码学习之默认标签的解析(二)
这个是接着上一篇来写,主要是这章内容比较多,还是分开来写吧! 一.AbstractBeanDefinition属性介绍 XML中的所有的属性都可以在GenericBeanDefinition中找到对应 ...
- Vben Admin 源码学习:项目初始化
0x00 前言 Vue-Vben-Admin 是一个免费开源的中后台模版.使用了最新的vue3,vite2,TypeScript等主流技术开发,开箱即用的中后台前端解决方案考. 本系列本着学习参考的目 ...
- spring源码学习之:xml配置文件标签自定义
Spring框架从2.0版本开始,提供了基于Schema风格的XML扩展机制,允许开发者扩展最基本的spring配置文件(一 般是classpath下的spring.xml).试想一下,如果我们直接在 ...
- ibatis源码学习3_源码包结构
ibatis的技术是从xml里面字符串转换成JAVA对象,对象填充JDBC的statement查询,然后从resultset取对象返回,另外利用ThreadLocal实现线程安全,JDBC保证了事务控 ...
随机推荐
- vue-cli 自定义过滤器的使用
vue-cli 自定义过滤器的使用 vue2.0将内置过滤器去除,所以过滤器需要自己编写. Vue.js 允许你自定义过滤器,可被用作一些常见的文本格式化.过滤器可以用在两个地方:mustache 插 ...
- 网络编程基础之Socket套接字
一.Socket介绍 1.什么是socket? Socket是应用层与TCP/IP协议族通信的中间软件抽象层,它是一组接口.在设计模式中,Socket其实就是一个门面模式,它把复杂的TCP/IP协议族 ...
- yaml文件转properties和properties转yaml
首先要引入依赖 <dependency> <groupId>com.fasterxml.jackson.dataformat</groupId> <artif ...
- H5 css学习
p{text-indent:2em;}段前空两格 段落排版--行间距(行高) p{line-height:1.5em;} 段落排版--中文字间距.字母间距 h1{ letter-spaci ...
- 226. Invert Binary Tree 翻转二叉树
[抄题]: Invert a binary tree. 4 / \ 2 7 / \ / \ 1 3 6 9 to 4 / \ 7 2 / \ / \ 9 6 3 1 [暴力解法]: 时间分析: 空间分 ...
- Tftp上传、下载
上传 tftp -g -r filename serverip 下载 tftp -p -l filename serverip
- Spring boot 开发组件
一.Jboot 描述:Jboot是一个基于jfinal 和 undertow开发的微服务框架.提供了AOP.RPC.分布式缓存.限流.降级.熔断.统一配置中心.swagger api自动生成.Open ...
- Jmeter线程ramp-up period (in seconds)如何取值
线程组主要包含三个参数:线程数.准备时长(Ramp-Up Period(in seconds)).循环次数. 线程数:虚拟用户数.一个虚拟用户占用一个进程或线程.设置多少虚拟用户数在这里也就是设置多少 ...
- JSON_UNESCAPED_UNICODE
JSON_UNESCAPED_UNICODE(中文不转为unicode)
- k8s启动Pod遇到CrashLoopBackOff的解决方法
1.用kubectl get pod 当看到上面的状态后执行第2步 2.查看pod详情 [root@cc hzb]# kubectl describe pod ceph-mysql-hzb-pod 找 ...