Mybaits(15)-Mybatis插件

最新推荐文章于 2024-06-21 09:30:47 发布
最新推荐文章于 2024-06-21 09:30:47 发布
阅读量544 收藏
点赞数
分类专栏： mybatis3 文章标签： java mybatis ibatis 后端
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_37171506/article/details/121849857
版权

 

目录

 插件原理

项目DEMO

        Mybatis全局配置文件

         Mybatis映射文件

        实体类

        Mapper接口

编写一个Mybatis插件

        插件编写步骤  

        新建自定插件类

        测试类

        测试结果

        源码分析

​多个插件运行流程

         新建MySecondPlugin插件

        注册MySecondPlugin插件

        测试结果

开发插件

 插件原理

/**
	 * 插件原理
	 * 在四大对象创建的时候
	 * 1、每个创建出来的对象不是直接返回的，而是
	 * 		interceptorChain.pluginAll(parameterHandler);包装后，再返回的。
	 * 2、获取到所有的Interceptor（拦截器）（插件需要实现的接口）；
	 * 		调用interceptor.plugin(target);返回target包装后的对象
	 * 3、插件机制，我们可以使用插件为目标对象创建一个代理对象；AOP（面向切面）
	 * 		我们的插件可以为四大对象创建出代理对象；
	 * 		代理对象就可以拦截到四大对象的每一个执行；
	 * 
		public Object pluginAll(Object target) {
		    for (Interceptor interceptor : interceptors) {
		      target = interceptor.plugin(target);
		    }
		    return target;
		  }
		
*/

项目DEMO

        Mybatis全局配置文件

<?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：注册插件  -->
	<plugins>
		<plugin interceptor="com.atguigu.mybatis.dao.MyFirstPlugin">
			<property name="username" value="root"/>
			<property name="password" value="123456"/>
		</plugin>

	</plugins>
	<environments default="development">
		<environment id="development">
			<transactionManager type="JDBC" />
			<dataSource type="POOLED">
				<property name="driver" value="com.mysql.jdbc.Driver" />
				<property name="url" value="jdbc:mysql://localhost:3306/mybatis" />
				<property name="username" value="root" />
				<property name="password" value="123456" />
			</dataSource>
		</environment>
	</environments>
	<!-- 将我们写好的sql映射文件（EmployeeMapper.xml）一定要注册到全局配置文件（mybatis-config.xml）中 -->
	<mappers>
		<mapper resource="EmployeeMapper.xml" />
	</mappers>
</configuration>

         Mybatis映射文件

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper
 PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
 "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.atguigu.mybatis.dao.EmployeeMapper">
	<select id="getEmpById" resultType="com.atguigu.mybatis.bean.Employee">
		select id,last_name lastName,email,gender from tbl_employee where id = #{id}
	</select>
</mapper>

        实体类

package com.atguigu.mybatis.bean;

public class Employee {
	
	private Integer id;
	private String lastName;
	private String email;
	private String gender;
	
	
	public Integer getId() {
		return id;
	}
	public void setId(Integer id) {
		this.id = id;
	}
	public String getLastName() {
		return lastName;
	}
	public void setLastName(String lastName) {
		this.lastName = lastName;
	}
	public String getEmail() {
		return email;
	}
	public void setEmail(String email) {
		this.email = email;
	}
	public String getGender() {
		return gender;
	}
	public void setGender(String gender) {
		this.gender = gender;
	}
	@Override
	public String toString() {
		return "Employee [id=" + id + ", lastName=" + lastName + ", email="
				+ email + ", gender=" + gender + "]";
	}
}

        Mapper接口

package com.atguigu.mybatis.dao;

import com.atguigu.mybatis.bean.Employee;

public interface EmployeeMapper {
	public Employee getEmpById(Integer id);
}

编写一个Mybatis插件

        插件编写步骤  

1、编写Interceptor的实现类
2、使用@Intercepts注解完成插件签名
3、将写好的插件注册到全局配置文件中

        新建自定插件类

package com.atguigu.mybatis.dao;

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

import java.sql.Statement;
import java.util.Properties;

/**
 * @Intercepts 插件签名
 * 告诉Mybatis用当前插件来拦截那个对象的哪个方法
 */
@Intercepts({@Signature(type= StatementHandler.class,method="parameterize",args= Statement.class)})
public class MyFirstPlugin implements Interceptor {
    /**
     * 拦截目标方法的执行
     * @param invocation
     * @return
     * @throws Throwable
     */
    @Override
    public Object intercept(Invocation invocation) throws Throwable {
        //执行目标方法 直接被放行
        System.out.println("MyFirstPlugin......intercept:"+invocation.getMethod());
        Object proceed = invocation.proceed();
        return proceed;
    }

    /**
     * 包装目标对象，也就是为目标对象创建一个代理对象
     * @param o
     * @return
     */
    @Override
    public Object plugin(Object o) {
        //借助plugin的wrap方法来使用当前Interceptor包装目标对象
        System.out.println("MyFirstPlugin......plugin : Mybatis将要包装的对象" + o);
        Object wrap = Plugin.wrap(o, this);
        //返回创建的动态代理
        return wrap;
    }

    /**
     * 将插件注册时的properties的属性设置进来
     * @param properties
     */
    @Override
    public void setProperties(Properties properties) {
        System.out.println("插件的配置信息："+properties);
    }
}

        测试类

package com.atguigu.mybatis.test;

import java.io.IOException;
import java.io.InputStream;

import org.apache.ibatis.io.Resources;
import org.apache.ibatis.plugin.Interceptor;
import org.apache.ibatis.plugin.Intercepts;
import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;

import com.atguigu.mybatis.bean.Employee;
import com.atguigu.mybatis.dao.EmployeeMapper;
import org.junit.Test;

public class MyBatisTest {

	public SqlSessionFactory getSqlSessionFactory() throws IOException {
		String resource = "mybatis-config.xml";
		InputStream inputStream = Resources.getResourceAsStream(resource);
		return new SqlSessionFactoryBuilder().build(inputStream);
	}
	@Test
	public void test01() throws IOException {
		SqlSessionFactory sqlSessionFactory = getSqlSessionFactory();
		SqlSession openSession = sqlSessionFactory.openSession();
		try {
			EmployeeMapper mapper = openSession.getMapper(EmployeeMapper.class);
			Employee employee = mapper.getEmpById(1);
			System.out.println(mapper);
			System.out.println(employee);
		} finally {
			openSession.close();
		}
	}
}

        测试结果

        源码分析

        在我们编写的插件测试类中进行Debug

        变量signatureMap中存放的我们定义的插件签名和对应的方法，也就是使用当前插件拦截哪个类，哪个方法。变量type：目标对象的类型，当前是CacheExecutor对象。getAllInterfaces()判断type对象是不是在插件签名中。当前插件签名只拦截StatementHandler对象，所以当前不会反悔目标对象，直接返回目标对象。

        同样继续往下执行到DefaultParameterHandler对象，不在插件签名内，返回目标对象，不返回代理对象。

         同样继续往下执行到DefaultResultHandler对象，不在插件签名中，不返回代理对象，返回目标对象。

         执行到StatementHandler对象，确定是插件签名，返回目标对象的代理对象。最后再newStatementHandler()，创建StatementHandler对象时，实际返回的是RoutingStatementHandler对象。

         返回了目前的代理对象，然后执行目标方法：handler.parameterize(stmt);进入该方法，进入Plugins类中的invoke方法，最后就会进入MyFirstPlugin类的intercept方法。只有调用这个invocation.proceed()方法，才能对四大对象真正调用的方法进行拦截。所以通过这个我们可以在目标方法执行前后将参数修改一下。这样就可以介入mybatis的内部流程。

多个插件运行流程

        再定义一个MySecondPlugin插件，同样拦截的是StatementHandler的parameterize方法。

         新建MySecondPlugin插件

package com.atguigu.mybatis.dao;
import org.apache.ibatis.executor.statement.StatementHandler;
import org.apache.ibatis.plugin.*;
import java.sql.Statement;
import java.util.Properties;

@Intercepts({@Signature(type= StatementHandler.class,method="parameterize",args= Statement.class)})
public class MySecondPlugin implements Interceptor {
    @Override
    public Object intercept(Invocation invocation) throws Throwable {
        System.out.println("MySecondPlugin.......intercept:");
        return invocation.proceed();
    }

    @Override
    public Object plugin(Object o) {
        System.out.println("MySecondPlugin......plugin : Mybatis将要包装的对象" + o);
        Object wrap = Plugin.wrap(o, this);
        return wrap;
    }

    @Override
    public void setProperties(Properties properties) {
    }
}

        注册MySecondPlugin插件

<!--plugins：注册插件  -->
	<plugins>
		<plugin interceptor="com.atguigu.mybatis.dao.MyFirstPlugin">
			<property name="username" value="root"/>
			<property name="password" value="123456"/>
		</plugin>

		<plugin interceptor="com.atguigu.mybatis.dao.MySecondPlugin">
		</plugin>
	</plugins>

        测试结果

                可以看出:创建动态代理的时候，按照注册顺序创建层层代理对象。执行目标方法时，按照逆序方法执行。创建动态代理的时候，先创建StatementHandler的代理对象MyFirstPlugin，然后MySecondPlugin对象又对其进行包装代理。

 

 

开发插件

                场景：动态改变SQL的运行参数 。查询1号员工，实际从数据库中查询的是3号员工。

                修改MyFirstPlugin的intercept()方法：

 @Override
    public Object intercept(Invocation invocation) throws Throwable {
        //执行目标方法 直接被放行
        System.out.println("MyFirstPlugin......intercept:"+invocation.getMethod());
        System.out.println("当前拦截的对象："+invocation.getArgs());
        //拿到StatementHandler->ParameterHandler===>parameterObjet
        //拿到target的元数据
        MetaObject metaObject = SystemMetaObject.forObject(invocation.getTarget());
        Object value = metaObject.getValue("parameterHandler.parameterObject");
        System.out.println("sql语句用的参数是"+value);
        metaObject.setValue("parameterHandler.parameterObject",3);
        Object proceed = invocation.proceed();
        return proceed;
    }

        测试结果：sql语句用的参数是1 ，最后查询到的实际是3。

 

 

 

长_弓
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
Mybatis插件
kobe_626的博客
03-14 389
一.Mybatis核心对象 Configuration:存放所有配置信息的类，包括properties配置、plugin插件、Mapper映射、数据源等。 SqlSessionFactory：简而言之就是创建SqlSession的工厂类，通常由SqlSessionFactoryBuilder根据Configuration配置类生成。 SqlSession：SqlSession是一个接口，定义了增、删、改、查、事务回滚提交等接口。SqlSession中的sql操作是通过Executor、Statemen
free-mybatis-plugin免费插件
10-23
一款免费的idea插件，实现快速在dao层接口和xml方法之间进行切换，在Settings->plugins->install plugin from disk后选择该压缩包 安装重启idea即可
一款 IDEA Mybatis插件：极大提升 CRUD 效率，堪称神器！
最新发布
芋艿V
06-21 200
???? 这是一个或许对你有用的社群???? 一对一交流/面试小册/简历优化/求职解惑，欢迎加入「芋道快速开发平台」知识星球。下面是星球提供的部分资料：《项目实战（视频）》：从书中学，往事上“练”《互联网高频面试题》：面朝简历学习，春暖花开《架构 x 系统设计》：摧枯拉朽，掌控面试高频场景题《精进 Java 学习指南》：系统学习，互联网主流技术栈《必读 Java 源码专栏》：知其然，知其所以然????这是一个或许...
MyBatis 插件测试
qq949527860的博客
01-23 153
我这里只是拿了当前的sql语句，可以对它进行操作，然后可以将操作过后的sql语句反射回BoundSql。 就可以做分页或者其他功能，就不需要在映射文件写了。 通过 [size=medium][b][i]http://blog.csdn.net/hfmbook/article/details/41985853[/i][/b][/size] 这个大佬写的来学习的，写的很详细的 以下是代码...
mybatis 之 插件
u012391423的博客
07-08 191
目录 一、自定义插件 二、扫描 三、封装 四、执行 五、应用 一、自定义插件 mybatis的插件是代理模式 与 责任链模式的结合。 每一个插件以责任链并进行封装，都是一层对Executor的代理 @Intercepts({@Signature(type = Executor.class, method = "query", args = {MappedStatement.class, Object.class , RowBounds.class , ResultHandler.cla
Idea Mybatis 插件 free-idea-mybatis
06-20
Idea mybatis 插件 ，xml 各种提示 ，dao 层可以直接在 xml 文件生成方法，也可直接跳转到 xml
Free Mybatis plugin 2020.09.15版本
09-28
《Free Mybatis Plugin 2020.09.15版本：提升IDEA开发体验的新篇章》 在软件开发领域，高效的开发工具是程序员的得力助手。IntelliJ IDEA，作为广受开发者喜爱的Java集成开发环境（IDE），其丰富的插件库极大地提升...
idea mybatis-plugin 插件
11-21
"mybaits-plug"这个标签可能是对"Mybatis-plugin"的简化写法，它突出了插件与MyBatis框架的关联性。这表明该插件专注于MyBatis框架的开发辅助。 【文件名称列表】 "mybatis_plugin"可能代表的是该插件的安装文件或...
mybatis慢SQL插件
07-19
基于mybatis的慢SQL小插件，原理是mybatis拦截器。只需要在springboot的配置文件做简单的配置，mybatis拦截器将SQL中所有参数自动做了填充。拦截器监控慢SQL并将完整的可执行的SQL语句打印在日志文件中，复制该SQL...
mybatis插件
12-02
mybatis的插件!适用于idea2017和2018.1.5.喜欢拿走！！
MyBatis插件
12-19
MyBatis_Generator应用于MyEclipse中的MyBatis插件进行开发
Mybatis扩展插件XMBG.zip
07-16
XMBG 扩展自 Mybatis Generator插件，增加了一些： 扩展的方法 类型转换 命名转换（通过正则表达式） 增量生成 自定义注释 其它 XMBG的出现是因为在使用MBG的过程中发现很多缺憾，虽然只是扩展了上面几个方面，但是我相信仍然有很多方向可以探索，因此在我完成预定的所有扩展点后就发布了这个插件。因时间仓促以及水平有限不可避免的会出现很多BUG，希望各位多多指正。 XMBG已发布1.0版本，稳定性和可用性都有了很大改进！ __[1.0.0.20150601]__ * `IMPROVE` refactor plugin class structure * `IMPROVE` remove unstable feature for upsert * `IMPROVE` setup unit test for maven plugin and generator * `FIXBUGS` fix merge support bugs for java sources 标签：XMBG
mybatis_xml插件
12-01
mybatis_xml插件该插件可以直接关联mapper.xml文件，可以方便快捷的查看方法所对应的xml
mybatis_xml关联插件
12-01
安装步骤请参考：https://blog.csdn.net/qq_43097451/article/details/84612230
MyBatis的插件
JDS_DIJ的博客
03-09 1686
插件其实就是通过jdk动态代理将目标对象进行包装 本文章是跟着尚硅谷的视频记录的,详情请观看视频 1. 实现Interceptor接口 MyBatis提供了一个Interceptor接口;org.apache.ibatis.plugin 自制插件需要实现MyBatis提供的这个接口 2. 实现接口的方法 interceptor: 拦截到的目标方法;在这里控制目标方法执不执行,也可以在目标方法执行前后做一些我们自己的设置 plugin: 包装目标对象;即为目标对象创建代理对象 setPrope.
Mybatis之插件
qq_37589292的博客
04-15 1776
Mybatis插件 1、插件介绍 开源框架一般都会提供插件或其他形式的扩展点，供开发自行拓展。这样的好处显而易见的，一是增加了框架的灵活性，二是开发者可以结合实际需求，对框架进行扩展，使其能够更好的工作。以mybatis为例，我们可以基于mybatis插件机制实现分页、分表、监控等功能。由于插件和业务无关，业务也无法感知插件的存在。因此可以无感植入插件，在无形之中增强功能。 2、Mybatis插件介绍 Mybatis作为一个应用广泛的优秀的ORM开源框架，这个框架具有强大的灵活性，在四大组件（Executo
mybaits-plus依赖
09-08
MyBatis-Plus是一个基于MyBatis的增强工具，它简化了与数据库的交互过程，提供了更多便捷的功能和特性。如果你想在项目中使用MyBatis-Plus，你需要在你的项目中添加相应的依赖。 Maven用户可以在项目的pom.xml文件中添加以下依赖： ```xml <dependencies> <!-- MyBatis-Plus 核心依赖 --> <dependency> <groupId>com.baomidou</groupId> <artifactId>mybatis-plus-boot-starter</artifactId> <version>最新版本</version> </dependency> <!-- MyBatis-Plus 代码生成器依赖（可选） --> <dependency> <groupId>com.baomidou</groupId> <artifactId>mybatis-plus-generator</artifactId> <version>最新版本</version> </dependency> <!-- MyBatis-Plus 分页插件依赖（可选） --> <dependency> <groupId>com.baomidou</groupId> <artifactId>mybatis-plus-extension</artifactId> <version>最新版本</version> </dependency> <!-- 其他依赖... --> </dependencies> ``` 请注意，`最新版本`应该被替换为你所需要的MyBatis-Plus版本号。你可以在Maven仓库或者官方网站上找到最新的版本信息。 除了Maven，如果你使用的是Gradle构建工具，你可以将相应的依赖添加到你的build.gradle文件中。 添加完依赖后，你就可以在你的项目中使用MyBatis-Plus提供的功能了。祝你使用愉快！
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值