mybatis 自定义插件实现Interceptor

旧城等待， 2022-11-15 01:27 343阅读 0赞

## github：[https://github.com/nlxs0511/springmybatisplus.git][https_github.com_nlxs0511_springmybatisplus.git] ##

## 1.新建MybatisInterceptor  ##

package com.test.mybatisplus.Interceptor;
    
    import com.baomidou.mybatisplus.core.toolkit.PluginUtils;
    import org.apache.ibatis.executor.statement.StatementHandler;
    import org.apache.ibatis.mapping.BoundSql;
    import org.apache.ibatis.mapping.ParameterMapping;
    import org.apache.ibatis.plugin.*;
    
    import java.sql.Connection;
    import java.util.List;
    import java.util.Properties;
    
    /**
     * @Description mybatis自定义插件  mybatis只能拦截 Executor StatementHandler ParameterHandler ResultSetHandler
     * @project
     * @author：hf
     * @date：
     */
    @Intercepts({@Signature(
            type = StatementHandler.class,
            method = "prepare",
            args = {Connection.class, Integer.class}
    )})
    public class MybatisInterceptor implements Interceptor {
    
        private String name;
        /**
         * @param invocation
         * @return
         * @throws Throwable
         */
        @Override
        public Object intercept(Invocation invocation) throws Throwable {
            //通过StatementHandler获取执行的sql
            StatementHandler statementHandler = (StatementHandler) invocation.getTarget();
            BoundSql boundSql = statementHandler.getBoundSql();
            // 获取sql
            String sql = boundSql.getSql();
            List<ParameterMapping> list=boundSql.getParameterMappings();
    
            long start = System.currentTimeMillis();
            Object proceed = invocation.proceed();
            long end = System.currentTimeMillis();
            System.out.println(name+",您的本次数据库操作时间为：:" + (end - start)+"ms");
            return proceed;
        }
    
        /** 获取到拦截的对象，底层也是通过代理实现的，实际上是拿到一个目标代理对象 */
        @Override
        public Object plugin(Object target) {
            return Plugin.wrap(target, this);
        }
    
        /**
         * 获取设置的阈值等参数
         */
        @Override
        public void setProperties(Properties properties) {
           this.name =properties.getProperty("name");
        }
    
    }

## 2.新建MybatisPluConfig  ##

package com.test.mybatisplus.config;
    import com.baomidou.mybatisplus.autoconfigure.ConfigurationCustomizer;
    import com.baomidou.mybatisplus.extension.plugins.PaginationInterceptor;
    import com.test.mybatisplus.Interceptor.MybatisInterceptor;
    import org.springframework.beans.factory.annotation.Value;
    import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.Configuration;
    
    import java.util.Properties;
    
    
    @Configuration
    //@MapperScan("com.test.mybatisplus.mapper")
    public class MybatisPluConfig {
    
        @Value("${MybatisInterceptor.name}")
        String name;
        /**
         * mybatis-plus分页插件
         */
        @Bean
        public PaginationInterceptor paginationInterceptor() {
            PaginationInterceptor paginationInterceptor = new PaginationInterceptor();
            return paginationInterceptor;
        }
    
        /**
         *自定义mybatis插件 注入方式一
         */
        @Bean
        public MybatisInterceptor mybatisInterceptor() {
            MybatisInterceptor mybatisInterceptor = new MybatisInterceptor();
            Properties properties = new Properties();
            properties.setProperty("name", name);
            mybatisInterceptor.setProperties(properties);
            return mybatisInterceptor;
        }
        /**
         *自定义mybatis插件 注入方式二
         */
        @Bean
        public ConfigurationCustomizer configurationCustomizer() {
            return new ConfigurationCustomizer() {
                @Override
                public void customize(org.apache.ibatis.session.Configuration configuration) {
                    //插件拦截链采用了责任链模式，执行顺序和加入连接链的顺序有关
                    MybatisInterceptor mybatisInterceptor = new MybatisInterceptor();
                    //设置参数，比如阈值等，可以在配置文件中配置，这里直接写死便于测试
                    Properties properties = new Properties();
                    properties.setProperty("name", name);
                    mybatisInterceptor.setProperties(properties);
                    configuration.addInterceptor(mybatisInterceptor);
                }
            };
        }
    
    
        /**
         * mybatis-plus SQL执行效率插件【生产环境可以关闭】 3.3.2版本移除了该功能，3.0.3和3.0.3之前版本支持。
         */
      /*  @Bean
        public PerformanceInterceptor performanceInterceptor() {
            return new PerformanceInterceptor();
        }*/
    
    
    
    }

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NpbmF0XzM0MzM4MTYy_size_16_color_FFFFFF_t_70][]

# 方式三：不用新建MybatisPluConfig ，直接在 MybatisInterceptor  中加上@Component #

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NpbmF0XzM0MzM4MTYy_size_16_color_FFFFFF_t_70 1][]

## 3.配置文件自定义name值 ##

![20210330180507712.png][]

## 4.启动成功之后调用接口（两次输出是因为上面第2步插件注入的时候两种都放开了） ##

![20210330180542685.png][]

[https_github.com_nlxs0511_springmybatisplus.git]: https://github.com/nlxs0511/springmybatisplus.git
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NpbmF0XzM0MzM4MTYy_size_16_color_FFFFFF_t_70]: /images/20221022/df1c89e256664b64b6e1cb056f0971d2.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NpbmF0XzM0MzM4MTYy_size_16_color_FFFFFF_t_70 1]: https://img-blog.csdnimg.cn/20210422155439578.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NpbmF0XzM0MzM4MTYy,size_16,color_FFFFFF,t_70
[20210330180507712.png]: https://img-blog.csdnimg.cn/20210330180507712.png
[20210330180542685.png]: https://img-blog.csdnimg.cn/20210330180542685.png