Mybatis 插件（plugins）

一、Mybatis 插件介绍

MyBatis 允许你在映射语句执行过程中的某一点进行拦截调用。默认情况下，MyBatis 允许使用插件来拦截的方法调用包括：

• Executor (update, query, flushStatements, commit, rollback, getTransaction, close, isClosed)
• ParameterHandler (getParameterObject, setParameters)
• ResultSetHandler (handleResultSets, handleOutputParameters)
• StatementHandler (prepare, parameterize, batch, update, query)

这些类中方法的细节可以通过查看每个方法的签名来发现，或者直接查看 MyBatis 发行包中的源代码。 如果你想做的不仅仅是监控方法的调用，那么你最好相当了解要重写的方法的行为。 因为在试图修改或重写已有方法的行为时，很可能会破坏 MyBatis 的核心模块。 这些都是更底层的类和方法，所以使用插件的时候要特别当心。
通过 MyBatis 提供的强大机制，使用插件是非常简单的，只需实现 Interceptor 接口，并指定想要拦截的方法签名即可。

// ExamplePlugin.java
@Intercepts({@Signature(
	type= Executor.class,
	method = "update",
	args = {MappedStatement.class, Object.class})})
public class ExamplePlugin implements Interceptor {
	private Properties properties = new Properties();
	public Object intercept(Invocation invocation) throws Throwable {
		// implement pre processing if need
		Object returnObject = invocation.proceed();
		// implement post processing if need
		return returnObject;
	}
	public void setProperties(Properties properties) {
    	this.properties = properties;
	}
}

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

上面的插件将会拦截在 Executor 实例中所有的 “update” 方法调用， 这里的 Executor 是负责执行底层映射语句的内部对象。

注意：覆盖配置类
除了用插件来修改 MyBatis 核心行为以外，还可以通过完全覆盖配置类来达到目的。只需继承配置类后覆盖其中的某个方法，再把它传递到 SqlSessionFactoryBuilder.build(myConfig) 方法即可。再次重申，这可能会极大影响 MyBatis 的行为，务请慎之又慎。

二、自定义一个插件

数据脱敏：对用户信息中的身份证 id_card 进行加密：只显示前面三位和后面4位

1. 实现Interceptor接口

import org.apache.ibatis.executor.Executor;
import org.apache.ibatis.mapping.BoundSql;
import org.apache.ibatis.mapping.MappedStatement;
import org.apache.ibatis.mapping.ResultSetType;
import org.apache.ibatis.plugin.*;
import org.apache.ibatis.session.ResultHandler;
import org.apache.ibatis.session.RowBounds;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.util.StringUtils;
import java.util.List;
import java.util.Properties;
/**
 * 数据脱敏
 * 对用户信息中的身份证 id_card 进行加密：只显示前面三位和后面4位
 */
@Intercepts({
        @Signature(type = Executor.class, method = "query",
                args = {MappedStatement.class, Object.class, RowBounds.class, ResultHandler.class})
})
public class DataDesensitizationInterceptor implements Interceptor {
    private static final Logger logger = LoggerFactory.getLogger(DataDesensitizationInterceptor.class);
    @Override
    public Object intercept(Invocation invocation) throws Throwable {
        logger.info("-------------拦截目标对象的目标方法的执行-------------");
        Executor executor = (Executor) invocation.getTarget();
        Object[] args = invocation.getArgs();
        MappedStatement mappedStatement = (MappedStatement) args[0];
        Object parameter = args[1];
        BoundSql boundSql = mappedStatement.getBoundSql(parameter);
        String sql = boundSql.getSql();
        sql = sql.replaceAll("\n", " ").replaceAll(" +", " ").toLowerCase();
        RowBounds rowBounds = (RowBounds) args[2];
        ResultHandler resultHandler = (ResultHandler) args[3];
        Object obj = invocation.proceed();
        if (sql.indexOf("from user") > -1) {
            ResultSetType resultSetType = mappedStatement.getResultSetType();
            if (obj instanceof User) {
                User user = (User) obj;
                String idCard = user.getIdCard();
                if (!StringUtils.isEmpty(idCard)) {
                    user.setIdCard(idCard.substring(0, 3) + "***" + idCard.substring(idCard.length() - 4));
                }
                return user;
            } else if (obj instanceof List) {
                List list = (List) obj;
                for (Object item : list){
                    if (item instanceof User) {
                        User user = (User) item;
                        String idCard = user.getIdCard();
                        if (!StringUtils.isEmpty(idCard)) {
                            user.setIdCard(idCard.substring(0, 3) + "***" + idCard.substring(idCard.length() - 4));
                        }
                    }
                }
                return list;
            }
        }
        return obj;
    }
    @Override
    public Object plugin(Object target) {
        return Plugin.wrap(target, this);
    }
    @Override
    public void setProperties(Properties properties) {
        // 获取自定义配置参数
        logger.info("-------------获取自定义配置参数-------------");
    }
}

2. 注册插件

import org.mybatis.spring.annotation.MapperScan;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import java.util.Properties;

@Configuration
@MapperScan({"com.xxx.mapper"})
public class MybatisConfig {
    //注册插件
    @Bean
    public DataDesensitizationInterceptor dataDesensitizationInterceptor() {
        DataDesensitizationInterceptor dataDesensitizationInterceptor = new DataDesensitizationInterceptor();
        // 设置参数
        Properties properties = new Properties();
        dataDesensitizationInterceptor.setProperties(properties);
        return dataDesensitizationInterceptor;
    }
}

参考文档：

Mybatis 官网