1.需求背景
設(shè)定訂單表order慧库，要根據(jù)訂單類型統(tǒng)計(jì)訂單數(shù)據(jù)齐板，大致sql如下：
select order_type , count(1) as order_num from order group by order_type;
Mybatis無法將以上sql以指定key:order_type;value:order_num存入至map中葛菇。
而Mybatis默認(rèn)返回的List<Map<String, Object>>眯停，是以每個(gè)字段name作為key莺债，字段的值作為value齐邦，放入至Map<String,Object>的List數(shù)組。
因此自定義一種可以指定key我纪、value字段的Mybatis插件將非常有用璧诵。
2.實(shí)現(xiàn)
在實(shí)現(xiàn)這個(gè)插件之前仇冯，我們先了解下Mybatis攔截器苛坚。
詳見Mybatis攔截器介紹及分頁插件
攔截器：我們可以攔截某些方法的調(diào)用，我們可以選擇在這些被攔截的方法執(zhí)行前后加上某些邏輯等缀，也可以在執(zhí)行這些被攔截的方法時(shí)執(zhí)行自己的邏輯而不再執(zhí)行被攔截的方法。
Mybatis攔截器：就是為了供用戶在某些時(shí)候可以實(shí)現(xiàn)自己的邏輯而不必去動(dòng)Mybatis固有的邏輯冒掌。
2.1 Mybatis 提供的Interceptor接口
public interface Interceptor {
Object intercept(Invocation invocation) throws Throwable;
Object plugin(Object target);
void setProperties(Properties properties);
}
Interceptor接口提供三個(gè)方法：
plugin方法是攔截器用于封裝目標(biāo)對(duì)象的噪裕，通過該方法我們可以返回目標(biāo)對(duì)象本身，也可以返回一個(gè)它的代理股毫。當(dāng)返回的是代理的時(shí)候我們可以對(duì)其中的方法進(jìn)行攔截來調(diào)用intercept方法膳音，當(dāng)然也可以調(diào)用其他方法，這點(diǎn)將在后文講解铃诬。setProperties方法是用于在Mybatis配置文件中指定一些屬性的祭陷。
定義自己的Interceptor最重要的是要實(shí)現(xiàn)plugin方法和intercept方法，在plugin方法中我們可以決定是否要進(jìn)行攔截進(jìn)而決定要返回一個(gè)什么樣的目標(biāo)對(duì)象趣席。而intercept方法就是要進(jìn)行攔截的時(shí)候要執(zhí)行的方法兵志。
對(duì)于plugin方法而言，其實(shí)Mybatis已經(jīng)為我們提供了一個(gè)實(shí)現(xiàn)吩坝。Mybatis中有一個(gè)叫做Plugin的類毒姨，里面有一個(gè)靜態(tài)方法wrap(Object target,Interceptor interceptor)，通過該方法可以決定要返回的對(duì)象是目標(biāo)對(duì)象還是對(duì)應(yīng)的代理弧呐。
先看下Plugin類源碼：
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;
}
@Overridepublic 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);
}
}
我們先看一下Plugin的wrap方法鸠蚪，它根據(jù)當(dāng)前的Interceptor上面的注解定義哪些接口需要攔截，然后判斷當(dāng)前目標(biāo)對(duì)象是否有實(shí)現(xiàn)對(duì)應(yīng)需要攔截的接口妖谴，如果沒有則返回目標(biāo)對(duì)象本身，如果有則返回一個(gè)代理對(duì)象仍稀。而這個(gè)代理對(duì)象的InvocationHandler正是一個(gè)Plugin耿芹。所以當(dāng)目標(biāo)對(duì)象在執(zhí)行接口方法時(shí)砸彬，如果是通過代理對(duì)象執(zhí)行的，則會(huì)調(diào)用對(duì)應(yīng)InvocationHandler的invoke方法，也就是Plugin的invoke方法滋迈。所以接著我們來看一下該invoke方法的內(nèi)容帝美。這里invoke方法的邏輯是：如果當(dāng)前執(zhí)行的方法是定義好的需要攔截的方法舞箍，則把目標(biāo)對(duì)象墙基、要執(zhí)行的方法以及方法參數(shù)封裝成一個(gè)Invocation對(duì)象，再把封裝好的Invocation作為參數(shù)傳遞給當(dāng)前攔截器的intercept方法颗祝。如果不需要攔截，則直接調(diào)用當(dāng)前的方法。Invocation中定義了定義了一個(gè)proceed方法，其邏輯就是調(diào)用當(dāng)前方法，所以如果在intercept中需要繼續(xù)調(diào)用當(dāng)前方法的話可以調(diào)用invocation的procced方法。
這就是Mybatis中實(shí)現(xiàn)Interceptor攔截的一個(gè)思想伶贰，如果用戶覺得這個(gè)思想有問題或者不能完全滿足你的要求的話可以通過實(shí)現(xiàn)自己的Plugin來決定什么時(shí)候需要代理什么時(shí)候需要攔截们豌。以下講解的內(nèi)容都是基于Mybatis的默認(rèn)實(shí)現(xiàn)即通過Plugin來管理Interceptor來講解的。
兩個(gè)重要注解：@Intercepts和@Signature，@Intercepts用于表示當(dāng)前對(duì)象是Interceptor攔截器，@Signature用于展示需要攔截的接口我注、方法和參數(shù)奔缠。
eg：
@Intercepts(@Signature(method="handleResultSets",type=ResultSetHandler.class,args={Statement.class}))
2.2注冊(cè)攔截器
注冊(cè)攔截器是通過在Mybatis配置文件中plugins元素下的plugin元素來進(jìn)行的。一個(gè)plugin對(duì)應(yīng)著一個(gè)攔截器氛堕，在plugin元素下面我們可以指定若干個(gè)property子元素帮寻。Mybatis在注冊(cè)定義的攔截器時(shí)會(huì)先把對(duì)應(yīng)攔截器下面的所有property通過Interceptor的setProperties方法注入給對(duì)應(yīng)的攔截器惜傲。
<property name="plugins">
<array>
<bean class="com.test.admin.common.dal.common.interceptor.MapInterceptor"/>
</array>
</property>
