mybatis使用在日常開(kāi)發(fā)中很簡(jiǎn)單,基本沒(méi)有門(mén)檻叮叹,都是和Spring直接集成蜕煌,然后把之前的一些配置copy到spring的配置文件中就可以使用鲸阻。具體mybatis的配置文件加載代碼玄呛,已經(jīng)SqlSession執(zhí)行的細(xì)節(jié)都被封裝到了框架中阅懦,符合面向?qū)ο缶幊蹋谴嬖谝粋€(gè)問(wèn)題就是那些細(xì)節(jié)的代碼慢慢都被遺忘徘铝。寫(xiě)這個(gè)博客就是記錄一下耳胎,以后忘記可以看看。僅此而已庭砍。
Mybatis配置文件的讀取和SqlSessionFactory的構(gòu)建
在mybatis中加載的基本的順序是讀取配置文件场晶,然后構(gòu)建SqlSessionFactory
,通過(guò)SqlSessionFactory
獲取Session
實(shí)例怠缸,最后通過(guò)Session
實(shí)例獲取到對(duì)應(yīng)Mapper的代理對(duì)象,通過(guò)代理對(duì)象來(lái)調(diào)用CRUD方法執(zhí)行數(shù)據(jù)的操作钳宪。
SqlSessionFactory構(gòu)建
public class UserService {
private static SqlSessionFactory sqlSessionFactory;
//加載xml文件
static {
InputStream inputStream = null;
try {
//讀取配置文件
inputStream = Resources.getResourceAsStream("mybatis-config.xml");
//構(gòu)建SqlSessionFactory
sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
} catch (Exception e) {
e.printStackTrace();
} finally {
//關(guān)閉流
if (inputStream != null) {
try {
inputStream.close();
} catch (Exception e) {
e.printStackTrace();
}
}
}
}
}
先將Mybatis核心配置文件mybatis-config.xml
讀取到流中揭北,然后交給SqlSessionFactoryBuilder
構(gòu)建SqlSessionFactory
對(duì)象扳炬,在構(gòu)建前會(huì)對(duì)核心配置文件進(jìn)行一系列的分析,并將分析的內(nèi)容放到Configuration
實(shí)例中搔体,分析的過(guò)程之前的博客中有恨樟,可以翻一翻參考一下。
到這里是sqlSessionFactory
構(gòu)建完成疚俱,接下來(lái)看如何使用劝术。
SqlSession、Mapper的獲取以及使用
public void insert() {
//獲取SqlSession
SqlSession sqlSession = sqlSessionFactory.openSession();
//獲取UserMapper
UserMapper mapper = sqlSession.getMapper(UserMapper.class);
UserMode mode = new UserMode();
mode.setUserName("Joker");
mode.setUserPhone("15612341234");
mode.setUserAge(20);
//調(diào)用插入方法
mapper.insert(mode);
}
這里實(shí)現(xiàn)的邏輯的方法不難呆奕,關(guān)鍵是在于SqlSession
和UserMapper
的獲取养晋,這里和大家一起看看源碼。
SqlSession獲取源碼
在SqlSessionFactory
是個(gè)接口梁钾,其實(shí)現(xiàn)是DefaultSqlSessionFactory
绳泉,在這個(gè)類(lèi)中有各種獲取SqlSession
實(shí)例的方法,根據(jù)上面的實(shí)例代碼姆泻,找到openSession
方法的實(shí)現(xiàn)零酪。
public SqlSession openSession() {
/**
* configuration中獲取默認(rèn)的Executor執(zhí)行器的類(lèi)型
* 第二個(gè)參數(shù)是事務(wù)隔離級(jí)別
* 第三個(gè)參數(shù)表示是否自動(dòng)提交,默認(rèn)值是false
**/
return openSessionFromDataSource(configuration.getDefaultExecutorType(), null, false);
}
執(zhí)行器Executor
類(lèi)型有多種拇勃,如果在mapper.xml
文件中沒(méi)有特殊的配置基本使用的都是默認(rèn)的執(zhí)行器SimpleExecutor
四苇。事務(wù)隔離級(jí)別和是否自動(dòng)提交都是使用默認(rèn)的值。
進(jìn)入到openSessionFromDataSource
方法中后方咆,從上面的傳入?yún)?shù)可以知道蛔琅,在這個(gè)方法中就是根據(jù)Executor
執(zhí)行器的類(lèi)型創(chuàng)建相對(duì)應(yīng)的實(shí)例,同時(shí)也會(huì)根據(jù)數(shù)據(jù)相關(guān)的參數(shù)構(gòu)建出對(duì)應(yīng)的事務(wù)管理器峻呛。待著兩個(gè)實(shí)例構(gòu)建結(jié)束罗售,就會(huì)根據(jù)這兩個(gè)實(shí)例去構(gòu)建最終需要的SqlSession
實(shí)例。源碼如下:
/**
* 構(gòu)建Session
* @param execType 執(zhí)行器類(lèi)型
* @param level 事務(wù)隔離界別
* @param autoCommit 是否自動(dòng)提交
* @return
*/
private SqlSession openSessionFromDataSource(ExecutorType execType, TransactionIsolationLevel level, boolean autoCommit) {
Transaction tx = null;
try {
//configuration獲取環(huán)境配置信息
final Environment environment = configuration.getEnvironment();
//事務(wù)管理器工廠
final TransactionFactory transactionFactory = getTransactionFactoryFromEnvironment(environment);
//創(chuàng)建事務(wù)管理器
tx = transactionFactory.newTransaction(environment.getDataSource(), level, autoCommit);
//創(chuàng)建執(zhí)行器executor
final Executor executor = configuration.newExecutor(tx, execType);
//構(gòu)建Session
return new DefaultSqlSession(configuration, executor, autoCommit);
} catch (Exception e) {
closeTransaction(tx); // may have fetched a connection so lets call close()
throw ExceptionFactory.wrapException("Error opening session. Cause: " + e, e);
} finally {
ErrorContext.instance().reset();
}
}
基本的流程和上面的解釋一樣钩述。至于再深入的代碼就不再詳盡的貼出來(lái)啦(源碼的內(nèi)容太多寨躁,入口已提供,可以自己跟進(jìn)去詳細(xì)的了解)牙勘,但是下面可以大概的說(shuō)一下职恳。
在mybatis-config.xml
核心配置文件中有個(gè)environment標(biāo)簽,這個(gè)標(biāo)簽中會(huì)配置相應(yīng)的數(shù)據(jù)源信息和事務(wù)管理器的信息方面。在源碼中將這些參數(shù)傳入到事務(wù)管理器工廠中放钦,構(gòu)建工廠對(duì)象TransactionFactory
,接著調(diào)用其創(chuàng)建事務(wù)管理器對(duì)象的方法恭金。到這里事務(wù)管理器實(shí)例創(chuàng)建完成操禀。
然后根據(jù)構(gòu)建好的事務(wù)管理器和執(zhí)行器類(lèi)型去構(gòu)建執(zhí)行器對(duì)象,執(zhí)行器對(duì)象的類(lèi)型共有三種横腿,從ExecutorType
枚舉類(lèi)中可以看到颓屑,分別是是BATCH
批處理模式斤寂,REUSE
復(fù)用模式,SIMPLE
簡(jiǎn)單模式揪惦。在newExecutor
方法中對(duì)執(zhí)行器類(lèi)型做了判斷遍搞,當(dāng)不是批處理或者復(fù)用模式的時(shí)候就默認(rèn)使用簡(jiǎn)單模式,當(dāng)然后面還有對(duì)cacheEnabled
的判斷器腋,如果支持緩存溪猿,還需要對(duì)上面的SimpleExecutor
包裝一層,然后就是對(duì)整個(gè)執(zhí)行鏈的包裝纫塌。至此執(zhí)行器構(gòu)建完成诊县。(執(zhí)行器構(gòu)建的過(guò)程使用的是裝飾器模式)
事務(wù)管理器、執(zhí)行器構(gòu)建結(jié)束护戳,使用Configuration
翎冲、執(zhí)行器和是否自動(dòng)提交參數(shù),構(gòu)建SqlSession
對(duì)象媳荒,這個(gè)過(guò)程很簡(jiǎn)單抗悍,就是將這些參數(shù)設(shè)置到SqlSession
對(duì)象成員變量中。
Mapper獲取源碼
Mapper本身只是一個(gè)接口钳枕,在從SqlSession
對(duì)象中get
獲取對(duì)象的時(shí)候缴渊,是使用的動(dòng)態(tài)代理,在mybatis源碼中有一個(gè)模塊叫做binding鱼炒,在這里面有具體做動(dòng)態(tài)代理的實(shí)現(xiàn)衔沼。看源碼:
public <T> T getMapper(Class<T> type) {
//通過(guò)configuration構(gòu)建Mapper實(shí)例
return configuration.<T>getMapper(type, this);
}
在SqlSession
中有個(gè)Configuration
實(shí)例昔瞧,通過(guò)這個(gè)實(shí)例使用的getMapper
方法構(gòu)建Mapper代理對(duì)象指蚁,進(jìn)入后會(huì)調(diào)用MapperRegistry
(Mapper注冊(cè)器),在注冊(cè)器里面會(huì)構(gòu)建MapperProxyFactory
工廠類(lèi)自晰,然后通過(guò)工廠類(lèi)的newInstance
方法構(gòu)建具體的代理對(duì)象MapperProxy
凝化。
public <T> T getMapper(Class<T> type, SqlSession sqlSession) {
//根據(jù)type到knowMappers中獲取MapperProxyFactory實(shí)例
final MapperProxyFactory<T> mapperProxyFactory = (MapperProxyFactory<T>) knownMappers.get(type);
if (mapperProxyFactory == null) {
throw new BindingException("Type " + type + " is not known to the MapperRegistry.");
}
try {
//mapperProxyFactory生成對(duì)象實(shí)例
return mapperProxyFactory.newInstance(sqlSession);
} catch (Exception e) {
throw new BindingException("Error getting mapper instance. Cause: " + e, e);
}
}
通過(guò)這里就完成了Mapper代理對(duì)象的創(chuàng)建,并返回酬荞。
insert方法調(diào)用
在mapper.xml
文件的結(jié)果過(guò)程中搓劫,有對(duì)應(yīng)的方法解析,每個(gè)方法解析后會(huì)對(duì)應(yīng)有一個(gè)MappedStatement
混巧。最終會(huì)調(diào)用到執(zhí)行器Executor
中的update
方法枪向。整個(gè)執(zhí)行的過(guò)程相對(duì)比較復(fù)雜一點(diǎn),這里就不貼出源碼咧党,有興趣的可以看一下秘蛔,篇幅有限,在后續(xù)的博客文章里面再詳細(xì)說(shuō)Executor
執(zhí)行各種方法的方式和流程。
本文作者:程序猿楊鮑
版權(quán)歸作者所有缠犀,轉(zhuǎn)載請(qǐng)注明出處