MyBatis(九)插件

于 2021-10-18 20:31:53 发布
阅读量105 收藏
点赞数
分类专栏： MyBatis 文章标签： java mybatis
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_44966780/article/details/120832412
版权
本文详细介绍了MyBatis插件的开发过程，包括如何使用Interceptor接口实现拦截StatementHandler方法，动态改变SQL参数，以及插件在执行流程中的作用。通过实例演示了插件如何层层包裹对象并影响查询结果。
摘要由CSDN通过智能技术生成

插件

  • MyBatis在四大对象的创建过程中，都会有插件进行介入。插件可以利用动态代理机制一层层的包装目标对象，而实现在目标对象执行目标方法之前进行拦截的效果。
  • MyBatis 允许在已映射语句执行过程中的某一点进行拦截调用。
  • 默认情况下，MyBatis 允许使用插件来拦截的方法调用
    包括：
    • Executor (update, query, flushStatements, commit, rollback, getTransaction, close, isClosed)
    • ParameterHandler (getParameterObject, setParameters)
    • ResultSetHandler (handleResultSets, handleOutputParameters)
    • StatementHandler (prepare, parameterize, batch, update, query)

插件开发

• 插件开发步骤
1）、编写插件类实现Interceptor接口，并使用@Intercepts注解完成插件签名

package com.xiaoqiu.dao;

import org.apache.ibatis.executor.statement.StatementHandler;
import org.apache.ibatis.plugin.*;

import java.util.Properties;

/**
 * @author 小邱
 * @version 0.0.1
 * @description MyFirstPlugin
 * @since 2021/10/18 19:31
 */
//完成插件签名：告诉MyBatis当前插件用来拦截哪个对象的哪个方法
@Intercepts({@Signature(type= StatementHandler.class,method="parameterize",args=java.sql.Statement.class)})
public class MyFirstPlugin implements Interceptor {


    //intercept：拦截：拦截目标对象的目标方法的执行
    @Override
    public Object intercept(Invocation invocation) throws Throwable {

        System.out.println("MyFirstPlugin...intercept:"+invocation.getMethod());

        //执行目标方法
        Object proceed = invocation.proceed();
        //返回执行后的返回值
        return proceed;
    }

    //plugin：包装目标对象的：包装：为目标对象创建一个代理对象
    @Override
    public Object plugin(Object target) {

        System.out.println("MyFirstPlugin...plugin:mybatis将要包装的对象"+target);

        //我们可以借助Plugin的wrap方法来使用当前Interceptor包装我们目标对象
        Object wrap = Plugin.wrap(target, this);
        //返回为当前target创建的动态代理
        return wrap;
    }

    //setProperties：将插件注册时 的property属性设置进来
    @Override
    public void setProperties(Properties properties) {

        System.out.println("插件配置的信息："+properties);

    }
}

2）、在全局配置文件中注册插件

<plugins>
	<plugin interceptor="com.xiaoqiu.dao.MyFirstPlugin">
		<property name="username" value="root"/>
		<property name="password" value="root"/>
	</plugin>
</plugins>

3）、测试

public class MyBatisTest {
    public static SqlSessionFactory getSqlSessionFactory() throws IOException {
        String resource = "mybatis-config.xml";
        InputStream inputStream = Resources.getResourceAsStream(resource);
        return new SqlSessionFactoryBuilder().build(inputStream);
    }

    public static void main(String[] args) {
        try {
            EmployeeMapper mapper = getSqlSessionFactory().openSession().getMapper(EmployeeMapper.class);
            Employee emp = mapper.getEmpById(10);
            System.out.println(emp);
        } catch (IOException e) {
            e.printStackTrace();
        }
    }


}

运行结果：
在这里插入图片描述

Interceptor接口

• Intercept：拦截目标方法执行
• plugin：生成动态代理对象，可以使用MyBatis提供的Plugin类的wrap方法
• setProperties：注入插件配置时设置的属性

插件原理

在四大对象创建的时候
1）、按照插件注解声明，按照插件配置顺序调用插件plugin方法，每个创建出来的对象不是直接返回的，而是生成被拦截对象的动态代理。
interceptorChain.pluginAll(parameterHandler);
2）、多个插件依次生成目标对象的代理对象，层层包裹，先声明的先包裹；形成代理链
3）、获取到所有的Interceptor（拦截器）（插件需要实现的接口），目标方法执行时依次从外到内执行调用interceptor.plugin(target)。返回target包装后的对象。
4）、多个插件情况下，我们往往需要在某个插件中分离出目标对象。可以借助MyBatis提供的SystemMetaObject类来进行获取最后一层的h以及target属性的值
5）、插件机制，我们可以使用插件为目标对象创建一个代理对象；AOP（面向切面）

多个插件执行

添加第二个插件

package com.xiaoqiu.dao;

import java.util.Properties;

import org.apache.ibatis.executor.statement.StatementHandler;
import org.apache.ibatis.plugin.Interceptor;
import org.apache.ibatis.plugin.Intercepts;
import org.apache.ibatis.plugin.Invocation;
import org.apache.ibatis.plugin.Plugin;
import org.apache.ibatis.plugin.Signature;

@Intercepts({@Signature(type=StatementHandler.class,method="parameterize",args=java.sql.Statement.class)})
public class MySecondPlugin implements Interceptor{

	@Override
	public Object intercept(Invocation invocation) throws Throwable {
		System.out.println("MySecondPlugin...intercept:"+invocation.getMethod());
		return invocation.proceed();
	}

	@Override
	public Object plugin(Object target) {

		System.out.println("MySecondPlugin...plugin:"+target);
		return Plugin.wrap(target, this);
	}

	@Override
	public void setProperties(Properties properties) {
		System.out.println("MySecondPlugin--properties");
	}

}


<plugin interceptor="com.xiaoqiu.dao.MySecondPlugin"></plugin>

测试代码不变，运行结果：

插件配置的信息：{password=root, username=root}
MySecondPlugin--properties
MyFirstPlugin...plugin:mybatis将要包装的对象org.apache.ibatis.executor.CachingExecutor@396a51ab
MySecondPlugin...plugin:org.apache.ibatis.executor.CachingExecutor@396a51ab
MyFirstPlugin...plugin:mybatis将要包装的对象org.apache.ibatis.scripting.defaults.DefaultParameterHandler@3e6fa38a
MySecondPlugin...plugin:org.apache.ibatis.scripting.defaults.DefaultParameterHandler@3e6fa38a
MyFirstPlugin...plugin:mybatis将要包装的对象org.apache.ibatis.executor.resultset.DefaultResultSetHandler@1bce4f0a
MySecondPlugin...plugin:org.apache.ibatis.executor.resultset.DefaultResultSetHandler@1bce4f0a
MyFirstPlugin...plugin:mybatis将要包装的对象org.apache.ibatis.executor.statement.RoutingStatementHandler@5c3bd550
MySecondPlugin...plugin:org.apache.ibatis.executor.statement.RoutingStatementHandler@5c3bd550
DEBUG 10-18 20:09:11,007 ==>  Preparing: select id, last_name lastName, email, gender from tbl_employee where id = ?   (BaseJdbcLogger.java:145) 
MySecondPlugin...intercept:public abstract void org.apache.ibatis.executor.statement.StatementHandler.parameterize(java.sql.Statement) throws java.sql.SQLException
MyFirstPlugin...intercept:public abstract void org.apache.ibatis.executor.statement.StatementHandler.parameterize(java.sql.Statement) throws java.sql.SQLException
DEBUG 10-18 20:09:11,069 ==> Parameters: 10(Integer)  (BaseJdbcLogger.java:145) 
DEBUG 10-18 20:09:11,118 <==      Total: 1  (BaseJdbcLogger.java:145) 
Employee [id=10, lastName=李四, email=lisi@qq.com, gender=1]

Process finished with exit code 0

在这里插入图片描述
案例：动态的改变一下sql运行的参数：以前1号员工，实际从数据库查询3号员工

package com.xiaoqiu.dao;

import org.apache.ibatis.executor.statement.StatementHandler;
import org.apache.ibatis.plugin.*;
import org.apache.ibatis.reflection.MetaObject;
import org.apache.ibatis.reflection.SystemMetaObject;

import java.util.Properties;

@Intercepts({@Signature(type=StatementHandler.class,method="parameterize",args=java.sql.Statement.class)})
public class MyThirdPlugin implements Interceptor{

	@Override
	public Object intercept(Invocation invocation) throws Throwable {
		//动态的改变一下sql运行的参数：以前1号员工，实际从数据库查询3号员工
		Object target = invocation.getTarget();
		System.out.println("当前拦截到的对象："+target);
		//拿到：StatementHandler==>ParameterHandler===>parameterObject
		//拿到target的元数据
		MetaObject metaObject = SystemMetaObject.forObject(target);
		Object value = metaObject.getValue("parameterHandler.parameterObject");
		System.out.println("sql语句用的参数是："+value);
		//修改完sql语句要用的参数
		metaObject.setValue("parameterHandler.parameterObject", 3);
		//执行目标方法
		Object proceed = invocation.proceed();
		//返回执行后的返回值
		return proceed;
	}

	@Override
	public Object plugin(Object target) {
		return Plugin.wrap(target, this);
	}

	@Override
	public void setProperties(Properties properties) {

	}

}


<plugin interceptor="com.xiaoqiu.dao.MyThirdPlugin"></plugin>

测试代码

public class MyBatisTest {
    public static SqlSessionFactory getSqlSessionFactory() throws IOException {
        String resource = "mybatis-config.xml";
        InputStream inputStream = Resources.getResourceAsStream(resource);
        return new SqlSessionFactoryBuilder().build(inputStream);
    }

    public static void main(String[] args) {
        try {
            EmployeeMapper mapper = getSqlSessionFactory().openSession().getMapper(EmployeeMapper.class);
            Employee emp = mapper.getEmpById(1);
            System.out.println(emp);
        } catch (IOException e) {
            e.printStackTrace();
        }
    }


}

运行结果：

DEBUG 10-18 20:27:58,037 ==>  Preparing: select id, last_name lastName, email, gender from tbl_employee where id = ?   (BaseJdbcLogger.java:145) 
当前拦截到的对象：org.apache.ibatis.executor.statement.RoutingStatementHandler@23348b5d
sql语句用的参数是：1
DEBUG 10-18 20:27:58,192 ==> Parameters: 3(Integer)  (BaseJdbcLogger.java:145) 
DEBUG 10-18 20:27:58,246 <==      Total: 1  (BaseJdbcLogger.java:145) 
Employee [id=3, lastName=jerry, email=jerry@qq.com, gender=0]

Process finished with exit code 0

运行原理：
在这里插入图片描述

SuperQiu~
关注
专栏目录
MyBatisX插件的jar包安装文件.zip
11-10
MyBatisX是一款针对IntelliJ IDEA开发的高效MyBatis插件，旨在提升开发者在使用MyBatis框架时的工作效率。这款插件的核心功能包括智能代码提示、SQL语句编辑与预览、Mapper接口与XML配置文件的联动等，为Java开发...
MyBatisX 插件离线安装包
07-06
MyBatisX是一款深受开发者喜爱的IDEA插件，它为使用MyBatis框架的开发工作提供了诸多便利。本离线安装包专为IDEA 2021版本设计，无需网络连接即可进行安装，方便那些网络环境受限或追求效率的开发者。 1. **MyBatis...
MyBatis - 三剑客之 Mybatis-Plugin
陆氪和他的那些代码
01-05 448
前言 IDEA 的超级好用的 Mybatis 的插件，可以实现 mybatis 的接口文件和实现 xml 自动跳转，验证正确性，在 xml 中智能提示等功能。 Ps：由于网上破解版很多，但是 IDEA2018.3 版本被限制严重，所以推荐一款类似国内开发的插件：MyBatisCodeHelperPro ...
Mybatis配置文件（六）：plugins配置
weixin_42762407的博客
12-27 1364
在MyBatis中，对某种方法进行拦截调用的机制，被称为plugin插件。使用plugin科技监控方法的调用，还能修改或重写方法逻辑。mybatis中允许使用plugin拦截的方法如下： Executor // 操作接口类 (update, query, flushStatements, commit, rollback, getTransaction, close, isClosed) Pa...
超级实用的MybatisPlugin插件
zhangxingyu126的博客
05-27 4275
在ssm框架下使用MyBatisPlugin插件可实现 快捷键生成xml文件及sql标签； dao层接口到mapper.xml的相互跳转； 编写sql时的参数，括号，关键字补全（sql语句不补全）； 自动检查Mapper.xml文件中的ID冲突和错误的属性值。 加速开发，非常方便。 破解版idea直接安装：(适用于IDEA2017,新版IDEA需要下载更高版本插件) ctrl+alt+s打开idea设置，选择plugins----Install plugin from disk 成功后da
IDEA中的Mybatis Plugin 安装及破解
cherry_xiu的博客
04-11 4918
插件来源：IntelliJ Idea Mybatis Plugin 安装及破解 此为本地安装教程，若直接使用IDEA安装mybatis plugins，参考Intellij IDEA中使用MyBatis plugin插件安装教程及破解方法 安装mybatis_plus（mybatis_plus为插件） 1.先下载安装包及激活文件 2.下载完成后解压，把mybatis_plus文件放在如...
mybatis-plugin is not activated yet解决办法
weixin_40904220的博客
07-16 3961
原文链接：http://myoss.github.io/2016/MyBatis-Plugin-%E5%AD%A6%E4%B9%A0%E4%BD%BF%E7%94%A8/   经过本人亲自验证，非常有效，分享给大家！ 关于本教程 以下教程仅供学习使用，针对于IntelliJ Idea 15（目前已经支持IntelliJ Idea 2016）中的Mybatis Plugin插件（https:...
IDEA mybatis日志插件mybatis log plugin
07-31
亲测可用
IDEA的MyBatis插件两个
最新发布
03-07
本篇文章将详细介绍两个针对MyBatis框架的IntelliJ IDEA插件——MyBatisCodeHelper-Pro和MybatisX，它们都是为了提升MyBatis开发体验而设计的。 首先，我们来看MyBatisCodeHelper-Pro。这款插件是专为MyBatis开发者...
mybatisx官方插件
03-03
MybatisX 是一款基于 IDEA 的快速开发插件，为效率而生。 安装方法：打开 IDEA，进入 File -> Settings -> Plugins -> Browse Repositories，输入 mybatisx 搜索并安装。 无法打开的，下载插件安装
Mybatis plugin工具
PFPT的博客
09-08 390
上来先扔一个Free Mybatis plugin工具链接：https://plugins.jetbrains.com/plugin/8321-free-mybatis-plugin 。 我用的IDEA2019，这是在一个评论区看到的回答，链接给的是一个免费的Mybatis plugin工具，打开是下边的页面： 选择自己想要的版本下载，我是选择第一个，2018.05.17这个下载下来拿到了...
idea快速安装mybatis plugin
weixin_30911809的博客
10-08 334
话不多说，先上一个地址：https://github.com/FanVV/mybatis_plus。 该插件好用的一个功能在于可以实现dao与xml文件之间的切换， 点击箭头便可以直接跳转到xml文件， 当跳转到xml之后，再点击箭头可以直接回到dao，非常方便。 至于该插件的安装还是很简单的， 第一步：在github上下载压缩包； 第二步：下载完成之后解压压缩包； 第三...
Mybatis Plugin插件安装破解及使用
gqsunrise
04-12 2329
Mybatis Plugin 一、Mybatis Plugin插件是什么 提供Mapper接口与配置文件中对应SQL的导航 编辑XML文件时自动补全 根据Mapper接口, 使用快捷键生成xml文件及SQL标签 ResultMap中的property支持自动补全，支持级联(属性A.属性B.属性C) 快捷键生成@Param注解 XML...
MybatisCodeHelperPro破解方法[2019最新有效]
热门推荐
localhost
05-04 5万+
https://zhile.io/2019/04/23/mybatis-code-helper-pro-crack.html
MyBatisCodeHelper-Pro插件使用（2021）
JavaPub
01-19 9781
文章目录前言解压安装使用官方安装 前言 提供俩种方式 解压安装使用 zip导入， 官方安装 官网下载安装 处理 参考：https://zhile.io/2019/04/23/mybatis-code-helper-pro-crack.html
方便好用的 Idea mybatis 插件 MyBatisCodeHelper
吖脖（博）
03-30 2万+
给大家推荐一个 idea mybatis的插件：MyBatisCodeHelper 源码gitHub地址：https://github.com/gejun123456/MyBatisCodeHelper 优点： 1、mapper文件（即表对应的dao）与xml文件自由切换，方便代码评审； 2、自动代码生成功能提供开发效率
MybatisPlugin实现及原理
zhangxm_qz的博客
03-28 7612
Plugins 简单理解为拦截器，既然是拦截器说白了一般都是动态代理来实现对目标方法的拦截，在前后做一些操作。 在mybatis将这种东西，称之为plugin，配置在mybatis-config.xml配置文件中，通过 标签配置。在mybatis中，可以被拦截的目标主要是： 1. StatementHandler; 2. ParameterHandler; 3. ResultSetHandler;...
Mybatis反编译插件MybatisHelperPro
瞌睡虫的博客
01-30 1456
mybatis 反编译可视化插件
Spring Mybatis 分页插件实战教程
1. **Mybatis插件机制**：理解插件在Mybatis中的作用，以及如何利用拦截器思想实现分页逻辑。 2. **方言类设计**：创建抽象的分页方言类，提供数据库无关的接口，便于根据不同数据库定制不同的分页实现。 3. **...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值