Mybatis對mapper的加載流程深入講解
今天來分析Configuration初始化的最后一部分mapper的加載。
加載方法mapperElement
XMLConfigBuilder配置Configuration的parseConfiguration方法還剩最后一行解析代碼:mapperElement(root.evalNode('mappers'));
mapperElement方法源碼與詳解如下圖:
從源碼可以得出一些結論:
mappers節(jié)點支持mapper和package兩種類型子節(jié)點;
package子節(jié)點只需要name一個屬性;
一個mapper子節(jié)點有且只能有url、resource、class三個屬性中其中一個,否則會拋出異常;
mapperElement解析兩種mappers子節(jié)點,主要代碼我分成了4個部分,接下來逐一進行深入解析。
解析包方法addMappers
首先來看解析包的方法使用的是configuration的addMappers方法,方法主要是涉及到一個MapperRegistry類型的屬性mapperRegistry,addMappers主要流程如下圖:
addMappers方法主要涉及到的是MapperRegistry這個類,這個類有兩個屬性:config、knownMappers。 在config指向的是configuration,knownMappers存放這class文件對應的MapperProxyFactory 。 MapperProxyFactory根據(jù)名字先猜測是創(chuàng)建mapper代理的工廠。
介紹完關鍵類,再來看addMappers主要分4步:
調用mapperRegistry屬性的addMappers(String packageName)方法這個方法會調用另外一個addMappers;
addMappers(String packageName, Class<?> superType)方法會遍歷指定包下面所有屬于superType子類的類,上一步傳遞的是Object.class,所以這里是遍歷所有類,然后調用addMapper(mapperClass)方法;
addMapper(mapperClass)方法首先需要判斷mapperClass必須是接口, 再判斷class是否已經(jīng)存在,存在會報異常 。不存在則實例化一個MapperProxyFactory對象并put進knownMappers,最后根據(jù)class創(chuàng)建一個MapperAnnotationBuilder并調用parse方法。
最后是MapperAnnotationBuilder的parse方法,MapperAnnotationBuilder是解析mapper注解的,我們后面詳解。
加載package下的mapper總的流程看下來比較簡單,實際上就是 找到對應包下面所有的接口,然后根據(jù)接口創(chuàng)建一個MapperProxyFactory放到configuration屬性mapperRegistry的knownMappers中 。
解析單個mapper
從解析單個mapper有三種情況,但是分兩種情況,一種是有resource或者url屬性的是直接根據(jù)屬性值生成一個XMLMapperBuilder對象,然后執(zhí)行parse方法,如果是由class屬性值和加載包的最后一步方法相似,調用mapperRegistry的addMapper方法。
XMLMapperBuilder的初始化和parse簡單介紹源碼如下圖:
解析mapper.xml的XMLMapperBuilder和最開始解析mybatis-config.xml的XMLConfigBuilder一樣都是繼承至mybatis的BaseBuilder,并且初始化流程也差不多。
可以看出XMLMapperBuilder類是解析mapper.xml最關鍵的類,這個類比較復雜,接下來的文章再來專門講解它。
總結
mapper的注入支持兩種方式,單個mapper注入或者整個包下面注入,也可以按加載class文件或者xml文件分成兩種。單個mapper注入如果是根據(jù)url或者xml則是通過加載xml文件注入,通過url獲取掃描整個包加載則是class方式進行注入。
通過xml加載是直接根據(jù)xml生成XMLMapperBuilder,然后執(zhí)行parse方法。
通過class加載則是接口類生成MapperProxyFactory,放到MapperRegistry的map屬性knownMappers中,最后通過MapperAnnotationBuilder執(zhí)行parse進行解析,parse也會調用XMLMapperBuilder的parse方法。
后面的文章我們先解讀MapperAnnotationBuilder這個類,最終再來看最重要的類XMLMapperBuilder。
從目前源碼可以得出一些需要注意的點:
一個mapper子節(jié)點有且只能有url、resource、class三個屬性中其中一個,否則會拋出異常; 一個mapper只能被加載一次,重復加載會拋出異常。到此這篇關于Mybatis對mapper的加載流程深入講解的文章就介紹到這了,更多相關Mybatis對mapper的加載流程內容請搜索好吧啦網(wǎng)以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持好吧啦網(wǎng)!
相關文章:
