编写Mybatis插件

最新推荐文章于 2023-07-15 23:36:25 发布

william_cr7

最新推荐文章于 2023-07-15 23:36:25 发布

阅读量771

点赞数 1

分类专栏： mybatis 文章标签： mybatis mybatis插件

本文链接：https://blog.csdn.net/CHINACR07/article/details/94598514

版权

mybatis 专栏收录该内容

2 篇文章 0 订阅

订阅专栏

mybatis是项目中常用的orm框架，在开发中我们有时需要对sql进行增强，这时我们可以编写自己的mybatis插件。

mybatis插件代码实现

1、编写插件实现类

package com.glsx.oms.basic.framework.common;

import org.apache.ibatis.executor.statement.StatementHandler;
import org.apache.ibatis.mapping.BoundSql;
import org.apache.ibatis.mapping.MappedStatement;
import org.apache.ibatis.mapping.ParameterMapping;
import org.apache.ibatis.plugin.*;
import org.apache.ibatis.reflection.MetaObject;
import org.apache.ibatis.session.Configuration;
import org.apache.ibatis.type.TypeHandlerRegistry;
import org.springframework.stereotype.Component;

import java.sql.Connection;
import java.sql.Date;
import java.text.DateFormat;
import java.util.List;
import java.util.Locale;
import java.util.Properties;

/**
 * @Auther: williamdream
 * @Date: 2019/6/17 17:50
 * @Description:
 */
@Component   //该注解不要忘记了，否则无法注入spring容器中，插件不会生效
@Intercepts(@Signature(method = "prepare", type = StatementHandler.class, args = {Connection.class,Integer.class}))
public class PrepareInterceptor implements Interceptor {

    private Properties properties;

    @Override
    public Object intercept(Invocation invocation) throws Throwable {
        MappedStatement mappedStatement = (MappedStatement) invocation.getArgs()[0];
        Object paramter = null;
        if (invocation.getArgs().length > 1)
            paramter = invocation.getArgs()[1];
        String sqlid = mappedStatement.getId();
        BoundSql boundSql = mappedStatement.getBoundSql(paramter);
        Configuration configuration = mappedStatement.getConfiguration();
        Object returnValue = null;
        long start = System.currentTimeMillis();
        returnValue = invocation.proceed();
        long time = System.currentTimeMillis()-start;

        this.showsql(configuration, boundSql);
        return returnValue;
    }

    @Override
    public Object plugin(Object target) {
        return Plugin.wrap(target, this);
    }

    @Override
    public void setProperties(Properties properties) {
        this.properties = properties;
    }

    public static String showsql(Configuration configuration, BoundSql boundSql){

        Object parameterObject = boundSql.getParameterObject();
        List<ParameterMapping> parameterMappings = boundSql.getParameterMappings();
        String sql = boundSql.getSql().replaceAll("[\\s]+", " ");
        if(parameterObject != null && parameterMappings.size() > 0) {
            TypeHandlerRegistry typeHandlerRegistry = configuration.getTypeHandlerRegistry();
            if (typeHandlerRegistry.hasTypeHandler(parameterObject.getClass())) {
                sql = sql.replaceFirst("\\?", getParameterValue(parameterObject));

            } else {
                MetaObject metaObject = configuration.newMetaObject(parameterObject);
                for (ParameterMapping parameterMapping : parameterMappings) {
                    String propertyName = parameterMapping.getProperty();
                    if (metaObject.hasGetter(propertyName)) {
                        Object obj = metaObject.getValue(propertyName);
                        sql = sql.replaceFirst("\\?", getParameterValue(obj));
                    } else if (boundSql.hasAdditionalParameter(propertyName)) {
                        Object obj = boundSql.getAdditionalParameter(propertyName);
                        sql = sql.replaceFirst("\\?", getParameterValue(obj));
                    }
                }


            }

        }

        return sql;
    }

    private static String getParameterValue(Object obj) {
        String value = null;
        if (obj instanceof String) {
            value = "'" + obj.toString() + "'";
        } else if (obj instanceof Date) {
            DateFormat formatter = DateFormat.getDateTimeInstance(DateFormat.DEFAULT, DateFormat.DEFAULT, Locale.CHINA);
            value = "'" + formatter.format(new Date(100000000)) + "'";
        } else {
            if (obj != null) {
                value = obj.toString();
            } else {
                value = "";
            }

        }
        return value;
    }


}

2、添加配置

然后在mybatis-config.xml中添加如下配置：

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-config.dtd">

<configuration>

    <plugins>
        <plugin interceptor="com.glsx.oms.basic.framework.common.PrepareInterceptor">
            <!--<property name="dialect" value="mysql" />-->
        </plugin>
        <plugin interceptor="com.glsx.oms.basic.framework.common.SqlEnhanceInterceptor">
            <property name="vehicleId" value="mysql" />
        </plugin>
    </plugins>
</configuration>