Mybatis 插件之自定義插件

1畸陡、前言

簡單的說吓懈,mybatis插件就是對ParameterHandler、ResultSetHandler季希、StatementHandler、Executor這四個接口上的方法進行攔截,利用JDK動態(tài)代理機制饰恕,為這些接口的實現(xiàn)類創(chuàng)建代理對象甘穿,在執(zhí)行方法時,先去執(zhí)行代理對象的方法峰尝,從而執(zhí)行自己編寫的攔截邏輯,所以真正要用好mybatis插件收恢,主要還是要熟悉這四個接口的方法以及這些方法上的參數(shù)的含義武学;

另外,如果配置了多個攔截器的話伦意,會出現(xiàn)層層代理的情況火窒,即代理對象代理了另外一個代理對象,形成一個代理鏈條驮肉,執(zhí)行的時候熏矿,也是層層執(zhí)行;

關(guān)于mybatis插件涉及到的設(shè)計模式和軟件思想如下:

設(shè)計模式:代理模式离钝、責任鏈模式票编;
軟件思想:AOP編程思想,降低模塊間的耦合度卵渴,使業(yè)務(wù)模塊更加獨立慧域;
一些注意事項:

不要定義過多的插件,代理嵌套過多浪读,執(zhí)行方法的時候吊趾,比較耗性能宛裕;
攔截器實現(xiàn)類的intercept方法里最后不要忘了執(zhí)行invocation.proceed()方法,否則多個攔截器情況下论泛,執(zhí)行鏈條會斷掉揩尸;

2、Springboot 編寫 mybatis 插件

編寫 mybatis 插件很簡單屁奏,首先定義要攔截的是上面說到的哪個類岩榆,攔截哪個方法,參數(shù)是啥坟瓢,然后配置一下即可

package com.snowflake1.test.config;

import org.apache.ibatis.executor.statement.StatementHandler;
import org.apache.ibatis.mapping.BoundSql;
import org.apache.ibatis.plugin.*;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.sql.Connection;
import java.util.Properties;

@Intercepts({
        @Signature(type = StatementHandler.class, method = "prepare", args = {Connection.class, Integer.class})
})
public class MyPlugin implements Interceptor {

    private Logger logger = LoggerFactory.getLogger(MyPlugin.class);

    private long time;


    //方法攔截
    @Override
    public Object intercept(Invocation invocation) throws Throwable {
        //通過StatementHandler獲取執(zhí)行的sql
        StatementHandler statementHandler = (StatementHandler) invocation.getTarget();
        BoundSql boundSql = statementHandler.getBoundSql();
        String sql = boundSql.getSql();

        long start = System.currentTimeMillis();
        Object proceed = invocation.proceed();
        long end = System.currentTimeMillis();
        if ((end - start) > time) {
            logger.info("本次數(shù)據(jù)庫操作是慢查詢勇边,sql是:" + sql);
        }
        return proceed;
    }

    //獲取到攔截的對象,底層也是通過代理實現(xiàn)的折联,實際上是拿到一個目標代理對象
    @Override
    public Object plugin(Object target) {
        return Plugin.wrap(target, this);
    }

    //獲取設(shè)置的閾值等參數(shù)
    @Override
    public void setProperties(Properties properties) {
        this.time = Long.parseLong(properties.getProperty("time"));
    }
}

在 springboot 那配置一下(我用的是 mybatisplus)

package com.snowflake1.test.config;

import com.baomidou.mybatisplus.autoconfigure.ConfigurationCustomizer;
import com.baomidou.mybatisplus.core.MybatisConfiguration;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import java.util.Properties;

@Configuration
public class MapperConfig {
    //將插件加入到mybatis插件攔截鏈中
    @Bean
    public ConfigurationCustomizer configurationCustomizer() {
        return new ConfigurationCustomizer() {
            @Override
            public void customize(MybatisConfiguration configuration) {
                //插件攔截鏈采用了責任鏈模式粒褒,執(zhí)行順序和加入連接鏈的順序有關(guān)
                MyPlugin myPlugin = new MyPlugin();
                //設(shè)置參數(shù),比如閾值等诚镰,可以在配置文件中配置奕坟,這里直接寫死便于測試
                Properties properties = new Properties();
                //這里設(shè)置慢查詢閾值為1毫秒,便于測試
                properties.setProperty("time", "1");
                myPlugin.setProperties(properties);
                configuration.addInterceptor(myPlugin);
            }
        };
    }
}

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末清笨,一起剝皮案震驚了整個濱河市月杉,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌抠艾,老刑警劉巖苛萎,帶你破解...
    沈念sama閱讀 218,525評論 6 507
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異检号,居然都是意外死亡腌歉,警方通過查閱死者的電腦和手機,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,203評論 3 395
  • 文/潘曉璐 我一進店門齐苛,熙熙樓的掌柜王于貴愁眉苦臉地迎上來翘盖,“玉大人,你說我怎么就攤上這事脸狸∽盥兀” “怎么了藐俺?”我有些...
    開封第一講書人閱讀 164,862評論 0 354
  • 文/不壞的土叔 我叫張陵炊甲,是天一觀的道長。 經(jīng)常有香客問我欲芹,道長卿啡,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 58,728評論 1 294
  • 正文 為了忘掉前任菱父,我火速辦了婚禮颈娜,結(jié)果婚禮上剑逃,老公的妹妹穿的比我還像新娘。我一直安慰自己官辽,他們只是感情好蛹磺,可當我...
    茶點故事閱讀 67,743評論 6 392
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著同仆,像睡著了一般萤捆。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上俗批,一...
    開封第一講書人閱讀 51,590評論 1 305
  • 那天俗或,我揣著相機與錄音,去河邊找鬼岁忘。 笑死辛慰,一個胖子當著我的面吹牛,可吹牛的內(nèi)容都是我干的干像。 我是一名探鬼主播帅腌,決...
    沈念sama閱讀 40,330評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼蝠筑!你這毒婦竟也來了狞膘?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 39,244評論 0 276
  • 序言:老撾萬榮一對情侶失蹤什乙,失蹤者是張志新(化名)和其女友劉穎挽封,沒想到半個月后,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體臣镣,經(jīng)...
    沈念sama閱讀 45,693評論 1 314
  • 正文 獨居荒郊野嶺守林人離奇死亡辅愿,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 37,885評論 3 336
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發(fā)現(xiàn)自己被綠了忆某。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片点待。...
    茶點故事閱讀 40,001評論 1 348
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖弃舒,靈堂內(nèi)的尸體忽然破棺而出癞埠,到底是詐尸還是另有隱情,我是刑警寧澤聋呢,帶...
    沈念sama閱讀 35,723評論 5 346
  • 正文 年R本政府宣布苗踪,位于F島的核電站,受9級特大地震影響削锰,放射性物質(zhì)發(fā)生泄漏通铲。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點故事閱讀 41,343評論 3 330
  • 文/蒙蒙 一器贩、第九天 我趴在偏房一處隱蔽的房頂上張望颅夺。 院中可真熱鬧朋截,春花似錦、人聲如沸吧黄。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,919評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽拗慨。三九已至饲宿,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間胆描,已是汗流浹背瘫想。 一陣腳步聲響...
    開封第一講書人閱讀 33,042評論 1 270
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留昌讲,地道東北人国夜。 一個月前我還...
    沈念sama閱讀 48,191評論 3 370
  • 正文 我出身青樓,卻偏偏與公主長得像短绸,于是被迫代替她去往敵國和親车吹。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 44,955評論 2 355

推薦閱讀更多精彩內(nèi)容