Mybatis源碼分析之插件模塊

更新時(shí)間：2021年06月16日 14:22:23 作者：IT_小白鼠

今天給大家?guī)?lái)的是關(guān)于Mybatis的相關(guān)知識(shí),文章圍繞著Mybatis插件模塊展開(kāi),文中有非常詳細(xì)的介紹及代碼示例,需要的朋友可以參考下

Mybatis插件模塊

插件這個(gè)東西一般用的比較少，就算用的多的插件也算是PageHelper分頁(yè)插件；

PageHelper官網(wǎng)：https://github.com/pagehelper/Mybatis-PageHelper/blob/master/README_zh.md

官網(wǎng)上這個(gè)也有談到Mybatis的插件流程分析。

使用示例

插件類

記錄SQL執(zhí)行的時(shí)間，

1、在JDK8之前必須實(shí)現(xiàn)Interceptor接口中的三個(gè)方法，在JDK8之后只需要實(shí)現(xiàn)intercept方法即可；

2、加上@Intercepts注解，并且附加上需攔截的類型以及方法@Signature：

type:插入的類，即指定的四個(gè)類型；

method:攔截插入類的方法；

args:攔截插入類方法的參數(shù)類型，按順序。

3、實(shí)現(xiàn)的plugin方法，必須執(zhí)行Plugin.wrap(target, this)；JDK8之后在接口中寫(xiě)了默認(rèn)方法。

@Intercepts({
	@Signature(type = StatementHandler.class, method = "query", args = { Statement.class, ResultHandler.class })
})
public class ThresHolderPlugin implements Interceptor {
 
	int threshold = 0;
	
	public Object intercept(Invocation invocation) throws Throwable {
		long start = System.currentTimeMillis();
		Object proceed = invocation.proceed();
		long end = System.currentTimeMillis();
		
		System.out.println("select time: " + (end-start) + "ms");
		
		return proceed;
	}
 
	public Object plugin(Object target) {
		return Plugin.wrap(target, this);
	}
 
	public void setProperties(Properties properties) {
		this.threshold = Integer.valueOf(properties.getProperty("value"));
		System.out.println("threshold :" + threshold);
	}
 
}

配置文件

<plugins>
		<plugin interceptor="com.test.mybatis.MybatisTest.official.plugin.ThresHolderPlugin">
            //數(shù)據(jù)會(huì)傳輸?shù)讲寮惖腜roperties
			<property name="value" value="10"></property>
		</plugin>
	</plugins>

設(shè)計(jì)模式

責(zé)任鏈模式（Chain of Responsibility Pattern）

為請(qǐng)求創(chuàng)建了一個(gè)接收者對(duì)象的鏈。這種模式給予請(qǐng)求的類型，對(duì)請(qǐng)求的發(fā)送者和接收者進(jìn)行解耦。這種類型的設(shè)計(jì)模式屬于行為型模式。

在這種模式中，通常每個(gè)接收者都包含對(duì)另一個(gè)接收者的引用。如果一個(gè)對(duì)象不能處理該請(qǐng)求，那么它會(huì)把相同的請(qǐng)求傳給下一個(gè)接收者，依此類推。

責(zé)任鏈模式優(yōu)點(diǎn):

降低耦合度。它將請(qǐng)求的發(fā)送者和接收者解耦。

簡(jiǎn)化了對(duì)象。使得對(duì)象不需要知道鏈的結(jié)構(gòu)。

增強(qiáng)給對(duì)象指派職責(zé)的靈活性。通過(guò)改變鏈內(nèi) 的成員或者調(diào)動(dòng)它們的次序，允許動(dòng)態(tài)地新增或者刪除責(zé)任。

增加新的請(qǐng)求處理類很方便。

UML:

Handler：定義了一個(gè)處理請(qǐng)求的標(biāo)準(zhǔn)接口；

ConcreteHandler：具體的處理者，處理它負(fù) 責(zé)的部分，根據(jù)業(yè)務(wù)可以結(jié)束處理流程，也可以將請(qǐng)求轉(zhuǎn)發(fā)給它的后繼者；

client ：發(fā)送者，發(fā)起請(qǐng)求的客戶端；

源碼分析

在之前談到Mybatis的核心流程分析中在加載Mybatis的配置文件的時(shí)候會(huì)把所有的插件加載帶Configuration對(duì)象中的InterceptorChain變量當(dāng)中，

如果有多個(gè)插件類的話，因?yàn)?strong>InterceptorChain類儲(chǔ)存插件類是有序集合，所以執(zhí)行插件的順序就是在xml配置插件的順序；

在Configuration類中：

這里有個(gè)CacheExecutor執(zhí)行器，當(dāng)開(kāi)啟了二級(jí)緩存的時(shí)候，就是選用緩存執(zhí)行器，使用是裝飾器模式將真正的執(zhí)行器包裝了一層。

我們現(xiàn)在看一下這個(gè)pluginAll方法：

使用動(dòng)態(tài)代理將真正的對(duì)象進(jìn)行增強(qiáng)；

在之前那個(gè)方法中，必須執(zhí)行Invocation的proceed()方法，這個(gè)方法就是執(zhí)行method.invoke()方法；

如果有多個(gè)插件的話，那么就會(huì)出現(xiàn)重復(fù)代理對(duì)象，那么重復(fù)代理對(duì)象的執(zhí)行的話，執(zhí)行過(guò)程如下：

這就是責(zé)任鏈模式，一層嵌套著一層。

在配置XML文件中配置：

<plugins>
	<plugin interceptor="com.test.mybatis.MybatisTest.official.plugin.ThresHolderPlugin">
		<property name="value" value="10"></property>
	</plugin>
	<plugin interceptor="com.test.mybatis.MybatisTest.official.plugin.ThresHolderPlugin2">
		<property name="value" value="20"></property>
	</plugin>
</plugins>

那么執(zhí)行的過(guò)程就是：