序言
在開始正文之前，首先解釋Dao接口和XML文件里的SQL是如何一一對應的？
一句話講完就是：mybatis 會先解析這些xml 文件，通過 xml 文件里面的命名空間 （namespace）跟dao 建立關系；然后 xml 中的每段 sql 會有一個id 跟 dao 中的接口進行關聯。
那么問題來了: "如果 我有兩個這個xml 文件 都跟這個dao 建立關系了，那不是就是沖突了？"
帶着這個疑問我們就要開始下面的正題了！
一、初始化
首先我們要知道每個基於 MyBatis 的應用都是以一個 SqlSessionFactory 的實例為中心的，SqlSessionFactory 的實例可以通過 SqlSessionFactoryBuilder 獲得。
但SqlSessionFactory是一個接口，它里面其實就兩個方法：openSession、getConfiguration
其中，openSession方法是為了獲取一個SqlSession對象，完成必要數據庫增刪改查功能。但是，SqlSessionFactory屬性太少了，所以需要getConfiguration的配合；來配置mapper映射文件、SQL參數、返回值類型、緩存等屬性。
/**
* Creates an {@link SqlSession} out of a connection or a DataSource
*
* @author Clinton Begin
*/
public interface SqlSessionFactory {
SqlSession openSession();
SqlSession openSession(boolean autoCommit);
SqlSession openSession(Connection connection);
SqlSession openSession(TransactionIsolationLevel level);
SqlSession openSession(ExecutorType execType);
SqlSession openSession(ExecutorType execType, boolean autoCommit);
SqlSession openSession(ExecutorType execType, TransactionIsolationLevel level);
SqlSession openSession(ExecutorType execType, Connection connection);
Configuration getConfiguration();
}
可以看到getConfiguration是屬於Configuration類的一個方法。你可以把它當成一個配置管家。MyBatis所有的配置信息都維持在Configuration對象之中，基本每個對象都會持有它的引用。
但日常開發中我們都是將Mybatis與Spring一起使用的，所以把實例化交給Spring處理。
因此我們可以看下org.mybatis.spring.SqlSessionFactoryBean，它實現了InitializingBean接口。這說明，在這個類被實例化之后會調用到afterPropertiesSet()。它只有一個方法
public void afterPropertiesSet() throws Exception {
this.sqlSessionFactory = buildSqlSessionFactory();
}
而這個afterPropertiesSet方法只有一個動作，就是buildSqlSessionFactory。它可以分為兩部分來看:
- 1、從配置文件的property屬性中加載各種組件，解析配置到configuration中
- 2、加載mapper文件，解析SQL語句，封裝成MappedStatement對象，配置到configuration中。
二、mapper接口方法是怎樣被調用到的？
大致有如下兩種方式：
- Mybatis提供的API
使用Mybatis提供的API進行操作，通過獲取SqlSession對象，然后根據Statement Id 和參數來操作數據庫。
String statement = "com.mmzsblog.business.dao.MemberMapper.getMemberList";
List<Member> result = sqlsession.selectList(statement);
- mapper接口
定義Mapper接口，並在里面定義一系列業務數據操作方法。在Service層通過注入mapper屬性，調用其方法就可以執行數據庫操作。就像下面這樣
public interface MemberMapper {
List<Member> getMemberList();
}
@Service
public class MemberServiceImpl implements MemberService{
@Resource
private MemberMapper memberMapper;
@Override
public List<Member> getMemberList() {
return memberMapper.getMemberList();
}
}
那么，MemberMapper 只是個接口，並沒有任何實現類。我們在調用它的時候，它是怎樣最終執行到我們的SQL語句的呢？
三、Mapper接口的代理創建過程
3.1、首先我們會配置需要掃描的基本包路徑
通過注解的方式配置：
@MapperScan({"com.mmzsblog.business.dao"})
或者xml的方式配置：
<bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
<property name="basePackage" value="com.mmzsblog.business.dao" />
<property name="sqlSessionFactoryBeanName" value="sqlSessionFactory"></property>
</bean>
3.2、開始掃描
我們來到org.mybatis.spring.mapper.MapperScannerConfigurer這個類，可以看到它實現了幾個接口。
其中的重點是BeanDefinitionRegistryPostProcessor。它可以動態的注冊Bean信息，方法為postProcessBeanDefinitionRegistry()。
public void postProcessBeanDefinitionRegistry(BeanDefinitionRegistry registry) {
if (this.processPropertyPlaceHolders) {
this.processPropertyPlaceHolders();
}
// 創建ClassPath掃描器，設置屬性，然后調用掃描方法
ClassPathMapperScanner scanner = new ClassPathMapperScanner(registry);
scanner.setAddToConfig(this.addToConfig);
scanner.setAnnotationClass(this.annotationClass);
scanner.setMarkerInterface(this.markerInterface);
scanner.setSqlSessionFactory(this.sqlSessionFactory);
scanner.setSqlSessionTemplate(this.sqlSessionTemplate);
scanner.setSqlSessionFactoryBeanName(this.sqlSessionFactoryBeanName);
scanner.setSqlSessionTemplateBeanName(this.sqlSessionTemplateBeanName);
scanner.setResourceLoader(this.applicationContext);
scanner.setBeanNameGenerator(this.nameGenerator);
// 創建ClassPath掃描器，設置屬性，然后調用掃描方法
scanner.registerFilters();
scanner.scan(StringUtils.tokenizeToStringArray(this.basePackage, ",; \t\n"));
}
ClassPathMapperScanner繼承自Spring中的類ClassPathBeanDefinitionScanner，所以它的scan方法會調用到父類ClassPathBeanDefinitionScanner的scan方法，
public class ClassPathBeanDefinitionScanner extends ClassPathScanningCandidateComponentProvider {
……
public int scan(String... basePackages) {
//
int beanCountAtScanStart = this.registry.getBeanDefinitionCount();
this.doScan(basePackages);
if (this.includeAnnotationConfig) {
AnnotationConfigUtils.registerAnnotationConfigProcessors(this.registry);
}
return this.registry.getBeanDefinitionCount() - beanCountAtScanStart;
}
……
}
而在父類的scan方法中又調用到子類ClassPathMapperScanner重寫的doScan方法。
public class ClassPathMapperScanner extends ClassPathBeanDefinitionScanner {
……
public Set<BeanDefinitionHolder> doScan(String... basePackages) {
Set<BeanDefinitionHolder> beanDefinitions = super.doScan(basePackages);
if (beanDefinitions.isEmpty()) {
this.logger.warn("No MyBatis mapper was found in '" + Arrays.toString(basePackages) + "' package. Please check your configuration.");
} else {
this.processBeanDefinitions(beanDefinitions);
}
return beanDefinitions;
}
……
}
此處super.doScan(basePackages)是Spring中的方法,就不貼代碼多敘述了，想詳細了解的話，可以自己翻一下源碼哦。
3.3、bean注冊完成並創建sqlSession代理
並且經過上面這些步驟，此時已經掃描到了所有的Mapper接口，並將其注冊為BeanDefinition對象。而注冊的時候就是用到了上面doScan方法中的processBeanDefinitions方法。
public class ClassPathMapperScanner extends ClassPathBeanDefinitionScanner {
……
// 設置beanClass
private MapperFactoryBean<?> mapperFactoryBean = new MapperFactoryBean();
……
private void processBeanDefinitions(Set<BeanDefinitionHolder> beanDefinitions) {
Iterator var3 = beanDefinitions.iterator();
while(var3.hasNext()) {
BeanDefinitionHolder holder = (BeanDefinitionHolder)var3.next();
GenericBeanDefinition definition = (GenericBeanDefinition)holder.getBeanDefinition();
if (this.logger.isDebugEnabled()) {
this.logger.debug("Creating MapperFactoryBean with name '" + holder.getBeanName() + "' and '" + definition.getBeanClassName() + "' mapperInterface");
}
// 將mapper接口的名稱添加到構造參數
definition.getConstructorArgumentValues().addGenericArgumentValue(definition.getBeanClassName());
// 設置BeanDefinition的class
definition.setBeanClass(this.mapperFactoryBean.getClass());
// 添加屬性addToConfig
definition.getPropertyValues().add("addToConfig", this.addToConfig);
boolean explicitFactoryUsed = false;
// 添加屬性sqlSessionFactory
if (StringUtils.hasText(this.sqlSessionFactoryBeanName)) {
definition.getPropertyValues().add("sqlSessionFactory", new RuntimeBeanReference(this.sqlSessionFactoryBeanName));
explicitFactoryUsed = true;
} else if (this.sqlSessionFactory != null) {
definition.getPropertyValues().add("sqlSessionFactory", this.sqlSessionFactory);
explicitFactoryUsed = true;
}
if (StringUtils.hasText(this.sqlSessionTemplateBeanName)) {
if (explicitFactoryUsed) {
this.logger.warn("Cannot use both: sqlSessionTemplate and sqlSessionFactory together. sqlSessionFactory is ignored.");
}
definition.getPropertyValues().add("sqlSessionTemplate", new RuntimeBeanReference(this.sqlSessionTemplateBeanName));
explicitFactoryUsed = true;
} else if (this.sqlSessionTemplate != null) {
if (explicitFactoryUsed) {
this.logger.warn("Cannot use both: sqlSessionTemplate and sqlSessionFactory together. sqlSessionFactory is ignored.");
}
definition.getPropertyValues().add("sqlSessionTemplate", this.sqlSessionTemplate);
explicitFactoryUsed = true;
}
if (!explicitFactoryUsed) {
if (this.logger.isDebugEnabled()) {
this.logger.debug("Enabling autowire by type for MapperFactoryBean with name '" + holder.getBeanName() + "'.");
}
definition.setAutowireMode(2);
}
}
}
……
}
處理的過程相對比較簡單，只是往BeanDefinition對象中設置了一些屬性。例如：
- 設置beanClass
設置BeanDefinition對象的BeanClass為MapperFactoryBean<?>。這就相當於使用MemberMapper注冊時：當前的mapper接口在Spring容器中，beanName是memberMapper，beanClass是MapperFactoryBean.class。故在Spring的IOC初始化的時候，實例化的對象就是MapperFactoryBean對象。
- 設置sqlSessionFactory屬性
為BeanDefinition對象添加屬性sqlSessionFactory，是為了BeanDefinition對象設置PropertyValue的時候，方便調用到setSqlSessionFactory()。
3.4、創建sqlSession代理類
最終在setSqlSessionFactory這個方法里，sqlSession獲取到的是SqlSessionTemplate實例。而在SqlSessionTemplate對象中，主要包含sqlSessionFactory和sqlSessionProxy，而sqlSessionProxy實際上是SqlSession接口的代理對象。實際調用的是代理類的invoke方法。
public class MapperProxy<T> implements InvocationHandler, Serializable {
……
@Override
public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
try {
if (Object.class.equals(method.getDeclaringClass())) {
return method.invoke(this, args);
} else if (isDefaultMethod(method)) {
return invokeDefaultMethod(proxy, method, args);
}
} catch (Throwable t) {
throw ExceptionUtil.unwrapThrowable(t);
}
final MapperMethod mapperMethod = cachedMapperMethod(method);
return mapperMethod.execute(sqlSession, args);
}
……
}
3.5、小結
Mapper接口的代理創建過程大致如下：
- 1、掃描mapper接口基本包路徑下的所有對象，將其注冊為BeanDefinition對象
- 2、設置BeanDefinition的對象的beanClass和sqlSessionFactory屬性（而其中獲取BeanDefinition對象的時候，調用其工廠方法getObject，返回mapper接口的代理類）
- 3、設置sqlSessionFactory屬性的時候，會調用SqlSessionTemplate的構造方法，創建SqlSession接口的代理類
最后我們在Service層，通過
@Resource
private MemberMapper memberDao;
注入屬性的時候，返回的就是代理類。執行memberDao的方法的時候，實際調用的也是代理類的invoke方法。
四、回答最開始的問題
Mybatis在初始化SqlSessionFactoryBean的時候，找到配置需要掃描的基本包路徑去解析里面所有的XML文件。重點就在如下兩個地方：
1、創建SqlSource
Mybatis會把每個SQL標簽封裝成SqlSource對象。然后根據SQL語句的不同，又分為動態SQL和靜態SQL。其中，靜態SQL包含一段String類型的sql語句；而動態SQL則是由一個個SqlNode組成。
2、創建MappedStatement
XML文件中的每一個SQL標簽就對應一個MappedStatement對象，這里面有兩個屬性很重要。
- id
全限定類名+方法名組成的ID。
- sqlSource
當前SQL標簽對應的SqlSource對象。
創建完MappedStatement對象，會將它緩存到Configuration#mappedStatements中。
前面初始化中提到的Configuration對象，我們知道它就是Mybatis中的配置大管家，基本所有的配置信息都維護在這里。
例如下面這樣一段代碼：
<!-- namespace的值就是全限定類名 -->
<mapper namespace="com.java.mmzsblog.dao.MemberMapper">
……
<!-- select標簽中id的值就是方法名，它和全限定類中的方法名是對應的 -->
<select id="getMemberById" resultType="com.java.mmzsblog.entity.member">
select * from member
<where>
<if test="memberId!=null">
and member_id=#{memberId}
</if>
</where>
</select>
……
</mapper>
把所有的XML都解析完成之后，Configuration就包含了所有的SQL信息。然后解析完成的XML大概就是這樣了：
看到上面的圖示，聰明如你，也許就大概知道了。當我們執行Mybatis方法的時候，就通過全限定類名+方法名找到MappedStatement對象，然后解析里面的SQL內容，執行即可。