MyBatis 如何编写一个自定义插件？

灰太狼 2022-12-18 12:53 205阅读 0赞

### 先看如何自定义一个插件 ###

1、新建类实现 Interceptor 接口，并指定想要拦截的方法签名

/**
     * MyBatis 插件
     */
    @Intercepts({@Signature(type = Executor.class, method = "query", args = {MappedStatement.class, Object.class, RowBounds.class, ResultHandler.class})})
    public class ExamplePlugin implements Interceptor {
    
        @Override
        public Object intercept(Invocation invocation) throws Throwable {
            for (Object arg : invocation.getArgs()) {
                System.out.println("参数：" + arg);
            }
            System.out.println("方法：" + invocation.getMethod());
            System.out.println("目标对象：" + invocation.getTarget());
            Object result = invocation.proceed();
    
            //只获取第一个数据
            if (result instanceof List){
                System.out.println("原集合数据：" + result);
                System.out.println("只获取第一个对象");
                List list = (List)result;
                return Arrays.asList(list.get(0));
            }
            return result;
        }
    }

2、MyBatis 配置文件中添加该插件

测试代码

System.out.println("------userMapper.deleteUsers()------");
    //删除 user
    userMapper.deleteUsers();
    
    System.out.println("------userMapper.insertUser()------");
    //插入 user
    for (int i = 1; i <= 5; i++) {
        userMapper.insertUser(new User(i, "ConstXiong" + i));
    }
    
    System.out.println("------userMapper.selectUsers()------");
    //查询所有 user
    List<User> users = userMapper.selectUsers();
    System.out.println(users);

打印结果

------userMapper.deleteUsers()------
    ------userMapper.insertUser()------
    ------userMapper.selectUsers()------
    参数：org.apache.ibatis.mapping.MappedStatement@58c1c010
    参数：null
    参数：org.apache.ibatis.session.RowBounds@b7f23d9
    参数：null
    方法：public abstract java.util.List org.apache.ibatis.executor.Executor.query(org.apache.ibatis.mapping.MappedStatement,java.lang.Object,org.apache.ibatis.session.RowBounds,org.apache.ibatis.session.ResultHandler) throws java.sql.SQLException
    目标对象：org.apache.ibatis.executor.CachingExecutor@61d47554
    原集合数据：[User{id=1, name='ConstXiong1', mc='null'}, User{id=2, name='ConstXiong2', mc='null'}, User{id=3, name='ConstXiong3', mc='null'}, User{id=4, name='ConstXiong4', mc='null'}, User{id=5, name='ConstXiong5', mc='null'}]
    只获取第一个对象
    [User{id=1, name='ConstXiong1', mc='null'}]

插件功能的官网说明

> MyBatis 允许你在映射语句执行过程中的某一点进行拦截调用。默认情况下，MyBatis 允许使用插件来拦截的方法调用包括：
> 
>  *  Executor (update, query, flushStatements, commit, rollback, getTransaction, close, isClosed)
>  *  ParameterHandler (getParameterObject, setParameters)
>  *  ResultSetHandler (handleResultSets, handleOutputParameters)
>  *  StatementHandler (prepare, parameterize, batch, update, query)

完整 Demo：

[https://www.javanav.com/val/a5535343f9b545eda9665f03d62345ba.html][https_www.javanav.com_val_a5535343f9b545eda9665f03d62345ba.html]

PS：MyBatis 分页插件 PagerHelper，就是一个很好的插件学习例子。

--------------------

### 【Java面试题与答案】整理推荐 ###

*  [基础与语法][Link 1]
 *  [集合][Link 2]
 *  [网络编程][Link 3]
 *  [并发编程][Link 4]
 *  [Web][]
 *  [安全][Link 5]
 *  [设计模式][Link 6]
 *  [框架][Link 7]
 *  [算法与数据结构][Link 8]
 *  [异常][Link 9]
 *  [文件解析与生成][Link 10]
 *  [Linux][]
 *  [MySQL][]
 *  [Oracle][]
 *  [Redis][]
 *  [Dubbo][]

[https_www.javanav.com_val_a5535343f9b545eda9665f03d62345ba.html]: https://www.javanav.com/val/a5535343f9b545eda9665f03d62345ba.html
[Link 1]: https://www.javanav.com/interview/93b0069472fd479393006c0e73043fc4.html
[Link 2]: https://www.javanav.com/interview/4147d95e693945e7a50345fd33ec817e.html
[Link 3]: https://www.javanav.com/interview/68a57ffc78de4133bb890bdd502ac418.html
[Link 4]: https://www.javanav.com/interview/36a24fa3258e45c89873f474ce914912.html
[Web]: https://www.javanav.com/interview/4e27cb63adb440c6825a159d35cf4010.html
[Link 5]: https://www.javanav.com/interview/03affb2ce3f04fda8853f714e5764906.html
[Link 6]: https://www.javanav.com/interview/07a32a9ff17a4006a53550ce658cafed.html
[Link 7]: https://www.javanav.com/interview/5c466456e9b54ab0a749b5948e51f1d3.html
[Link 8]: https://www.javanav.com/interview/943f917041ee4f05add24539f5b861b2.html
[Link 9]: https://www.javanav.com/interview/d3f058cfc05d4c6dadd821b622e84d36.html
[Link 10]: https://www.javanav.com/interview/67a50996c28f418e83b109ea42fc3eff.html
[Linux]: https://www.javanav.com/interview/00cccb81729540d1923bd0a0ef49533a.html
[MySQL]: https://www.javanav.com/interview/d311e78502a845f1a4bb307bd6aec2b3.html
[Oracle]: https://www.javanav.com/interview/5f29e9677edf4a16be3dce30d257c9ab.html
[Redis]: https://www.javanav.com/interview/066c62b3af4d4827b2243a822c3084a9.html
[Dubbo]: https://www.javanav.com/interview/9a3e7a7740324757abaab953f7ebc455.html