@
目錄- 前言
- 正文
- 插件擴展
- 1. Interceptor核心實作原理
- 2. Mybatis的攔截增強
- Mybatis與Spring整合原理
- 1. SqlSessionFactory的創建
- 2. 掃描Mapper并創建代理物件
- 3. 如何整合Spring事務
- 4. FactoryBean的擴展知識
- 插件擴展
- 總結
前言
前面幾篇文章分析了Mybatis的核心原理，但模塊較多，沒有一一分析，更多的需要讀者自己下來研究，不過Mybatis的插件擴展機制還是非常重要的，像PageHelper就是一個擴展插件，熟悉其擴展原理，才能更好的針對我們的業務作出更合適的擴展，另外，現在Mybatis都是和Spring/SpringBoot一起使用，那么Mybatis又是如何與它們進行整合的呢？一切答案盡在本文之中，
正文
插件擴展
1. Interceptor核心實作原理
熟悉Mybatis配置的都知道，在xml配置中我們可以配置如下節點：
<plugins>
<plugin interceptor="org.apache.ibatis.builder.ExamplePlugin">
<property name="pluginProperty" value="https://www.cnblogs.com/yewy/p/100"/>
</plugin>
</plugins>
這個就是插件的配置，那么自然而然的這個節點就會在決議xml的時候進行決議，并將其添加到Configuration中，細心的讀者應該還記得下面這段代碼，在XMLConfigBuilderl類中：
private void parseConfiguration(XNode root) {
try {
//issue #117 read properties first
//決議<properties>節點
propertiesElement(root.evalNode("properties"));
//決議<settings>節點
Properties settings = settingsAsProperties(root.evalNode("settings"));
loadCustomVfs(settings);
//決議<typeAliases>節點
typeAliasesElement(root.evalNode("typeAliases"));
//決議<plugins>節點
pluginElement(root.evalNode("plugins"));
//決議<objectFactory>節點
objectFactoryElement(root.evalNode("objectFactory"));
//決議<objectWrapperFactory>節點
objectWrapperFactoryElement(root.evalNode("objectWrapperFactory"));
//決議<reflectorFactory>節點
reflectorFactoryElement(root.evalNode("reflectorFactory"));
settingsElement(settings);//將settings填充到configuration
// read it after objectFactory and objectWrapperFactory issue #631
//決議<environments>節點
environmentsElement(root.evalNode("environments"));
//決議<databaseIdProvider>節點
databaseIdProviderElement(root.evalNode("databaseIdProvider"));
//決議<typeHandlers>節點
typeHandlerElement(root.evalNode("typeHandlers"));
//決議<mappers>節點
mapperElement(root.evalNode("mappers"));
} catch (Exception e) {
throw new BuilderException("Error parsing SQL Mapper Configuration. Cause: " + e, e);
}
}
其中pluginElement就是決議插件節點的：
private void pluginElement(XNode parent) throws Exception {
if (parent != null) {
//遍歷所有的插件配置
for (XNode child : parent.getChildren()) {
//獲取插件的類名
String interceptor = child.getStringAttribute("interceptor");
//獲取插件的配置
Properties properties = child.getChildrenAsProperties();
//實體化插件物件
Interceptor interceptorInstance = (Interceptor) resolveClass(interceptor).newInstance();
//設定插件屬性
interceptorInstance.setProperties(properties);
//將插件添加到configuration物件，底層使用list保存所有的插件并記錄順序
configuration.addInterceptor(interceptorInstance);
}
}
}
從上面可以看到，就是根據配置實體化為Interceptor物件，并添加到InterceptorChain中，該類的物件被Configuration持有，Interceptor包含三個方法：
//執行攔截邏輯的方法
Object intercept(Invocation invocation) throws Throwable;
//target是被攔截的物件，它的作用就是給被攔截的物件生成一個代理物件
Object plugin(Object target);
//讀取在plugin中設定的引數
void setProperties(Properties properties);
而InterceptorChain只是保存了所有的Interceptor，并提供方法給客戶端呼叫，使得所有的Interceptor生成代理物件：
public class InterceptorChain {
private final List<Interceptor> interceptors = new ArrayList<>();
public Object pluginAll(Object target) {
for (Interceptor interceptor : interceptors) {
target = interceptor.plugin(target);
}
return target;
}
public void addInterceptor(Interceptor interceptor) {
interceptors.add(interceptor);
}
public List<Interceptor> getInterceptors() {
return Collections.unmodifiableList(interceptors);
}
}
可以看到pluginAll就是回圈去呼叫了Interceptor的plugin方法，而該方法的實作一般是通過Plugin.wrap去生成代理物件：
public static Object wrap(Object target, Interceptor interceptor) {
//決議Interceptor上@Intercepts注解得到的signature資訊
Map<Class<?>, Set<Method>> signatureMap = getSignatureMap(interceptor);
Class<?> type = target.getClass();//獲取目標物件的型別
Class<?>[] interfaces = getAllInterfaces(type, signatureMap);//獲取目標物件實作的介面
if (interfaces.length > 0) {
//使用jdk的方式創建動態代理
return Proxy.newProxyInstance(
type.getClassLoader(),
interfaces,
new Plugin(target, interceptor, signatureMap));
}
return target;
}
其中getSignatureMap就是將@Intercepts注解中的value值決議并快取起來，該注解的值是@Signature型別的陣列，而這個注解可以定義class型別、方法、引數，即攔截器的定位，而getAllInterfaces就是獲取要被代理的介面，然后通過JDK動態代理創建代理物件，可以看到InvocationHandler就是Plugin類，所以直接看invoke方法，最終就是呼叫interceptor.intercept方法：
public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
try {
//獲取當前介面可以被攔截的方法
Set<Method> methods = signatureMap.get(method.getDeclaringClass());
if (methods != null && methods.contains(method)) {//如果當前方法需要被攔截，則呼叫interceptor.intercept方法進行攔截處理
return interceptor.intercept(new Invocation(target, method, args));
}
//如果當前方法不需要被攔截，則呼叫物件自身的方法
return method.invoke(target, args);
} catch (Exception e) {
throw ExceptionUtil.unwrapThrowable(e);
}
}
這里的插件實作思路是通用的，即這個interceptor我們可以用來擴展任何物件的任何方法，比如對Map的get進行攔截，可像下面這樣實作：
@Intercepts({
@Signature(type = Map.class, method = "get", args = {Object.class})})
public static class AlwaysMapPlugin implements Interceptor {
@Override
public Object intercept(Invocation invocation) throws Throwable {
return "Always";
}
@Override
public Object plugin(Object target) {
return Plugin.wrap(target, this);
}
@Override
public void setProperties(Properties properties) {
}
}
然后在使用Map時先用插件對其包裝，這樣拿到的就是Map的代理物件，
Map map = new HashMap();
map = (Map) new AlwaysMapPlugin().plugin(map);
2. Mybatis的攔截增強
因為我們可以對Mybatis擴展任意多個的插件，所以它使用InterceptorChain物件來保存所有的插件，這是責任鏈模式的實作，那么Mybatis到底會攔截哪些物件和哪些方法呢？回憶上篇文章我們就可以發現Mybatis只會對以下4個物件進行攔截：
- Executor：
public Executor newExecutor(Transaction transaction, ExecutorType executorType) {
......省略
//通過interceptorChain遍歷所有的插件為executor增強，添加插件的功能
executor = (Executor) interceptorChain.pluginAll(executor);
return executor;
}
- StatementHandler
public StatementHandler newStatementHandler(Executor executor, MappedStatement mappedStatement, Object parameterObject, RowBounds rowBounds, ResultHandler resultHandler, BoundSql boundSql) {
//創建RoutingStatementHandler物件，實際由statmentType來指定真實的StatementHandler來實作
StatementHandler statementHandler = new RoutingStatementHandler(executor, mappedStatement, parameterObject, rowBounds, resultHandler, boundSql);
statementHandler = (StatementHandler) interceptorChain.pluginAll(statementHandler);
return statementHandler;
}
- ParameterHandler
public ParameterHandler newParameterHandler(MappedStatement mappedStatement, Object parameterObject, BoundSql boundSql) {
ParameterHandler parameterHandler = mappedStatement.getLang().createParameterHandler(mappedStatement, parameterObject, boundSql);
parameterHandler = (ParameterHandler) interceptorChain.pluginAll(parameterHandler);
return parameterHandler;
}
- ResultSetHandler
public ResultSetHandler newResultSetHandler(Executor executor, MappedStatement mappedStatement, RowBounds rowBounds, ParameterHandler parameterHandler,
ResultHandler resultHandler, BoundSql boundSql) {
ResultSetHandler resultSetHandler = new DefaultResultSetHandler(executor, mappedStatement, parameterHandler, resultHandler, boundSql, rowBounds);
resultSetHandler = (ResultSetHandler) interceptorChain.pluginAll(resultSetHandler);
return resultSetHandler;
}
而具體要攔截哪些物件和哪些方法則是由@Intercepts和@Signature指定的，
以上就是Mybatis擴展插件的實作機制，讀者可據此自行分析下PageHelper的實作原理，另外需要注意，我們在進行自定義插件開發時，尤其要謹慎，因為直接關系到操作資料庫，如果對插件的實作原理不透徹，很有可能引發難以估量的后果，
Mybatis與Spring整合原理
前面的示例都是單獨使用Mybatis，可以看到需要創建SqlSessionFactory和SqlSession物件，然后通過SqlSession去創建Mapper介面的代理物件，所以在與Spring整合時，顯而易見的，我們就需要考慮以下幾點：
- 什么時候創建以及怎么創建SqlSessionFactory和SqlSession？
- 什么時候創建以及怎么創建代理物件？
- 如何將Mybatis的代理物件注入到IOC容器中？
- Mybatis怎么保證和Spring在同一個事務中并且使用的是同一個連接？
那么如何實作以上幾點呢？下文基于mybatis-spring-1.3.3版本分析，
1. SqlSessionFactory的創建
熟悉Spring原始碼的（如果不熟悉，可以閱讀我之前的Spring系列原始碼）都知道Spring最重要的那些擴展點：
- BeanDefinitionRegistryPostProcessor：Bean實體化前呼叫
- BeanFactoryPostProcessor：Bean實體化前呼叫
- InitializingBean：Bean實體化后呼叫
- FactoryBean：實作該介面代替Spring管理一些特殊的Bean
其它還有很多，以上列舉出來的就是Mybatis集成Spring所用到的擴展點，首先我們需要實體化SqlSessionFactory，而實體化該物件在Mybatis里實際上就是去決議一大堆配置并封裝到該物件中，所以我們不能簡單的使用<bean>標簽來配置，為此Mybatis實作了一個類SqlSessionFactoryBean（這個類我們在以前使用整合包時都會配置），之前XML中的配置都以屬性的方式放入到了該類中：
<bean id="sqlSessionFactory" >
<property name="dataSource" ref="dataSource" />
<property name="typeAliasesPackage" value="https://www.cnblogs.com/yewy/p/com.enjoylearning.mybatis.entity" />
<property name="mapperLocations" value="https://www.cnblogs.com/yewy/p/classpath:sqlmapper/*.xml" />
</bean>
進入這個類，我們可以看到它實作了InitializingBean和FactoryBean介面，實作第一個介面的作用就是在該類實體化后立即去執行配置決議的階段：
public void afterPropertiesSet() throws Exception {
notNull(dataSource, "Property 'dataSource' is required");
notNull(sqlSessionFactoryBuilder, "Property 'sqlSessionFactoryBuilder' is required");
state((configuration == null && configLocation == null) || !(configuration != null && configLocation != null),
"Property 'configuration' and 'configLocation' can not specified with together");
this.sqlSessionFactory = buildSqlSessionFactory();
}
具體的決議就在buildSqlSessionFactory方法中，這個方法比較長，但不復雜，這里就不貼代碼了，而實作第二介面的作用就在于Spring獲取該類實體時實際上會通過getObject方法回傳SqlSessionFactory的實體，通過這兩個介面就完成了SqlSessionFactory的實體化，
2. 掃描Mapper并創建代理物件
在整合之后我們除了要配置SqlSessionFactoryBean外，還要配置一個類：
<bean >
<property name="basePackage" value="https://www.cnblogs.com/yewy/p/com.enjoylearning.mybatis.mapper" />
</bean>
這個類的作用就是用來掃描Mapper介面的，并且這個類實作了BeanDefinitionRegistryPostProcessor和InitializingBean，這里實作第二個介面的作用主要是校驗有沒有配置待掃描包的路徑：
public void afterPropertiesSet() throws Exception {
notNull(this.basePackage, "Property 'basePackage' is required");
}
主要看到postProcessBeanDefinitionRegistry方法：
public void postProcessBeanDefinitionRegistry(BeanDefinitionRegistry registry) {
if (this.processPropertyPlaceHolders) {
processPropertyPlaceHolders();
}
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);
scanner.registerFilters();
scanner.scan(StringUtils.tokenizeToStringArray(this.basePackage, ConfigurableApplicationContext.CONFIG_LOCATION_DELIMITERS));
}
這里創建了一個掃描類，而這個掃描類是繼承自Spring的ClassPathBeanDefinitionScanner，也就是會將掃描到的類封裝為BeanDefinition注冊到IOC容器中去：
public int scan(String... basePackages) {
int beanCountAtScanStart = this.registry.getBeanDefinitionCount();
doScan(basePackages);
// Register annotation config processors, if necessary.
if (this.includeAnnotationConfig) {
AnnotationConfigUtils.registerAnnotationConfigProcessors(this.registry);
}
return (this.registry.getBeanDefinitionCount() - beanCountAtScanStart);
}
public Set<BeanDefinitionHolder> doScan(String... basePackages) {
Set<BeanDefinitionHolder> beanDefinitions = super.doScan(basePackages);
if (beanDefinitions.isEmpty()) {
logger.warn("No MyBatis mapper was found in '" + Arrays.toString(basePackages) + "' package. Please check your configuration.");
} else {
processBeanDefinitions(beanDefinitions);
}
return beanDefinitions;
}
private void processBeanDefinitions(Set<BeanDefinitionHolder> beanDefinitions) {
GenericBeanDefinition definition;
for (BeanDefinitionHolder holder : beanDefinitions) {
definition = (GenericBeanDefinition) holder.getBeanDefinition();
if (logger.isDebugEnabled()) {
logger.debug("Creating MapperFactoryBean with name '" + holder.getBeanName()
+ "' and '" + definition.getBeanClassName() + "' mapperInterface");
}
// the mapper interface is the original class of the bean
// but, the actual class of the bean is MapperFactoryBean
definition.getConstructorArgumentValues().addGenericArgumentValue(definition.getBeanClassName()); // issue #59
definition.setBeanClass(this.mapperFactoryBean.getClass());
definition.getPropertyValues().add("addToConfig", this.addToConfig);
// 當指定了sqlSessionFactoryBeanName或sqlSessionFactory或sqlSessionTemplateBeanName或sqlSessionTemplate ，將其注入到mapperFactoryBean中
boolean explicitFactoryUsed = false;
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) {
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) {
logger.warn("Cannot use both: sqlSessionTemplate and sqlSessionFactory together. sqlSessionFactory is ignored.");
}
definition.getPropertyValues().add("sqlSessionTemplate", this.sqlSessionTemplate);
explicitFactoryUsed = true;
}
// 沒有指定時，則通過型別自動注入sqlSession
if (!explicitFactoryUsed) {
if (logger.isDebugEnabled()) {
logger.debug("Enabling autowire by type for MapperFactoryBean with name '" + holder.getBeanName() + "'.");
}
definition.setAutowireMode(AbstractBeanDefinition.AUTOWIRE_BY_TYPE);
}
}
}
你可能會好奇，在哪里生成的代理物件？只是將Mapper介面注入到IOC有什么用呢？其實關鍵代碼就在definition.setBeanClass(this.mapperFactoryBean.getClass())，這句代碼的作用就是將每一個Mapper介面都轉為MapperFactoryBean型別，
為什么要這么轉呢？進入這個類你會發現它也是實作了FactoryBean介面的，所以自然而然的又是利用它來創建代理實作類物件：
public T getObject() throws Exception {
return getSqlSession().getMapper(this.mapperInterface);
}
3. 如何整合Spring事務
Mybatis作為一個ORM框架，它是有自己的資料源和事務控制的，而Spring同樣也會配置這兩個，那么怎么將它們整合到一起呢？而不是在Service類呼叫Mapper介面時就切換了資料源和連接，那樣肯定是不行的，
在使用Mybatis時，我們可以在xml中配置TransactionFactory事務工廠類，不過一般都會使用默認的JdbcTransactionFactory，而當與Spring整合后，默認的事務工廠類改為了SpringManagedTransactionFactory，回到SqlSessionFactoryBean讀取配置的方法，在該方法中有下面這樣一段代碼：
if (this.transactionFactory == null) {
this.transactionFactory = new SpringManagedTransactionFactory();
}
configuration.setEnvironment(new Environment(this.environment, this.transactionFactory, this.dataSource));
上面默認創建了SpringManagedTransactionFactory，同時還將我們xml中ref屬性參考的dataSource添加到了Configuration中，這個工廠會創建下面這個事務控制物件：
public Transaction newTransaction(DataSource dataSource, TransactionIsolationLevel level, boolean autoCommit) {
return new SpringManagedTransaction(dataSource);
}
而這個方法是在DefaultSqlSessionFactory獲取SqlSession時會呼叫：
private SqlSession openSessionFromDataSource(ExecutorType execType, TransactionIsolationLevel level, boolean autoCommit) {
Transaction tx = null;
try {
final Environment environment = configuration.getEnvironment();
final TransactionFactory transactionFactory = getTransactionFactoryFromEnvironment(environment);
tx = transactionFactory.newTransaction(environment.getDataSource(), level, autoCommit);
final Executor executor = configuration.newExecutor(tx, execType);
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();
}
}
這就保證使用的是同一個資料源物件，但是怎么保證拿到的是同一個連接和事務呢？關鍵就在于SpringManagedTransaction獲取連接是怎么實作的：
public Connection getConnection() throws SQLException {
if (this.connection == null) {
openConnection();
}
return this.connection;
}
private void openConnection() throws SQLException {
this.connection = DataSourceUtils.getConnection(this.dataSource);
this.autoCommit = this.connection.getAutoCommit();
this.isConnectionTransactional = DataSourceUtils.isConnectionTransactional(this.connection, this.dataSource);
if (LOGGER.isDebugEnabled()) {
LOGGER.debug(
"JDBC Connection ["
+ this.connection
+ "] will"
+ (this.isConnectionTransactional ? " " : " not ")
+ "be managed by Spring");
}
}
這里委托給了DataSourceUtils獲取連接：
public static Connection getConnection(DataSource dataSource) throws CannotGetJdbcConnectionException {
try {
return doGetConnection(dataSource);
}
catch (SQLException ex) {
throw new CannotGetJdbcConnectionException("Could not get JDBC Connection", ex);
}
}
public static Connection doGetConnection(DataSource dataSource) throws SQLException {
Assert.notNull(dataSource, "No DataSource specified");
ConnectionHolder conHolder = (ConnectionHolder) TransactionSynchronizationManager.getResource(dataSource);
if (conHolder != null && (conHolder.hasConnection() || conHolder.isSynchronizedWithTransaction())) {
conHolder.requested();
if (!conHolder.hasConnection()) {
logger.debug("Fetching resumed JDBC Connection from DataSource");
conHolder.setConnection(dataSource.getConnection());
}
return conHolder.getConnection();
}
// Else we either got no holder or an empty thread-bound holder here.
logger.debug("Fetching JDBC Connection from DataSource");
Connection con = dataSource.getConnection();
if (TransactionSynchronizationManager.isSynchronizationActive()) {
logger.debug("Registering transaction synchronization for JDBC Connection");
// Use same Connection for further JDBC actions within the transaction.
// Thread-bound object will get removed by synchronization at transaction completion.
ConnectionHolder holderToUse = conHolder;
if (holderToUse == null) {
holderToUse = new ConnectionHolder(con);
}
else {
holderToUse.setConnection(con);
}
holderToUse.requested();
TransactionSynchronizationManager.registerSynchronization(
new ConnectionSynchronization(holderToUse, dataSource));
holderToUse.setSynchronizedWithTransaction(true);
if (holderToUse != conHolder) {
TransactionSynchronizationManager.bindResource(dataSource, holderToUse);
}
}
return con;
}
看到ConnectionHolder conHolder = (ConnectionHolder) TransactionSynchronizationManager.getResource(dataSource)這段代碼相信熟悉Spring原始碼的已經知道了，這個我在分析Spring事務原始碼時也講過，通過DataSource物件拿到當前執行緒系結的ConnectionHolder，這個物件是在Spring開啟事務的時候存進去的，至此，關于Spring和Mybatis的整合原理我們就個搞清楚了，至于和SpringBoot的整合，讀者可自行分析，最后，我再分享一個小擴展知識，
4. FactoryBean的擴展知識
很多讀者可能不知道這個介面有什么作用，其實很簡單，當我們有某個類由Spring實體化比較復雜，想要自己控制它的實體化時，就可以實作該介面，而實作該介面的類首先會被實體化并放入一級快取，而當我們依賴注入我們真正想要的類時（如Mapper介面的代理類），就會從一級快取中拿到FactoryBean實作類的實體，并判斷是否實作了FactoryBean介面，如果是就會呼叫getObject方法回傳我們真正想要的實體，
那如果我們確實想要拿到的就是FactoryBean實作類的實體該怎么辦呢？只需要在傳入的beanName前面加上“&”符號即可，
總結
本篇分析了Mybatis如何擴展插件以及插件的實作原理，但如非必要，切忌擴展插件，如果一定要，那么一定要非常謹慎，另外還結合Spirng的擴展點分析了Mybatis和Spring的整合原理，解決了困在我心中已久的一些疑惑，相信那也是大多數讀者的疑惑，好好領悟這部分內容非常有利于我們自己對Spring進行擴展，
轉載請註明出處，本文鏈接：https://www.uj5u.com/houduan/147235.html
標籤：Java
下一篇：擴展賦值運算子基本用法及注意事項