深入剖析MyBatis插件机制:从自定义插件到PageHelper分页原理(附源码)

public interface Interceptor {  // 执行拦截逻辑的方法  Object intercept(Invocation invocation) throws Throwable;  // 决定是否触发 intercept() 方法  default Object plugin(Object target) {    return Plugin.wrap(target, this);  }  // 根据配置初始化 Intercept 对象  default void setProperties(Properties properties) {    // NOP  }}

package com.boboedu.interceptor;import org.apache.ibatis.executor.Executor;import org.apache.ibatis.mapping.MappedStatement;import org.apache.ibatis.plugin.*;import org.apache.ibatis.session.ResultHandler;import org.apache.ibatis.session.RowBounds;import java.util.Properties;/** * 自定义的拦截器 * @Signature 注解表示一个方法签名，唯一确定一个方法 */@Intercepts({        @Signature(                type = Executor.class // 需要拦截的类型                , method = "query"     // 需要拦截的方法                // args 中指定被拦截方法的参数列表                , args = {MappedStatement.class, Object.class, RowBounds.class, ResultHandler.class}        ),        @Signature(                type = Executor.class                , method = "close"                , args = {boolean.class}        )})public class FirstInterceptor implements Interceptor {    private int testProp;    /**     * 执行拦截逻辑的方法     */    @Override    public Object intercept(Invocation invocation) throws Throwable {        System.out.println("FirstInterceptor 拦截之前 ....");        Object obj = invocation.proceed(); // 执行目标方法        System.out.println("FirstInterceptor 拦截之后 ....");        return obj;    }    /**     * 决定是否触发 intercept 方法     */    @Override    public Object plugin(Object target) {        return Plugin.wrap(target, this);    }    @Override    public void setProperties(Properties properties) {        System.out.println("---->" + properties.get("testProp"));    }    // getter & setter    public int getTestProp() {        return testProp;    }    public void setTestProp(int testProp) {        this.testProp = testProp;    }}

<plugins>    <plugininterceptor="com.bobo.interceptor.FirstInterceptor">        <propertyname="testProp"value="1000"/>    </plugin></plugins>

@Testpublic void test1() throws Exception {    // 1. 获取配置文件    InputStream in = Resources.getResourceAsStream("mybatis-config.xml");    // 2. 加载解析配置文件并获取 SqlSessionFactory 对象    SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(in);    // 3. 根据 SqlSessionFactory 对象获取 SqlSession 对象    SqlSession sqlSession = factory.openSession();    // 4. 通过 SqlSession 中提供的 API 方法来操作数据库    List<User> list = sqlSession.selectList("com.bobo.mapper.UserMapper.selectUserList");    for (User user : list) {        System.out.println(user);    }    // 5. 关闭会话    sqlSession.close();}

FirstInterceptor 拦截之前 ....FirstInterceptor 拦截之后 ....

private void pluginElement(XNode parent) throws Exception {    if (parent != null) {        for (XNode child : parent.getChildren()) {            // 获取 <plugin> 节点的 interceptor 属性的值            String interceptor = child.getStringAttribute("interceptor");            // 获取 <plugin> 下的所有的 properties 子节点            Properties properties = child.getChildrenAsProperties();            // 获取 Interceptor 对象            Interceptor interceptorInstance = (Interceptor) resolveClass(interceptor)                    .getDeclaredConstructor().newInstance();            // 设置 interceptor 的属性            interceptorInstance.setProperties(properties);            // Configuration 中记录 Interceptor            configuration.addInterceptor(interceptorInstance);        }    }}

public void addInterceptor(Interceptor interceptor) {    interceptorChain.addInterceptor(interceptor);}

public class InterceptorChain {    // 保存所有的 Interceptor    private final List<Interceptor> interceptors = new ArrayList<>();    public Object pluginAll(Object target) {        for (Interceptor interceptor : interceptors) {            target = interceptor.plugin(target); // 创建对应的拦截器的代理对象        }        return target;    }    public void addInterceptor(Interceptor interceptor) {        interceptors.add(interceptor);    }    public List<Interceptor> getInterceptors() {        return Collections.unmodifiableList(interceptors);    }}

// Executor 创建时的代码示例executor = (Executor) interceptorChain.pluginAll(executor);// StatementHandler 创建时的代码示例statementHandler = (StatementHandler) interceptorChain.pluginAll(statementHandler);

default Object plugin(Object target) {    return Plugin.wrap(target, this);}

/** * 创建目标对象的代理对象 * 目标对象：Executor、ParameterHandler、ResultSetHandler、StatementHandler */public static Object wrap(Object target, Interceptor interceptor) {    // 获取用户自定义 Interceptor 中 @Signature 注解的信息    Map<Class<?>, Set<Method>> signatureMap = getSignatureMap(interceptor);    // 获取目标类型    Class<?> type = target.getClass();    // 获取目标类型实现的所有接口    Class<?>[] interfaces = getAllInterfaces(type, signatureMap);    // 如果目标类型有实现的接口，就创建代理对象    if (interfaces.length > 0) {        return Proxy.newProxyInstance(            type.getClassLoader(),            interfaces,            new Plugin(target, interceptor, signatureMap));    }    // 否则原封不动地返回目标对象    return target;}

public classPluginimplementsInvocationHandler{    private final Object target;           // 目标对象    private final Interceptor interceptor; // 拦截器    private final Map<Class<?>, Set<Method>> signatureMap; // 记录 @Signature 注解的信息    @Override    public Object invoke(Object proxy, Method method, Object[] args) throwsThrowable{        try {            // 获取当前方法所在类或接口中，可被当前 Interceptor 拦截的方法            Set<Method> methods = signatureMap.get(method.getDeclaringClass());            if (methods != null && methods.contains(method)) {                // 当前调用的方法需要被拦截，执行拦截操作                return interceptor.intercept(new Invocation(target, method, args));            }            // 不需要拦截，则调用目标对象中的方法            return method.invoke(target, args);        } catch (Exception e) {            throw ExceptionUtil.unwrapThrowable(e);        }    }}

请求 -> Executor.query() -> Plugin.invoke() ->     是否需要拦截？    ├── 是 -> FirstInterceptor.intercept() -> invocation.proceed() -> 目标方法    └── 否 -> 直接执行目标方法

配置顺序：Interceptor1 -> Interceptor2执行顺序：Interceptor2 -> Interceptor1

<dependency>    <groupId>com.github.pagehelper</groupId>    <artifactId>pagehelper</artifactId>    <version>4.1.6</version></dependency>

<plugininterceptor="com.github.pagehelper.PageHelper">    <propertyname="dialect"value="mysql" />    <propertyname="offsetAsPageNum"value="true" />    <propertyname="rowBoundsWithCount"value="true" />    <propertyname="pageSizeZero"value="true" />    <propertyname="reasonable"value="false" /></plugin>

// 设置分页参数PageHelper.startPage(1, 5);// 执行查询List<User> list = userMapper.selectUserList();

@Intercepts({    @Signature(type = Executor.class, method = "query", ...)})public class PageHelper implements Interceptor {    // ...}

public Object intercept(Invocation invocation) throws Throwable {    if (autoRuntimeDialect) { // 多数据源        SqlUtil sqlUtil = getSqlUtil(invocation);        return sqlUtil.processPage(invocation);    } else { // 单数据源        if (autoDialect) {            initSqlUtil(invocation);        }        return sqlUtil.processPage(invocation);    }}

public static Parser newParser(Dialect dialect) {    Parser parser = null;    switch (dialect) {        case mysql:        case mariadb:        case sqlite:            parser = new MysqlParser();            break;        case oracle:            parser = new OracleParser();            break;        case sqlserver:            parser = new SqlServerParser();            break;        // ... 其他数据库方言    }    return parser;}

@Overrideprotected BoundSql getPageBoundSql(Object parameterObject) {    String tempSql = sql;    String orderBy = PageHelper.getOrderBy();    if (orderBy != null) {        tempSql = OrderByParser.converToOrderBySql(sql, orderBy);    }    // 根据方言生成对应的分页 SQL    tempSql = localParser.get().getPageSql(tempSql);    return new BoundSql(configuration, tempSql, ...);}

SELECT * FROM user LIMIT ?, ?