mybatisplus拦截器妙用

项目中使用mybatisplus,但是有时候需要用拦截器做一些特殊的处理,主要有以下两种:

1.可以对SQL进行替换

项目中基本所有的查询语句都需要传入no和startTime字段,这两个值对于每次业务来说是全局确定的,一般会放在ThreadLocal中,所以会导致所有的dao接口中都需要增加这两个参数。

xml

<select id="getUserLoginList" resultMap="UserLogin">
        select distinct user_id, dom_id
        from `user_behavior_analysis`
        where `no`=#{no}
            and <![CDATA[time >= #{startTime}]]>
            and isNotNull(dom_id);
</select>

<select id="getPageVisitList" resultMap="PageVisit">
        select distinct resource_id as pg_id, dom_id
        from `user_behavior_analysis`
        where `no`=#{no}
            and op_name = '获取页面数据'
            and <![CDATA[time >= #{start_time}]]>
            and isNotNull(dom_id);
</select>

....

dao

List<User> getUserLoginList(@Param("no")String no,@Param("startTime")String startTime);

List<Page> getPageVisitList(@Param("no")String no,@Param("startTime")String startTime);

这种方式的缺点:dao层接口中都需要加上这两个参数,并且代码中所有的查询处都需要传入这两个参数,多少会有点冗余。有一种比较好的方式是拦截到这个SQL,然后将这个SQL中这两个参数的值替换掉上下文的值,所以需要使用mybatisplus的拦截器来实现。为了更好地识别出这两个参数,可以通过固定字符占位,例如$PADDING,那么xml就变成了:
xml

<select id="getUserLoginList" resultMap="UserLogin">
        select distinct user_id, dom_id
        from `user_behavior_analysis`
        where `no`=$PADDING(no)
            and <![CDATA[time >= $PADDING(startTime)]]>
            and isNotNull(dom_id);
</select>

<select id="getPageVisitList" resultMap="PageVisit">
        select distinct resource_id as pg_id, dom_id
        from `user_behavior_analysis`
        where `no`=$PADDING(no)
            and op_name = '获取页面数据'
            and <![CDATA[time >= $PADDING(start_time)]]>
            and isNotNull(dom_id);
</select>
....

dao

List<User> getUserLoginList();

List<Page> getPageVisitList();

2.打印SQL语句的执行时间

通过在执行SQL语句执行前保存一个时间,将执行结束后的时间-执行前的时间就是SQL的执行时间,也可以通过在拦截器中进行处理。

代码 如下:

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

    private static final ReflectorFactory defaultReflectorFactory = new DefaultReflectorFactory();

    private static final Logger logger = LoggerFactory.getLogger("SQL_LOGGER");

    @Override
    public Object intercept(Invocation invocation) throws Throwable {

         StatementHandler statementHandler = (StatementHandler) invocation.getTarget();
        MetaObject metaObject = MetaObject.forObject(statementHandler,
                SystemMetaObject.DEFAULT_OBJECT_FACTORY,
                SystemMetaObject.DEFAULT_OBJECT_WRAPPER_FACTORY,
                defaultReflectorFactory
        );

        MappedStatement mappedStatement = (MappedStatement) metaObject.getValue("delegate.mappedStatement");

        String namespace = mappedStatement.getId();
        String className = namespace.substring(0, namespace.lastIndexOf('.'));
        Class<?> clazz = Class.forName(className);
        String methodType = invocation.getMethod().getName();

        if (methodType.equals("prepare")) {
            // 获取TableShard注解
            TableShard tableShard = clazz.getAnnotation(TableShard.class);
            String sql = (String)metaObject.getValue("delegate.boundSql.sql");
            if ( tableShard != null ) {
                TableNameEnum[] tableNames = tableShard.tableNames();
                // 获取源sql
                sql = getReplacedSql(sql, tableNames);
                // 用新sql代替旧sql, 完成所谓的sql rewrite
                metaObject.setValue("delegate.boundSql.sql", sql);
            }

            return invocation.proceed();
        }

        if (!methodType.equals("query")) {
            return invocation.proceed();
        }

        // 传递给下一个拦截器处理
        long startTime = System.currentTimeMillis();
        Object ret = invocation.proceed();

        String sql = statementHandler.getBoundSql().getSql().replaceAll("\r\n|\n|\\s+"," ");
        logger.info("SQL:【{}】,耗时|{}|ms",sql, System.currentTimeMillis()-startTime);

        return ret;
    }

    @Override
    public Object plugin(Object target) {
        // 当目标类是StatementHandler类型时,才包装目标类,否者直接返回目标本身, 减少目标被代理的次数
        if (target instanceof StatementHandler) {
            return Plugin.wrap(target, this);
        } else {
            return target;
        }
    }

    @Override
    public void setProperties(Properties properties) {
    }

    private String getReplaceSpecialSql(String sql) {

        // start_time
        sql = sql.replaceAll("\\$PADDING\\(startTime\\)","'"+TableChangedLocal.getStartTimeLocal()+"'");

        // no
        sql = sql.replaceAll("\\$PADDING\\(no\\)", String.valueOf(TableChangedLocal.getCustomerNo()));

        return sql;
    }
}

注:TableChangedLocal是Threadlocal上下文信息,线程内都可以访问

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 155,958评论 4 358
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 66,179评论 1 286
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 105,792评论 0 237
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,409评论 0 202
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 51,723评论 3 285
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,174评论 1 204
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,543评论 2 306
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,270评论 0 194
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 33,899评论 1 236
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,235评论 2 240
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 31,771评论 1 255
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,139评论 2 249
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 32,688评论 3 228
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 25,936评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,646评论 0 192
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,194评论 2 265
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,145评论 2 258

推荐阅读更多精彩内容