mybatis 的 dao 介面跟 xml 檔案裡面的 sql 是如何建立關係的？一步步解析
序言
在開始正文之前，首先解釋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內容，執行即可