iBATIS源码分析

ibatis的包组成中从历史版本中我们能看到他是有:ibatis-dao.jar,ibatis-common.jar,ibatis-sqlmap.jar三个包组成,所以学习源码之前,我们先澄清一些东西,同时让大家弄清楚什么时候该引入什么包,一般情况下如果你的项目只是用到了ibatis,没有其他容器使用,那么你可以考虑使用ibatis-dao+ibatis-common+ibatis-sqlmap,如果你使用了spring做为容器,那么其实你将不需要引入ibatis-dao,同时有时候我们也会发现有ibatis-core的包,这个是在ibatis的2.2以后将ibatis-common.jar和ibatis-sqlmap.jar二合一之后的结果,所以看到ibatis-core之后基本就不需要引入common和sqlmap这两个包了,如果你引入了ibatis-dao.jar那么ibatis-core是必须引入的。

这里就需要弄明白为什么会有ibatis-dao.jar,为什么2.3.x的版本中不在引入。这都要从ibatis-dao.jar的功能及设计初衷谈起。

首先DAO是J2EE的一种设计模式即DAO设计模式,ibatis-dao.jar的存在是更面向应用层的,SQL Map组件相对要更底层一些,靠近数据源层,DAO组件可以通过调用SQL Map组件来实现业务处理,ibatis提供的DAO层不但可以继承Ibatis的SQLMap组件想成一个一个一体的解决方案,同时还可以融入其他多种ORM组件,如Hibernate、Apache Ojb、TopLink、甚至包括JDBC、JTA。

在我们检出的jpetstore项目中我们会看到一个类DaoConfig

1 public class DaoConfig {

2   
 3   private static final String resource = "com/ibatis/jpetstore/persistence/dao.xml";  
 4   private static final DaoManager daoManager;  
 5   
 6   static {  
 7     try {  
 8       daoManager = newDaoManager(null);  
 9       Properties props = Resources.getResourceAsProperties("properties/database.properties");  
10       String url = props.getProperty("url");  
11       String driver = props.getProperty("driver");  
12       String username = props.getProperty("username");  
13       String password = props.getProperty("password");  
14       if (url.equals("jdbc:hsqldb:mem:jpetstore")) {  
15         Class.forName(driver).newInstance();  
16         Connection conn = DriverManager.getConnection(url, username, password);  
17         try {  
18           ScriptRunner runner = new ScriptRunner(conn, false, false);  
19           runner.setErrorLogWriter(null);  
20           runner.setLogWriter(null);  
21           runner.runScript(Resources.getResourceAsReader("ddl/hsql/jpetstore-hsqldb-schema.sql"));  
22           runner.runScript(Resources.getResourceAsReader("ddl/hsql/jpetstore-hsqldb-dataload.sql"));  
23         } finally {  
24           conn.close();  
25         }  
26       }  
27     } catch (Exception e) {  
28       throw new RuntimeException("Description.  Cause: " + e, e);  
29     }  
30   
31   }  
32   
33   public static DaoManager getDaoManager() {  
34     return daoManager;  
35   }  
36   
37   public static DaoManager newDaoManager(Properties props) {  
38     try {  
39       Reader reader = Resources.getResourceAsReader(resource);  
40       return DaoManagerBuilder.buildDaoManager(reader, props);  
41     } catch (Exception e) {  
42       throw new RuntimeException("Could not initialize DaoConfig.  Cause: " + e, e);  
43     }  
44   }  
45   
46 }

其中

1 public static DaoManager newDaoManager(Properties props) {  
2    try {  
3      Reader reader = Resources.getResourceAsReader(resource);  
4      return DaoManagerBuilder.buildDaoManager(reader, props);  
5    } catch (Exception e) {  
6      throw new RuntimeException("Could not initialize DaoConfig.  Cause: " + e, e);  
7    }  
8  }

上面的代码加载了一个resource,这个resource正是一个名字叫dao.xml的文件

文件内容大致如下:

1 <?xml version="1.0" encoding="UTF-8"?>  
 2   
 3 <!DOCTYPE daoConfig  
 4     PUBLIC "-//ibatis.apache.org//DTD DAO Configuration 2.0//EN"  
 5     "http://ibatis.apache.org/dtd/dao-2.dtd">  
 6   
 7 <daoConfig>  
 8   
 9   <context>  
10   
11     <transactionManager type="SQLMAP">  
12       <property name="SqlMapConfigResource"  
13         value="com/ibatis/jpetstore/persistence/sqlmapdao/sql/sql-map-config.xml"/>  
14     </transactionManager>  
15   
16     <dao interface="com.ibatis.jpetstore.persistence.iface.ItemDao"  
17       implementation="com.ibatis.jpetstore.persistence.sqlmapdao.ItemSqlMapDao"/>  
18   
19     <dao interface="com.ibatis.jpetstore.persistence.iface.SequenceDao"  
20       implementation="com.ibatis.jpetstore.persistence.sqlmapdao.SequenceSqlMapDao"/>  
21   
22     <dao interface="com.ibatis.jpetstore.persistence.iface.AccountDao"  
23       implementation="com.ibatis.jpetstore.persistence.sqlmapdao.AccountSqlMapDao"/>  
24   
25     <dao interface="com.ibatis.jpetstore.persistence.iface.CategoryDao"  
26       implementation="com.ibatis.jpetstore.persistence.sqlmapdao.CategorySqlMapDao"/>  
27   
28     <dao interface="com.ibatis.jpetstore.persistence.iface.ProductDao"  
29       implementation="com.ibatis.jpetstore.persistence.sqlmapdao.ProductSqlMapDao"/>  
30   
31     <dao interface="com.ibatis.jpetstore.persistence.iface.OrderDao"  
32       implementation="com.ibatis.jpetstore.persistence.sqlmapdao.OrderSqlMapDao"/>  
33   
34   </context>  
35   
36 </daoConfig>

这个文件就是ibatis-dao.jar的入口文件,也是核心文件,后续的所有操作将依照这个文件进行。在此向置于文件头,后续会多次用到

在ibatis-dao.jar包中我们可以看到他有两个子包组成分别为:client、engine.共计34个类

1.client主要作为对外的接口部分。

2.engine主要是其内部实现。

client中包含:5个类(或接口)一个子包(包含6个类/接口)

Dao类:该类是一个接口,只是一个表示接口,没有任何约束,主要用来表述所有实现该接口的类都是操作数据的类,ibatis DAO中的所有业务dao类都要事先client中的Dao接口

DaoException类:该类继承RuntimeException类,用来统一异常输出

DaoManager类:核心接口,用来定义所有管理ibatis的dao对象实现必须遵守的规则,包括获取dao实现类,获取事务,以及事务的打开、提交、关闭

DaoManagerBuilder类:该类用来创建DaoManager类,但其本身不做处理,通过传入配置文件生成DaoManager,具体实现还是需要调用engine包下的XmlDaoManagerBuilder,XmlDaoManagerBuilder功能就是将dao.xml文件实例化成client中的的各个实例对象,是DaoManager类的工厂类。

DaoTransaction类:统一的事务操作接口

client包下还有一个template包,该包中的类都是根据模版原则,定义了不同orm的DAO操作规范

DaoTemplate,一个实现了Dao的抽象类

HibernateDaoTemplate.java :针对Hibernate定义的Dao模板类

JdbcDaoTemplate.java:JDBC定义的Dao的简单封装

OjbBrokerDaoTemplate.java

SqlMapDaoTemplate.java

ToplinkDaoTemplate.java

engine下的文件包含三部分:build ,负责通过解析dao.xml(可以为别的名字,跟DaoManager最终加载的文件名同名即可)文件生成client中的实例对象;impl组件,为build组件提供支持,用来将build中解析的字符串封装成impl中的实例,impl是client的具体实现。transaction负责集中ORM的事务管理。

首先介绍build,build中包含两个类:

DaoClasspathEntityResolver.java:实现了org.xml.sax.EntityResolver,作为自定义的xml解析器,负责从ClassPath中加载DTD文件,同时将其作为流输出,后续再解析dao.xml中需要。

XmlDaoManagerBuilder.java:该类主要用来解析dao.xml生成impl中的对象,也是ibatis-dao.xml的核心类

下面介绍 impl部分:

impl部分主要包含:

DaoContext.java :这个类是用来封装上面dao.xml中的context节点的实现类

DaoImpl.java:这个类是用来封装context节点下的所有dao节点的实现类

DaoProxy.java:负责创建Dao接口的代理对象。

DaoTransactionState.java:事务的状态信息,内部实现采用自关联

StandardDaoManager.java:ibatis-dao的管理类。idContextMap属性用来按照context的id存放所有的context实例,typeContextMap用来存放key为daoimpl的实现类接口,value为dao归属的context的实现类;daoImplMap包含两种key-value组合:key:负责存放有daoImpl的代理类,value:daoimpl,key:dao实现类的实例;

所有的操作都起始于DaoManagerBuilder的buildDaoManager的方法,最终调用new XmlDaoManagerBuilder().buildDaoManager(reader, props);加载dao.xml并解析,获取到创建imp下的所有实例并组装,在ibatis-dao中所有数据库操作都是源于transaction,其中包含6中事务类型,根据自己的实际需要使用,这个也决定了最终你的配置文件中<transactionManager type="JDBC">这个节点的type属性是什么目前ibatis-dao支持的类型有:见XmlDaoManagerBuilder类构造函数

1 public XmlDaoManagerBuilder() {  
2    typeAliases.put("EXTERNAL", ExternalDaoTransactionManager.class.getName());  
3    typeAliases.put("HIBERNATE", HibernateDaoTransactionManager.class.getName());  
4    typeAliases.put("JDBC", JdbcDaoTransactionManager.class.getName());  
5    typeAliases.put("JTA", JtaDaoTransactionManager.class.getName());  
6    typeAliases.put("OJB", "com.ibatis.dao.engine.transaction.ojb.OjbBrokerTransactionManager");  
7    typeAliases.put("SQLMAP", SqlMapDaoTransactionManager.class.getName());  
8    typeAliases.put("TOPLINK", "com.ibatis.dao.engine.transaction.toplink.ToplinkDaoTransactionManager");

9  }

所以也就出现了上边dao.xml文件中的SQLMAP,这个最终是在该构造函数中匹配到了SqlMapDaoTransactionManager.class.getName()该类,所以如果你定义了这里没有的,那么可能就需你使用全限定名了

同时ibatis-dao中用到了很多ibatis-common.jar中的工具类,如Resource,这个是主要是获取文件转换为inputStream或者转为Reader,加载类,实例化类,ClassInfo,ibatis中很强大的一个类,后边在介绍common包的时候会单独介绍。

至此dao包就基本讲完了,没有大篇幅的介绍代码主要是我比较懒,同时内容太多容易让人生烦,而且也容易跑题,所以就不一一介绍了,但是34个类的功能基本清楚了,具体的实现进一步去看问题应该就不大了。之所以将这个包主要出于一下目的:

1.平时我们经常看到很多人用spring直接使用了sqlmapclient,却还要去加载dao包,这就是没有弄明白dao包的作用。

2.从dao的实现我们略微可以收获一下结论,简单容器的实现,如context的实现,该包后续没有发展,估计也有一部分原因是因为spring的强大(我意淫的),使作者放弃了继续搞的打算,不过我还是觉得对于业务调用来说,早期的dao还是很方便了,即便你有多个数据源,只需要配置多个context便可以了,对于业务调用他只要从DaoManager中get就好了,不用管底层到底调用了那个数据源,这一点我觉得还是很有必要的。

3.dao的包装类,daoimpl很有想法,通过代理来操作事务,隐藏了很多操作,简化了开发

4.xml文档的解析可以看看XmlDaoManagerBuilder这个类,虽然代码比较多,不过结构很清晰,而且从第一行看到最后一行也绝对不会混乱,因为代码就是从上到下实现的。

这里我们整理一下两个过程

1.文件解析及其加载的过程:

一、客户端调用XmlDaoManagerBuilderde.buildDaoManager方法

二、XmlDaoManagerBuilder对象创建一个StandardDaoManager对象

三、读取配置文件中的daoConfig节点下的context个数,XmlDaoManagerBuilder对象循环创建1个或者多个DaoContext对象

四、根据配置文件中的context节点下transactionManager的个数,XmlDaoManagerBuilder对象创建TransactionManager对象

五、把Transaction对象赋值给DaoContext对象,由于DaoContext对象只有一个Transaction属性,所以如果配置文件配置多个TransactionManager最后只能是最后一个有效

六、根据context节点下DAO的个数XmlDaoManagerBuilder对象实例化多个DaoImpl对象

七、每个DaoImpl实例化对象根据获得的dao节点中的implementation属性采用constructor.newInstance方法动态实例化dao的的实现类赋值给daoImpl.setDaoInstance(dao);

八、调用daoImpl的// 生成dao的代理 daoImpl.initProxy();赋值给impl的proxy属性最终作为DaoManager的get参数被使用,从而保证调用到的是代理后的daoimpl,可以达到隐藏调用transaction的效果

九、将所有的daoImpl加入到DaoContext的Map中

十、将所有的DaoContext遍历加入到StandardDaoManager对象的Map变量中,同时将所有的DaoImpl放入到StandardDaoManager的Map属性中,具体参加文章上部分标红内容

十一、XmlDaoManagerBuilder返回获取到的StandardDaoManager对象。

2.Dao的调用过程:

一、客户端调用某个实现了Dao的类

二、通过DaoManager获取到的是DaoImpl的代理类,所以调用其invoke方法

三、DaoProxy对象的invoke方法执行过程通过DaoImpl获取StandardDaoManager对象

四、判断是否启用了transaction,执行五、六、七,跳过后续,否则执行以下所有

五、如果启用了,则获取DaoImpl的DaoContext对象

六、通过DaoContext开启事务:context.startTransaction();

七、执行Impl中的方法,method.invoke(daoImpl.getDaoInstance(), args);

八、context.commitTransaction();

九、context.endTransaction();

关于xml文件的解析分为两种

SAX基于事件流的解析

DOM基于XML文档树结构的解析

在对dao.xml的解析中,采用了二者结合的方式。对于dao.xml的格式是否正确,这里采用的是DTD文件,它包括一些常用的xml语法规则,如:XML文档必须有根元素、XML文档必须关闭等等。这些校验规则需要通过SAX的EnityResolver接口的实现类来处理的,比如本包中的DaoClasspathEntityResolver。

转自:http://tzwzero-163-com.iteye.com/blog/1715024

时间: 2024-11-06 08:33:43

iBATIS源码分析的相关文章

【异常及源码分析】org.mybatis.spring.MyBatisSystemException: nested exception is org.apache.ibatis.type.TypeException: Could not set parameters for mapping: ParameterMapping

一.异常出现的场景 1)异常出现的SQL @Select("SELECT\n" + " id,discount_type ,min_charge, ${cardFee} AS actualDiscountPrice , discount_price AS discountPrice ,status ,name \n" + "FROM\n" + "\tuser_coupon \n" + "WHERE\n" +

Mybatis源码分析之Cache二级缓存原理 (五)

一:Cache类的介绍 讲解缓存之前我们需要先了解一下Cache接口以及实现MyBatis定义了一个org.apache.ibatis.cache.Cache接口作为其Cache提供者的SPI(ServiceProvider Interface) ,所有的MyBatis内部的Cache缓存,都应该实现这一接口 Cache的实现类中,Cache有不同的功能,每个功能独立,互不影响,则对于不同的Cache功能,这里使用了装饰者模式实现. 看下cache的实现类,如下图: 1.FIFOCache:先进

【MyBatis】MyBatis Tomcat JNDI原理及源码分析

一. Tomcat JNDI JNDI(java nameing and drectory interface),是一组在Java应用中访问命名和服务的API,所谓命名服务,即将对象和名称联系起来,使得可以通过名称访问并获取对象. 简单原理介绍:点击访问 tomcat已经集成该服务(内置并默认使用DBCP连接池),简单来说就是键值对的mapping,而且在tomcat服务器启动的首页configuration中就已经有完成的示例代码.要想使用tomcat的JNDI服务,只需要导入相关的jar包,

MyBatis源码分析-SQL语句执行的完整流程

MyBatis 是支持定制化 SQL.存储过程以及高级映射的优秀的持久层框架.MyBatis 避免了几乎所有的 JDBC 代码和手动设置参数以及获取结果集.MyBatis 可以对配置和原生Map使用简单的 XML 或注解,将接口和 Java 的 POJOs(Plain Old Java Objects,普通的 Java对象)映射成数据库中的记录.如何新建MyBatis源码工程请点击MyBatis源码分析-IDEA新建MyBatis源码工程. MyBatis框架主要完成的是以下2件事情: 根据JD

There is no getter for property named &#39;*&#39; in &#39;class java.lang.String&#39;之源码分析

There is no getter for property named '*' in 'class java.lang.String',此错误之所以出现,是因为mybatis在对parameterType="String"的sql语句做了限制,假如你使用<when test="username != null">这样的条件判断时,就会出现该错误,不过今天我们来刨根问底一下. 一.错误再现 想要追本溯源,就需要错误再现,那么假设我们有这样一个sql查询

MyBatis框架的使用及源码分析(十一) StatementHandler

我们回忆一下<MyBatis框架的使用及源码分析(十) CacheExecutor,SimpleExecutor,BatchExecutor ,ReuseExecutor> , 这4个Excecutor执行sql操作的最终都调用了StatementHandler 来执行,我们拿SimpleExecutor来看: public int doUpdate(MappedStatement ms, Object parameter) throws SQLException { Statement st

Mybatis源码分析一(SqlsessionFactory及源码整体结构)

搞java的想提高自己的姿势水平,想拿高工资,对常用开源框架的深入了解是必不可少的,想深入了解源码分析更是必不可少的,今天我开始对mybatis的源码进行分析,并做点记录以备查验.开源框架研究,文档的获取建议去读官方的文档和例子,这样获得的知识成体系,成体系的知识被你掌握了,你就可以说你精通它了.好了,开始吧. 上面说道要看官方的文档,那么就得找到官方网站什么的对吧?这里给几个网站都是不错的: Myabtis官网:http://www.mybatis.org/ github地址:https://

实际测试例子+源码分析的方式解剖MyBatis缓存的概念

前言: 前方高能! 本文内容有点多,通过实际测试例子+源码分析的方式解剖MyBatis缓存的概念,对这方面有兴趣的小伙伴请继续看下去~ MyBatis缓存介绍首先看一段wiki上关于MyBatis缓存的介绍: MyBatis支持声明式数据缓存(declarative data caching).当一条SQL语句被标记为"可缓存"后,首次执行它时从数据库获取的所有数据会被存储在一段高速缓存中,今后执行这条语句时就会从高速缓存中读取结果,而不是再次命中数据库.MyBatis提供了默认下基于

Mybatis源码分析:BaseBuilder

*/ .hljs { display: block; overflow-x: auto; padding: 0.5em; background: #F0F0F0; } /* Base color: saturation 0; */ .hljs, .hljs-subst { color: #444; } .hljs-comment { color: #888888; } .hljs-keyword, .hljs-attribute, .hljs-selector-tag, .hljs-meta-k