MyBatis中如何实现自定义插件

比如可以使用自定义插件来添加分页参数,或统计sql的执行时间,实现方式为:

  1. 创建插件类并实现Interceptor接口
  • intercept():编写拦截逻辑,在目标方法前后执行自定义操作。
  • plugin():返回目标对象的代理对象。
  • setProperties():接收配置文件中的参数(可选)。
java 复制代码
import org.apache.ibatis.executor.statement.StatementHandler;
import org.apache.ibatis.mapping.BoundSql;
import org.apache.ibatis.mapping.MappedStatement;
import org.apache.ibatis.plugin.*;
import org.apache.ibatis.reflection.MetaObject;
import org.apache.ibatis.reflection.SystemMetaObject;
import java.sql.Connection;
import java.util.Properties;

@Intercepts({
    @Signature(
        type = StatementHandler.class,
        method = "prepare",
        args = {Connection.class, Integer.class}
    )
})
public class PaginationPlugin implements Interceptor {

    private String dialect = "mysql"; // 默认数据库类型

    @Override
    public Object intercept(Invocation invocation) throws Throwable {
        StatementHandler handler = (StatementHandler) invocation.getTarget();
        MetaObject metaObject = SystemMetaObject.forObject(handler);
        
        // 获取原始SQL和分页参数
        BoundSql boundSql = handler.getBoundSql();
        String originalSql = boundSql.getSql();
        Object parameterObject = boundSql.getParameterObject();

        // 检查是否包含分页参数
        if (parameterObject instanceof Page<?>) {
            Page<?> page = (Page<?>) parameterObject;
            
            // 修改SQL添加分页
            String paginatedSql = buildPaginationSql(originalSql, page);
            metaObject.setValue("delegate.boundSql.sql", paginatedSql);
            
            // 设置分页参数(LIMIT和OFFSET)
            metaObject.setValue("delegate.boundSql.parameterObject", page.getData());
        }
        
        return invocation.proceed();
    }

    // 构建分页SQL
    private String buildPaginationSql(String sql, Page<?> page) {
        int offset = (page.getPageNum() - 1) * page.getPageSize();
        if ("mysql".equals(dialect)) {
            return sql + " LIMIT " + page.getPageSize() + " OFFSET " + offset;
        } else if ("oracle".equals(dialect)) {
            // Oracle分页逻辑(使用ROWNUM)
            return "SELECT * FROM ( SELECT tmp.*, ROWNUM rn FROM (" + sql + ") tmp ) WHERE rn > " 
                   + offset + " AND rn <= " + (offset + page.getPageSize());
        }
        return sql;
    }

    @Override
    public Object plugin(Object target) {
        // 包装目标对象,返回代理
        return Plugin.wrap(target, this);
    }

    @Override
    public void setProperties(Properties properties) {
        // 提取参数
        this.dialect = properties.getProperty("dialect", "mysql");
    }
}
  1. 使用@Intercepts注解指定拦截目标

@Signature注解定义要拦截的类、方法及参数类型。例如:

  • type:拦截的接口(如ExecutorStatementHandler)。
  • method:方法名。
  • args:方法的参数类型数组。
  1. 注册插件到MyBatis配置
xml 复制代码
<plugins>
    <plugin interceptor="com.example.PaginationPlugin">
        <property name="dialect" value="mysql"/>
    </plugin>
</plugins>
  1. mapper层使用示例
less 复制代码
public interface UserMapper {
    @Pageable
    List<User> selectByCondition(@Param("page") Page<User> page, @Param("name") String name);
}

注意事项:

  • 仅支持拦截四大接口ExecutorStatementHandlerParameterHandlerResultSetHandler
  • 方法签名匹配 :需确保@Signature中的参数类型与目标方法完全一致。
  • 性能影响:过度使用插件可能影响性能,建议仅在必要时使用。
相关推荐
渡我白衣3 小时前
C++ 异常处理全解析:从语法到设计哲学
开发语言·c++·面试
꒰ঌ 安卓开发໒꒱3 小时前
Java面试-并发面试(一)
java·jvm·面试
何中应4 小时前
MyBatis-Plus字段类型处理器使用
java·数据库·后端·mybatis
聪明的笨猪猪4 小时前
Java SE “面向对象”面试清单(含超通俗生活案例与深度理解)
java·经验分享·笔记·面试
聪明的笨猪猪4 小时前
Java 集合 “List + Set”面试清单(含超通俗生活案例与深度理解)
java·经验分享·笔记·面试
绝无仅有5 小时前
资深面试题之MySQL问题及解答(二)
后端·面试·github
绝无仅有5 小时前
某大厂库存秒杀的设计与实现总结
后端·面试·github
Archie_IT6 小时前
嵌入式八股文篇——P1 关键字篇
c语言·开发语言·单片机·mcu·物联网·面试·职场和发展
似水流年,是谁苍白了等待6 小时前
Spring Boot + MyBatis plus + MySQL 实现位置直线距离实时计算
spring boot·mysql·mybatis
聪明的笨猪猪8 小时前
Java SE “泛型 + 注解 + 反射”面试清单(含超通俗生活案例与深度理解)
java·经验分享·笔记·面试