Mybatis 3 自定义Plugin

最新推荐文章于 2024-12-18 11:06:54 发布

原创最新推荐文章于 2024-12-18 11:06:54 发布 · 213 阅读

0 ·

CC 4.0 BY-SA版权

java基础同时被 2 个专栏收录

3 篇文章

订阅专栏

spring boot

3 篇文章

订阅专栏

本文详细介绍了如何在MyBatis3中实现自定义插件，通过继承Interceptor接口并实现特定方法，可以对Executor、ParameterHandler等关键组件进行拦截调用，从而扩展MyBatis的功能。同时，提供了在mybatis-config.xml中配置插件的方法。

Mybatis 3 自定义plugin

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

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

详情请参考官网

实现自定义plugin

只需实现 Interceptor 接口，即可以定义自己的plugin

package com.example.plugin;

import org.apache.ibatis.executor.Executor;
import org.apache.ibatis.mapping.MappedStatement;
import org.apache.ibatis.plugin.Interceptor;
import org.apache.ibatis.plugin.Intercepts;
import org.apache.ibatis.plugin.Invocation;
import org.apache.ibatis.plugin.Signature;
import org.apache.ibatis.session.ResultHandler;
import org.apache.ibatis.session.RowBounds;

@Intercepts({
        @Signature(type = Executor.class, method = "query", args = {MappedStatement.class,Object.class, RowBounds.class, ResultHandler.class})
})
public class MyPlugin implements Interceptor {
    @Override
    public Object intercept(Invocation invocation) throws Throwable {
        System.out.println("要拦截的方法:" + invocation.getMethod());
        Object prObject = invocation.proceed();
        return prObject;
    }
}

mybatis 加载plugin

在mybatis-config.xml中添加plugin配置

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration
        PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
    <plugins>
        <plugin interceptor="com.example.plugin.MyPlugin"></plugin>
    </plugins>
</configuration>

在application.xml引用mybatis-config.xml

mybatis:
  type-handlers-package: com.example.handler
  config-location: classpath:mybatis-config.xml

mybatis-config配置详情参考官网

验证插件效果

发送查询请求

1Za2iB

查看自己写的插件是否生效

S520lZ