mybatic MapperScannerConfigurer的原理

標籤：樣本   ack   對象   sample   new   back   訪問   api   src   

原文地址：http://www.cnblogs.com/fangjian0423/p/spring-mybatis-MapperScannerConfigurer-analysis.html

前言

本文將分析mybatis與spring整合的MapperScannerConfigurer的底層原理，之前已經分析過java中實現動態，可以使用jdk內建api和cglib第三方庫產生動態代理。本文分析的mybatis版本3.2.7，mybatis-spring版本1.2.2。

MapperScannerConfigurer介紹

MapperScannerConfigurer是spring和mybatis整合的mybatis-spring jar包中提供的一個類。

想要瞭解該類的作用，就得先瞭解MapperFactoryBean。

MapperFactoryBean的出現為了代替手工使用SqlSessionDaoSupport或SqlSessionTemplate編寫Data Access Objects(DAO)的代碼,使用動態代理實現。

比如下面這個官方文檔中的配置：

<bean id="userMapper" class="org.mybatis.spring.mapper.MapperFactoryBean">

<property name="mapperInterface" value="org.mybatis.spring.sample.mapper.UserMapper" />

<property name="sqlSessionFactory" ref="sqlSessionFactory" />

</bean>

org.mybatis.spring.sample.mapper.UserMapper是一個介面，我們建立一個MapperFactoryBean執行個體，然後注入這個介面和sqlSessionFactory（mybatis中提供的SqlSessionFactory介面，MapperFactoryBean會使用SqlSessionFactory建立SqlSession）這兩個屬性。

之後想使用這個UserMapper介面的話，直接通過spring注入這個bean，然後就可以直接使用了，spring內部會建立一個這個介面的動態代理。

當發現要使用多個MapperFactoryBean的時候，一個一個定義肯定非常麻煩，於是mybatis-spring提供了MapperScannerConfigurer這個類，它將會尋找類路徑下的映射器並自動將它們建立成MapperFactoryBean。

<bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">

<property name="basePackage" value="org.mybatis.spring.sample.mapper" />

</bean>

這段配置會掃描org.mybatis.spring.sample.mapper下的所有介面，然後建立各自介面的動態代理類。

注意：這裡會掃描下面所有的介面，但是經過我的實驗，只會對在mapper.xml中的namespace中配置了的介面才會產生動態代理類。不會影響到basePackage下面的其他介面。

MapperScannerConfigurer底層程式碼分析

以以下代碼為樣本進行講解(部分代碼，其他代碼及配置省略)：

package org.format.dynamicproxy.mybatis.dao;

publicinterfaceUserDao {

public User getById(int id);

publicintadd(User user);

publicintupdate(User user);

publicintdelete(User user);

public List<User> getAll();

}

 

<bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">

<property name="basePackage" value="org.format.dynamicproxy.mybatis.dao"/>

<property name="sqlSessionFactoryBeanName" value="sqlSessionFactory"/>

</bean>

我們先通過測試案例debug查看userDao的實作類別到底是什麼。

我們可以看到，userDao是1個MapperProxy類的執行個體。
看下MapperProxy的源碼，沒錯，實現了InvocationHandler，說明使用了jdk內建的動態代理。

publicclassMapperProxy<T> implementsInvocationHandler, Serializable {

 

privatestaticfinallong serialVersionUID = -6424540398559729838L;

privatefinal SqlSession sqlSession;

privatefinal Class<T> mapperInterface;

privatefinal Map<Method, MapperMethod> methodCache;

 

publicMapperProxy(SqlSession sqlSession, Class<T> mapperInterface, Map<Method, MapperMethod> methodCache) {

this.sqlSession = sqlSession;

this.mapperInterface = mapperInterface;

this.methodCache = methodCache;

}

 

public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {

if (Object.class.equals(method.getDeclaringClass())) {

try {

return method.invoke(this, args);

} catch (Throwable t) {

throw ExceptionUtil.unwrapThrowable(t);

}

}

final MapperMethod mapperMethod = cachedMapperMethod(method);

return mapperMethod.execute(sqlSession, args);

}

 

private MapperMethod cachedMapperMethod(Method method) {

MapperMethod mapperMethod = methodCache.get(method);

if (mapperMethod == null) {

mapperMethod = new MapperMethod(mapperInterface, method, sqlSession.getConfiguration());

methodCache.put(method, mapperMethod);

}

return mapperMethod;

}

 

}

 

註：瞭解概念看到這裡就可以了，如果需要詳細研究可以繼續看下面的內容。

 

下面開始分析MapperScannerConfigurer的源碼

MapperScannerConfigurer實現了BeanDefinitionRegistryPostProcessor介面，BeanDefinitionRegistryPostProcessor介面是一個可以修改spring工長中已定義的bean的介面，該介面有個postProcessBeanDefinitionRegistry方法。

然後我們看下ClassPathMapperScanner中的關鍵是如何掃描對應package下的介面的。

其實MapperScannerConfigurer的作用也就是將對應的介面的類型改造為MapperFactoryBean，而這個MapperFactoryBean的屬性mapperInterface是原類型。MapperFactoryBean本文開頭已分析過。

所以最終我們還是要分析MapperFactoryBean的實現原理！

MapperFactoryBean繼承了SqlSessionDaoSupport類，SqlSessionDaoSupport類繼承DaoSupport抽象類別，DaoSupport抽象類別實現了InitializingBean介面，因此執行個體個MapperFactoryBean的時候，都會調用InitializingBean介面的afterPropertiesSet方法。

DaoSupport的afterPropertiesSet方法：

MapperFactoryBean重寫了checkDaoConfig方法：

然後通過spring工廠拿對應的bean的時候：

這裡的SqlSession是SqlSessionTemplate，SqlSessionTemplate的getMapper方法：

Configuration的getMapper方法，會使用MapperRegistry的getMapper方法：

MapperRegistry的getMapper方法：

MapperProxyFactory構造MapperProxy：

沒錯！ MapperProxyFactory就是使用了jdk組帶的Proxy完成動態代理。
MapperProxy本來一開始已經提到。MapperProxy內部使用了MapperMethod類完成方法的調用：

下面，我們以UserDao的getById方法來debug看看MapperMethod的execute方法是如何走的。

@Test

publicvoidtestGet() {

int id = 1;

System.out.println(userDao.getById(id));

}

<select id="getById" parameterType="int" resultType="org.format.dynamicproxy.mybatis.bean.User">

SELECT * FROM users WHERE id = #{id}

</select>

mybatic MapperScannerConfigurer的原理