https://www.cnblogs.com/fangjian0423/p/mybatis-interceptor.html
PageHelper插件的原理和下面文章差不多屈张，主要就是把Executor做代理骗露，改變sql去查詢
MyBatis提供了一種插件(plugin)的功能填硕，雖然叫做插件，但其實(shí)這是攔截器功能距贷。那么攔截器攔截MyBatis中的哪些內(nèi)容呢？
我們進(jìn)入官網(wǎng)看一看：
MyBatis 允許你在已映射語(yǔ)句執(zhí)行過(guò)程中的某一點(diǎn)進(jìn)行攔截調(diào)用。默認(rèn)情況下计技，MyBatis 允許使用插件來(lái)攔截的方法調(diào)用包括：
- Executor (update, query, flushStatements, commit, rollback, getTransaction, close, isClosed)
- ParameterHandler (getParameterObject, setParameters)
- ResultSetHandler (handleResultSets, handleOutputParameters)
- StatementHandler (prepare, parameterize, batch, update, query)
我們看到了可以攔截Executor接口的部分方法，比如update山橄，query垮媒，commit，rollback等方法，還有其他接口的一些方法等涣澡。
總體概括為：
- 攔截執(zhí)行器的方法
- 攔截參數(shù)的處理
- 攔截結(jié)果集的處理
- 攔截Sql語(yǔ)法構(gòu)建的處理
攔截器的使用
攔截器介紹及配置
首先我們看下MyBatis攔截器的接口定義：
public interface Interceptor {
Object intercept(Invocation invocation) throws Throwable;
Object plugin(Object target);
void setProperties(Properties properties);
}
比較簡(jiǎn)單贱呐，只有3個(gè)方法。 MyBatis默認(rèn)沒有一個(gè)攔截器接口的實(shí)現(xiàn)類入桂，開發(fā)者們可以實(shí)現(xiàn)符合自己需求的攔截器奄薇。
下面的MyBatis官網(wǎng)的一個(gè)攔截器實(shí)例：
@Intercepts({@Signature(
type= Executor.class,
method = "update",
args = {MappedStatement.class,Object.class})})
public class ExamplePlugin implements Interceptor {
public Object intercept(Invocation invocation) throws Throwable {
return invocation.proceed();
}
public Object plugin(Object target) {
return Plugin.wrap(target, this);
}
public void setProperties(Properties properties) {
}
}
全局xml配置：
<plugins>
<plugin interceptor="org.format.mybatis.cache.interceptor.ExamplePlugin"></plugin>
</plugins>
這個(gè)攔截器攔截Executor接口的update方法（其實(shí)也就是SqlSession的新增，刪除抗愁，修改操作）馁蒂，所有執(zhí)行executor的update方法都會(huì)被該攔截器攔截到。
源碼分析
下面我們分析一下這段代碼背后的源碼蜘腌。
首先從源頭->配置文件開始分析：
XMLConfigBuilder解析MyBatis全局配置文件的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.addInterceptor(interceptorInstance);
}
}
}
具體的解析代碼其實(shí)比較簡(jiǎn)單沫屡，就不貼了，主要就是通過(guò)反射實(shí)例化plugin節(jié)點(diǎn)中的interceptor屬性表示的類撮珠。然后調(diào)用全局配置類Configuration的addInterceptor方法沮脖。
public void addInterceptor(Interceptor interceptor) {
interceptorChain.addInterceptor(interceptor);
}
這個(gè)interceptorChain是Configuration的內(nèi)部屬性，類型為InterceptorChain芯急，也就是一個(gè)攔截器鏈勺届，我們來(lái)看下它的定義：
public class InterceptorChain {
private final List<Interceptor> interceptors = new ArrayList<Interceptor>();
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);
}
}
現(xiàn)在我們理解了攔截器配置的解析以及攔截器的歸屬，現(xiàn)在我們回過(guò)頭看下為何攔截器會(huì)攔截這些方法（Executor娶耍，ParameterHandler免姿，ResultSetHandler，StatementHandler的部分方法）：
public ParameterHandler newParameterHandler(MappedStatement mappedStatement, Object parameterObject, BoundSql boundSql) {
ParameterHandler parameterHandler = mappedStatement.getLang().createParameterHandler(mappedStatement, parameterObject, boundSql);
parameterHandler = (ParameterHandler) interceptorChain.pluginAll(parameterHandler);
return parameterHandler;
}
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;
}
public StatementHandler newStatementHandler(Executor executor, MappedStatement mappedStatement, Object parameterObject, RowBounds rowBounds, ResultHandler resultHandler, BoundSql boundSql) {
StatementHandler statementHandler = new RoutingStatementHandler(executor, mappedStatement, parameterObject, rowBounds, resultHandler, boundSql);
statementHandler = (StatementHandler) interceptorChain.pluginAll(statementHandler);
return statementHandler;
}
public Executor newExecutor(Transaction transaction, ExecutorType executorType, boolean autoCommit) {
executorType = executorType == null ? defaultExecutorType : executorType;
executorType = executorType == null ? ExecutorType.SIMPLE : executorType;
Executor executor;
if (ExecutorType.BATCH == executorType) {
executor = new BatchExecutor(this, transaction);
} else if (ExecutorType.REUSE == executorType) {
executor = new ReuseExecutor(this, transaction);
} else {
executor = new SimpleExecutor(this, transaction);
}
if (cacheEnabled) {
executor = new CachingExecutor(executor, autoCommit);
}
executor = (Executor) interceptorChain.pluginAll(executor);
return executor;
}
以上4個(gè)方法都是Configuration的方法榕酒。這些方法在MyBatis的一個(gè)操作(新增胚膊，刪除，修改想鹰，查詢)中都會(huì)被執(zhí)行到紊婉，執(zhí)行的先后順序是Executor，ParameterHandler辑舷，ResultSetHandler喻犁，StatementHandler(其中ParameterHandler和ResultSetHandler的創(chuàng)建是在創(chuàng)建StatementHandler[3個(gè)可用的實(shí)現(xiàn)類CallableStatementHandler,PreparedStatementHandler,SimpleStatementHandler]的時(shí)候，其構(gòu)造函數(shù)調(diào)用的[這3個(gè)實(shí)現(xiàn)類的構(gòu)造函數(shù)其實(shí)都調(diào)用了父類BaseStatementHandler的構(gòu)造函數(shù)])惩妇。
這4個(gè)方法實(shí)例化了對(duì)應(yīng)的對(duì)象之后株汉，都會(huì)調(diào)用interceptorChain的pluginAll方法，InterceptorChain的pluginAll剛才已經(jīng)介紹過(guò)了歌殃，就是遍歷所有的攔截器乔妈，然后調(diào)用各個(gè)攔截器的plugin方法。注意：攔截器的plugin方法的返回值會(huì)直接被賦值給原先的對(duì)象
由于可以攔截StatementHandler氓皱，這個(gè)接口主要處理sql語(yǔ)法的構(gòu)建路召，因此比如分頁(yè)的功能勃刨，可以用攔截器實(shí)現(xiàn)，只需要在攔截器的plugin方法中處理StatementHandler接口實(shí)現(xiàn)類中的sql即可股淡，可使用反射實(shí)現(xiàn)身隐。
MyBatis還提供了 @Intercepts和 @Signature關(guān)于攔截器的注解。官網(wǎng)的例子就是使用了這2個(gè)注解唯灵，還包括了Plugin類的使用：
@Override
public Object plugin(Object target) {
return Plugin.wrap(target, this);
}
下面我們就分析這3個(gè) "新組合" 的源碼贾铝，首先先看Plugin類的wrap方法：
public static Object wrap(Object target, Interceptor interceptor) {
Map<Class<?>, Set<Method>> signatureMap = getSignatureMap(interceptor);
Class<?> type = target.getClass();
Class<?>[] interfaces = getAllInterfaces(type, signatureMap);
if (interfaces.length > 0) {
return Proxy.newProxyInstance(
type.getClassLoader(),
interfaces,
new Plugin(target, interceptor, signatureMap));
}
return target;
}
Plugin類實(shí)現(xiàn)了InvocationHandler接口，很明顯埠帕，我們看到這里返回了一個(gè)JDK自身提供的動(dòng)態(tài)代理類垢揩。我們解剖一下這個(gè)方法調(diào)用的其他方法：
getSignatureMap方法：
private static Map<Class<?>, Set<Method>> getSignatureMap(Interceptor interceptor) {
Intercepts interceptsAnnotation = interceptor.getClass().getAnnotation(Intercepts.class);
if (interceptsAnnotation == null) { // issue #251
throw new PluginException("No @Intercepts annotation was found in interceptor " + interceptor.getClass().getName());
}
Signature[] sigs = interceptsAnnotation.value();
Map<Class<?>, Set<Method>> signatureMap = new HashMap<Class<?>, Set<Method>>();
for (Signature sig : sigs) {
Set<Method> methods = signatureMap.get(sig.type());
if (methods == null) {
methods = new HashSet<Method>();
signatureMap.put(sig.type(), methods);
}
try {
Method method = sig.type().getMethod(sig.method(), sig.args());
methods.add(method);
} catch (NoSuchMethodException e) {
throw new PluginException("Could not find method on " + sig.type() + " named " + sig.method() + ". Cause: " + e, e);
}
}
return signatureMap;
}
getSignatureMap方法解釋：首先會(huì)拿到攔截器這個(gè)類的 @Interceptors注解凿可，然后拿到這個(gè)注解的屬性 @Signature注解集合硫惕，然后遍歷這個(gè)集合，遍歷的時(shí)候拿出 @Signature注解的type屬性(Class類型)吞杭，然后根據(jù)這個(gè)type得到帶有method屬性和args屬性的Method呐籽。由于 @Interceptors注解的 @Signature屬性是一個(gè)屬性锋勺，所以最終會(huì)返回一個(gè)以type為key，value為Set<Method>的Map狡蝶。
@Intercepts({@Signature(
type= Executor.class,
method = "update",
args = {MappedStatement.class,Object.class})})
比如這個(gè) @Interceptors注解會(huì)返回一個(gè)key為Executor庶橱，value為集合(這個(gè)集合只有一個(gè)元素，也就是Method實(shí)例牢酵，這個(gè)Method實(shí)例就是Executor接口的update方法悬包，且這個(gè)方法帶有MappedStatement和Object類型的參數(shù))衙猪。這個(gè)Method實(shí)例是根據(jù) @Signature的method和args屬性得到的馍乙。如果args參數(shù)跟type類型的method方法對(duì)應(yīng)不上，那么將會(huì)拋出異常垫释。
getAllInterfaces方法：
private static Class<?>[] getAllInterfaces(Class<?> type, Map<Class<?>, Set<Method>> signatureMap) {
Set<Class<?>> interfaces = new HashSet<Class<?>>();
while (type != null) {
for (Class<?> c : type.getInterfaces()) {
if (signatureMap.containsKey(c)) {
interfaces.add(c);
}
}
type = type.getSuperclass();
}
return interfaces.toArray(new Class<?>[interfaces.size()]);
}
getAllInterfaces方法解釋：根據(jù)目標(biāo)實(shí)例target(這個(gè)target就是之前所說(shuō)的MyBatis攔截器可以攔截的類丝格，Executor,ParameterHandler,ResultSetHandler,StatementHandler)和它的父類們，返回signatureMap中含有target實(shí)現(xiàn)的接口數(shù)組棵譬。
所以Plugin這個(gè)類的作用就是根據(jù) @Interceptors注解显蝌，得到這個(gè)注解的屬性 @Signature數(shù)組，然后根據(jù)每個(gè) @Signature注解的type订咸，method曼尊，args屬性使用反射找到對(duì)應(yīng)的Method。最終根據(jù)調(diào)用的target對(duì)象實(shí)現(xiàn)的接口決定是否返回一個(gè)代理對(duì)象替代原先的target對(duì)象脏嚷。
比如MyBatis官網(wǎng)的例子骆撇，當(dāng)Configuration調(diào)用newExecutor方法的時(shí)候，由于Executor接口的update(MappedStatement ms, Object parameter)方法被攔截器被截獲父叙。因此最終返回的是一個(gè)代理類Plugin神郊，而不是Executor肴裙。這樣調(diào)用方法的時(shí)候，如果是個(gè)代理類涌乳，那么會(huì)執(zhí)行：
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)) {
return interceptor.intercept(new Invocation(target, method, args));
}
return method.invoke(target, args);
} catch (Exception e) {
throw ExceptionUtil.unwrapThrowable(e);
}
}
沒錯(cuò)蜻懦，如果找到對(duì)應(yīng)的方法被代理之后，那么會(huì)執(zhí)行Interceptor接口的interceptor方法夕晓。
這個(gè)Invocation類如下：
public class Invocation {
private Object target;
private Method method;
private Object[] args;
public Invocation(Object target, Method method, Object[] args) {
this.target = target;
this.method = method;
this.args = args;
}
public Object getTarget() {
return target;
}
public Method getMethod() {
return method;
}
public Object[] getArgs() {
return args;
}
public Object proceed() throws InvocationTargetException, IllegalAccessException {
return method.invoke(target, args);
}
}
它的proceed方法也就是調(diào)用原先方法(不走代理)宛乃。
總結(jié)
MyBatis攔截器接口提供的3個(gè)方法中，plugin方法用于某些處理器(Handler)的構(gòu)建過(guò)程蒸辆。interceptor方法用于處理代理類的執(zhí)行烤惊。setProperties方法用于攔截器屬性的設(shè)置。
其實(shí)MyBatis官網(wǎng)提供的使用 @Interceptors和 @Signature注解以及Plugin類這樣處理攔截器的方法吁朦，我們不一定要直接這樣使用柒室。我們也可以拋棄這3個(gè)類，直接在plugin方法內(nèi)部根據(jù)target實(shí)例的類型做相應(yīng)的操作逗宜。
總體來(lái)說(shuō)MyBatis攔截器還是很簡(jiǎn)單的雄右，攔截器本身不需要太多的知識(shí)點(diǎn)，但是學(xué)習(xí)攔截器需要對(duì)MyBatis中的各個(gè)接口很熟悉纺讲，因?yàn)閿r截器涉及到了各個(gè)接口的知識(shí)點(diǎn)擂仍。
