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中的参数类型与目标方法完全一致。
  • 性能影响:过度使用插件可能影响性能,建议仅在必要时使用。
相关推荐
DuelCode2 小时前
Windows VMWare Centos Docker部署Springboot 应用实现文件上传返回文件http链接
java·spring boot·mysql·nginx·docker·centos·mybatis
荔枝吻4 小时前
【沉浸式解决问题】idea开发中mapper类中突然找不到对应实体类
java·intellij-idea·mybatis
独行soc5 小时前
#渗透测试#批量漏洞挖掘#HSC Mailinspector 任意文件读取漏洞(CVE-2024-34470)
linux·科技·安全·网络安全·面试·渗透测试
JAVA学习通5 小时前
Mybatis--动态SQL
sql·tomcat·mybatis
小飞悟6 小时前
你以为 React 的事件很简单?错了,它暗藏玄机!
前端·javascript·面试
掘金安东尼8 小时前
技术解析:高级 Excel 财务报表解析器的架构与实现
前端·javascript·面试
天天扭码8 小时前
AI时代,前端如何处理大模型返回的多模态数据?
前端·人工智能·面试
阳火锅8 小时前
都2025年了,来看看前端如何给刘亦菲加个水印吧!
前端·vue.js·面试
Java技术小馆9 小时前
GitDiagram如何让你的GitHub项目可视化
java·后端·面试
UGOTNOSHOT9 小时前
7.4项目一问题准备
面试