分析ibatis dao框架
為書寫方便,本文采用如下簡寫約定:
Transaction:Tx
Manager:Mgr
Context:Ctx
Interface:Iface
ibatis dao框架如圖:
DAO的核心在于DaoManager,DaoManager的創(chuàng)建代碼如下:
Reader reader = Resources.getResourceAsReader("dao.xml");
DaoManager daoMngr = DaoManagerBuilder.buildDaoManager(reader);
DaoManager是接口,查看DaoManagerBuilder源代碼可發(fā)現(xiàn),其buildDaoManager方法返回的是一個(gè)StandardDaoManager實(shí)例。buildDaoManager方法調(diào)用了XmlDaoManagerBuilder類的buildDaoManager方法,該方法完成如下工作:
1. 創(chuàng)建一個(gè)StandardDaoManager實(shí)例stdDaoMgr;
2. 創(chuàng)建一個(gè)用于全局收集各種property(來自
3. 解析dao.xml文件(建議閱讀本文時(shí)參考一份dao.xml文件,如JGameStore應(yīng)用中給出的dao.xml)中的
4. 解析dao.xml文件中的
4.1 解析dao.xml文件的
實(shí)例化一個(gè)DaoContext對象daoCtx;
將其daoManager字段設(shè)為我們的stdDaoMgr;
如
解析
4.1.1解析
根據(jù)
解析
根據(jù)properties對txMgr進(jìn)行配置(即調(diào)用txMgr.configure方法);
4.1.2解析
4.1.2.1解析過程為:
4.1.2.1.1實(shí)例化一個(gè)DaoImpl類實(shí)例daoImpl;
4.1.2.1.2將daoImpl的daoMgr字段設(shè)為我們的stdDaoMgr;
4.1.2.1.3將daoImpl的daoCtx字段設(shè)為我們的daoCtx;
4.1.2.1.4將daoImpl的daoIface字段設(shè)為
4.1.2.1.5將daoImpl的daoImplementation字段設(shè)為
4.1.2.1.6根據(jù)implementation屬性實(shí)例化一個(gè)DAO實(shí)現(xiàn)類,設(shè)為daoInstance字段值,注意,該實(shí)例一定是一個(gè)Dao接口實(shí)例,因?yàn)槿魏我粋€(gè)都繼承自DaoTemplate,而DaoTemplate實(shí)現(xiàn)了Dao接口;
4.1.2.1.7創(chuàng)建一個(gè)當(dāng)前DAO實(shí)現(xiàn)類的代理,設(shè)為daoImpl的proxy字段值,該代理在啟用顯式事務(wù)時(shí)會在調(diào)用委托方法前調(diào)用daoCtx.startTx方法;在使用隱式事務(wù)時(shí)則在調(diào)用委托方法的前后分別調(diào)用daoCtx.startTx方法和commitTx方法(在finally塊中還調(diào)用daoCtx.endTx方法)。
4.1.2.2將daoImpl加入daoCtx的過程為:以當(dāng)前daoImpl填充一張從daoIface到DaoImpl實(shí)例的表;
4.2 調(diào)用stdDaoMgr.addContext方法將daoCtx添加到stdDaoMgr中的過程為:
4.2.1以當(dāng)前daoCtx填充一張由id到DaoCtx實(shí)例的表;
4.2.2遍歷daoCtx中存放的所有daoImpl,填充一張從daoIface到daoCtx的表和一張從Dao接口實(shí)例(即daoImpl中的proxy和daoInstance)到daoCtx的表;
5. 客戶以某DaoIface調(diào)用DaoMgr.getDao方法得到一個(gè)DaoIface實(shí)現(xiàn)類實(shí)例xxxYyyDao的過程為:
stdDaoMgr查找其從daoIface到daoCtx的表,得到當(dāng)前daoIface所在daoCtx,然后調(diào)用daoCtx.getDao方法:
daoCtx查找其從daoIface到DaoImpl實(shí)例的表,得到daoImpl,返回其proxy字段;
6. 隱式事務(wù):
隱式事務(wù)中,客戶每調(diào)用一個(gè)xxxYyyDao中方法時(shí),都是一次完整的事務(wù),因?yàn)閤xxYyyDao是調(diào)用DaoMgr.getDao方法得到的,而根據(jù)5,其實(shí)xxxYyyDao是一個(gè)代理,又根據(jù)4.1.2.1.7,該代理會“在調(diào)用其委托方法前后分別調(diào)用daoCtx.startTx方法和commitTx方法(在finally塊中還調(diào)用daoCtx.endTx方法)”。
6.1 daoCtx.startTx方法調(diào)用其txMgr字段的txMgr.startTx方法,該方法返回一個(gè)DaoTx實(shí)例daoTx,daoCtx將它放入一個(gè)線程變量中;
6.2 DaoIface實(shí)現(xiàn)類中,由于其一定繼承自某個(gè)DaoTemplate,以調(diào)用其中的數(shù)據(jù)庫訪問方法,而這些數(shù)據(jù)庫訪問方法都會以自己作為參數(shù)調(diào)用daoMgr的getTx方法;該方法查找4.2.2中提到的從Dao接口實(shí)例到daoCtx的表,得到一個(gè)daoCtx,然后調(diào)用daoCtx.getTx;daoCtx.getTx將存儲在線程變量中的daoTx實(shí)例返回;
6.3 daoTx實(shí)例包含數(shù)據(jù)庫操作所需的關(guān)鍵元素,例如對于SqlMapDaoTx,其中就包含一個(gè)SqlMapClient實(shí)例,SqlMapDaoTemplate中的數(shù)據(jù)庫訪問方法(如insert,queryForList等)都是先調(diào)用daoMgr.getTx,得到daoTx實(shí)例,將其強(qiáng)制轉(zhuǎn)化為SqlMapDaoTx實(shí)例,然后調(diào)用其getSqlMap方法得到SqlMapClient實(shí)例,再調(diào)用SqlMapClient實(shí)例中的相應(yīng)方法;又如對于JDBC的情況,對應(yīng)DaoTx為ConnectionDaoTx,該類包含一個(gè),每次調(diào)用JdbcDaoTemplate方法的getConnection方法時(shí),該方法都先調(diào)用daoMgr.getTx,得到daoTx實(shí)例,將其強(qiáng)制轉(zhuǎn)化為ConnectionDaoTx實(shí)例,然后調(diào)用其getConnection方法得到其中的Connection實(shí)例,然后調(diào)用其中的相應(yīng)方法。
6.4 daoCtx.commitTx方法調(diào)用其txMgr字段的txMgr.commitTx(daoTx)方法完成事務(wù)的提交。
6.5 daoCtx.endTx方法調(diào)用其txMgr字段的txMgr.endTx(daoTx)方法結(jié)束事務(wù)。
7. 顯式事務(wù):
顯式事務(wù)通常包括三個(gè)步驟:首先,調(diào)用daoMgr.startTx,然后調(diào)用xxxYyyDao中的方法,最后調(diào)用daoMgr.commitTx。
7.1 daoMgr.startTx的工作非常簡單,只是設(shè)置stdDaoMgr中標(biāo)記顯式事務(wù)的字段;
7.2 調(diào)用xxxYyyDao中的方法時(shí),由于代理,將先調(diào)用daoCtx.startTx,此過程同6.1;
7.3 調(diào)用daoMgr.commitTx時(shí),該方法最終調(diào)用的也是daoCtx.commitTx,請參考6.4
下面以一個(gè)問題的實(shí)現(xiàn)來完成本文的總結(jié)工作:如果要由我來實(shí)現(xiàn)ibatis的DAO框架對于Hibernate的支持,我們應(yīng)該如何實(shí)現(xiàn)?
Hibernate的核心在于Session,所有的數(shù)據(jù)庫操作都可調(diào)用Session上的相應(yīng)方法完成,所有考慮用于支持Hibernate的DaoTx實(shí)現(xiàn)應(yīng)該是對Session的一個(gè)包裝,該實(shí)現(xiàn)中有一個(gè)返回當(dāng)前Session的getSession方法(當(dāng)然也包括提交和回滾方法)。同樣的,DaoTxMgr實(shí)現(xiàn)類的configure方法負(fù)責(zé)完成某個(gè)Session實(shí)例(session)的配置,startTx方法負(fù)責(zé)返回一個(gè)包裝了當(dāng)前session實(shí)例的DaoTx實(shí)例,commitTx方法將傳入的daoTx實(shí)例強(qiáng)制轉(zhuǎn)化后調(diào)用daoTx上的commit方法,rollbackTx方法將傳入的daoTx實(shí)例強(qiáng)制轉(zhuǎn)化后調(diào)用daoTx上的rollback方法。而HibernateDaoTemplate類的關(guān)鍵就在于其protected的getSession方法,該方法先調(diào)用daoMgr.getTx得到當(dāng)前daoTx實(shí)例,強(qiáng)制轉(zhuǎn)化后調(diào)用daoTx上的getSession方法即可。
查詢ibatis的源代碼,發(fā)現(xiàn)與以上思路完全相同。
【編輯推薦】