四种方式使通用SDK中自定义Mybatis Plugin生效?

忘是亡心i 2023-09-30 11:14 1阅读 0赞

### 一、官方做法 ###

可以在[官方文档][Link 1]看到，对于项目上引入自定义的Mybatis Plugin（文中以`ExamplePlugin`为例）通常采用在mybatis配置文件（`mybatis-config.xml`）中引入`<plugin>`标签的方式处理；

<plugins>
      <plugin interceptor="org.mybatis.example.ExamplePlugin">
        <property name="someProperty" value="100"/>
      </plugin>
    </plugins>

我们可以注意到在`<plugin>`标签中有一个`<property>`标签，从命名来看，它是用来引入自定义属性的！

**那么具体是怎么用的呢？**

1> 大家都知道自定义Mybatis Plugin时需要实现Interceptor接口，在Interceptor接口中有一个抽象方法`void setProperties(Properties properties)`；其用来接收配置文件中的property参数，即上面的`<property>`标签中的内容。换言之，**只有采用XML配置文件的方式注入Mybatis Plugin，setProperties()方法才有实际使用意义，否则是不会进入的。**

package org.apache.ibatis.plugin;
    
    import java.util.Properties;
    
    /**
     * @author Clinton Begin
     */
    public interface Interceptor {
        
    
      Object intercept(Invocation invocation) throws Throwable;
    
      Object plugin(Object target);
    
      void setProperties(Properties properties);
    
    }

![在这里插入图片描述][watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBA56eD5aS054ix5YGl6Lqr_size_20_color_FFFFFF_t_70_g_se_x_16]

因此，如果我们采用其他的方式注入Mybatis Plugin，不要尝试在setProperties()方法中对自定义的Mybatis Plugin中的一些属性赋值，那是无用的（亲测哦）。

如果我要自己写一个组件 / SDK，不好用这种方式；业务上假如也有自己的mybatis配置文件，它再一指定，好耶，要找我了（为什么你的MyBatis Plugin没生效！！！）。

### 二、@Component ###

直接利用Spring的扫包机制，将标注了`@Component派生类注解`的类直接扫描加载到Spring；

@Configuration
    public class ExamplePlugin implements Interceptor {
        
        ....
    }

**注意：** 若使用当前方式，注意Spring的扫包路径；如果是写了一个SDK给其他业务模块引用，记得让他们在启动类添加一下扫描包路径，或者通过`@Import注解`引入`MybatisInterceptor`类；

@ComponentScan({
        "com.example.xxx","org.mybatis.example.xxx"})

@Import(ExamplePlugin.class)

### 三、@Configuration + @Bean ###

自定义的Mybatis Plugin仅作为一个普通的类，具体何时引入到Spring容器，由相应的配置类决定；例如：

@Configuration
    public class MyBatisConfig {
        
    
        /**
         * mybatis plugin
         */
        @Bean
        public Interceptor getInterceptor() {
        
            return new MybatisInterceptor();
        }
    }

**使用的注意点**和`二、@Component`一样，区别在于这里要引入的是配置类`MyBatisConfig`；

推荐使用这种方式；

![在这里插入图片描述][watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBA56eD5aS054ix5YGl6Lqr_size_18_color_FFFFFF_t_70_g_se_x_16]

### 四、用到SpringBoot机制的@Configuration + @Bean ###

这个其实和`三、@Configuration + @Bean`差不多，区别在于三、是直接new一个MyBatisInterceptor，这里是通过`mybatis-spring-boot-autoconfigure` SpringBoot自动装配机制添加一个拦截器；  
例如：

@Configuration
    public class MyBatisConfig {
        
    
        @Bean
        ConfigurationCustomizer configurationCustomizer() {
        
    
            MybatisInterceptor statementInterceptor = new MybatisInterceptor();
    
            return (configuration) -> configuration.addInterceptor(statementInterceptor);
        }
    }

不过首先要在pom中引入：

<dependency>
        <groupId>org.mybatis.spring.boot</groupId>
        <artifactId>mybatis-spring-boot-autoconfigure</artifactId>
        <version>2.2.0</version>
    </dependency>

因为要额外引入`mybatis-spring-boot-autoconfigure`，所以在SDK中最好使用第三种方式`@Configuration + @Bean`；

软件设计上永远没有最好，只有更合适。具体使用那种方式大家灵活选择；

[Link 1]: https://mybatis.net.cn/configuration.html#plugins
[watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBA56eD5aS054ix5YGl6Lqr_size_20_color_FFFFFF_t_70_g_se_x_16]: https://img-blog.csdnimg.cn/95b28917fd534ba2a03318aed6c81c97.png?x-oss-process=image/watermark,type_d3F5LXplbmhlaQ,shadow_50,text_Q1NETiBA56eD5aS054ix5YGl6Lqr,size_20,color_FFFFFF,t_70,g_se,x_16
[watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBA56eD5aS054ix5YGl6Lqr_size_18_color_FFFFFF_t_70_g_se_x_16]: https://img-blog.csdnimg.cn/a60cc1ae0c0c4235978c094d26cf28fa.png?x-oss-process=image/watermark,type_d3F5LXplbmhlaQ,shadow_50,text_Q1NETiBA56eD5aS054ix5YGl6Lqr,size_18,color_FFFFFF,t_70,g_se,x_16