Mybatisplus

1. mybatis的插件机制
2. 拦截器示例
- 2.1 新建拦截器文件【MyInterceptor 】
- 2.2 把拦截器文件注入到spring容器中
- 2.3 执行测试用例update方法
- 2.4 执行结果
3. 执行分析插件
- 3.1 配置
- 3.2 编写测试用例
- 3.3 执行结果
4. 性能分析插件
- 4.1 在【mybatis-config.xml】里添加插件配置
- 4.2 执行测试用例【testSelect】
- 4.3 执行结果

1. mybatis的插件机制

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

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

我们看到了可以拦截Executor接口的部分方法，比如update，query，commit，rollback等方法，还有其他接口的一些方法等。

总体概括为：

拦截执行器的方法
拦截参数的处理
拦截结果集的处理
拦截Sql语法构建的处理

2. 拦截器示例

2.1 新建拦截器文件【MyInterceptor 】

【method = “update”】可以通过method指定拦截方法，该实例拦截的是【update】方法。

@Intercepts({@Signature(type = Executor.class,method = "update",args = {MappedStatement.class, Object.class})})
public class MyInterceptor implements Interceptor {@Overridepublic Object intercept(Invocation invocation) throws Throwable {//拦截方法，具体业务逻辑编写的位置System.out.println("拦截了update方法");return invocation.proceed();}@Overridepublic Object plugin(Object target) {//创建target对象的代理对象,目的是将当前拦截器加入到该对象中return Plugin.wrap(target, this);}@Overridepublic void setProperties(Properties properties) {//属性设置}
}

2.2 把拦截器文件注入到spring容器中

/*** @author LongXi* @create 2021-09-24 20:56*/
@MapperScan("cn.itcast.mp.mapper")
@Configuration
public class MyBatisPlusConfig {@Beanpublic PaginationInterceptor paginationInterceptor(){return new PaginationInterceptor();}/*** 自定义拦截器*/@Beanpublic MyInterceptor myInterceptor(){return new MyInterceptor();}
}

2.3 执行测试用例update方法

    @Testpublic void testUpdate() {User user = new User();user.setAge(20); //更新的字段user.setPassword("8888888");QueryWrapper<User> wrapper = new QueryWrapper<>();wrapper.eq("user_name", "zhaoliu"); //匹配user_name = zhaoliu 的用户数据//根据条件做更新int result = this.userMapper.update(user, wrapper);System.out.println("result => " + result);}

2.4 执行结果

[main] [org.mybatis.spring.SqlSessionUtils]-[DEBUG] SqlSession [org.apache.ibatis.session.defaults.DefaultSqlSession@55b8dbda] was not registered for synchronization because synchronization is not active
拦截了update方法
[main] [org.springframework.jdbc.datasource.DataSourceUtils]-[DEBUG] Fetching JDBC Connection from DataSource
[main] [org.mybatis.spring.transaction.SpringManagedTransaction]-[DEBUG] JDBC Connection [HikariProxyConnection@101601906 wrapping com.mysql.cj.jdbc.ConnectionImpl@7c18432b] will not be managed by Spring
[main] [cn.itcast.mp.mapper.UserMapper.update]-[DEBUG] ==>  Preparing: UPDATE tb_user SET password=?, age=? WHERE user_name = ?
[main] [cn.itcast.mp.mapper.UserMapper.update]-[DEBUG] ==> Parameters: 8888888(String), 20(Integer), zhaoliu(String)
[main] [cn.itcast.mp.mapper.UserMapper.update]-[DEBUG] <==    Updates: 2
[main] [org.mybatis.spring.SqlSessionUtils]-[DEBUG] Closing non transactional SqlSession [org.apache.ibatis.session.defaults.DefaultSqlSession@55b8dbda]
result => 2

我们的拦截语句【拦截了update方法】被输出，说明拦截器起作用了。

3. 执行分析插件

在MP中提供了对SQL执行的分析的插件，可用作阻断全表更新、删除的操作，
注意：该插件仅适用于开发环境，不适用于生产环境。

3.1 配置

SpringBoot配置：

@Bean
public SqlExplainInterceptor sqlExplainInterceptor(){SqlExplainInterceptor sqlExplainInterceptor = new SqlExplainInterceptor();List<ISqlParser> sqlParserList = new ArrayList<>();// 攻击 SQL 阻断解析器、加入解析链sqlParserList.add(new BlockAttackSqlParser());sqlExplainInterceptor.setSqlParserList(sqlParserList);
return sqlExplainInterceptor;
}

3.2 编写测试用例

    // 测试全局阻断器@Testpublic void testUpdateAll() {//根据条件做更新User user = new User();user.setAge(20); //更新的字段user.setPassword("8888888");//根据条件做更新int result = this.userMapper.update(user, new QueryWrapper<>());System.out.println("result => " + result);}

3.3 执行结果

跟预期一样，被阻断了，这种操作不被允许

org.mybatis.spring.MyBatisSystemException: nested exception is org.apache.ibatis.exceptions.PersistenceException:
### Error updating database.  Cause: com.baomidou.mybatisplus.core.exceptions.MybatisPlusException: Prohibition of table update operation
### Cause: com.baomidou.mybatisplus.core.exceptions.MybatisPlusException: Prohibition of table update operationat org.mybatis.spring.MyBatisExceptionTranslator.translateExceptionIfPossible(MyBatisExceptionTranslator.java:77)at org.mybatis.spring.SqlSessionTemplate$SqlSessionInterceptor.invoke(SqlSessionTemplate.java:446)at com.sun.proxy.$Proxy56.update(Unknown Source)at org.mybatis.spring.SqlSessionTemplate.update(SqlSessionTemplate.java:294)at com.baomidou.mybatisplus.core.override.MybatisMapperMethod.execute(MybatisMapperMethod.java:63)at com.baomidou.mybatisplus.core.override.MybatisMapperProxy.invoke(MybatisMapperProxy.java:62)at com.sun.proxy.$Proxy60.update(Unknown Source)at cn.itcast.mp.TestUserMapper.testUpdateAll(TestUserMapper.java:95)at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62)at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)at java.lang.reflect.Method.invoke(Method.java:498)at org.junit.runners.model.FrameworkMethod$1.runReflectiveCall(FrameworkMethod.java:50)at org.junit.internal.runners.model.ReflectiveCallable.run(ReflectiveCallable.java:12)at org.junit.runners.model.FrameworkMethod.invokeExplosively(FrameworkMethod.java:47)at org.junit.internal.runners.statements.InvokeMethod.evaluate(InvokeMethod.java:17)at org.springframework.test.context.junit4.statements.RunBeforeTestExecutionCallbacks.evaluate(RunBeforeTestExecutionCallbacks.java:74)at org.springframework.test.context.junit4.statements.RunAfterTestExecutionCallbacks.evaluate(RunAfterTestExecutionCallbacks.java:84)at org.springframework.test.context.junit4.statements.RunBeforeTestMethodCallbacks.evaluate(RunBeforeTestMethodCallbacks.java:75)at org.springframework.test.context.junit4.statements.RunAfterTestMethodCallbacks.evaluate(RunAfterTestMethodCallbacks.java:86)

把SQL拿出来看一下

[main] [com.baomidou.mybatisplus.extension.parsers.BlockAttackSqlParser]-[DEBUG] Original SQL: UPDATE tb_user  SET password=?,age=?
[main] [org.mybatis.spring.SqlSessionUtils]-[DEBUG] Closing non transactional SqlSession [org.apache.ibatis.session.defaults.DefaultSqlSession@5b22b970]

没有条件，是全表更新。

4. 性能分析插件

性能分析拦截器，用于输出每条 SQL 语句及其执行时间，可以设置最大执行时间，超过时间会抛出异常。
注意：

该插件只用于开发环境，不建议生产环境使用。

4.1 在【mybatis-config.xml】里添加插件配置

    <plugins><plugin interceptor="com.baomidou.mybatisplus.extension.plugins.PaginationInterceptor"></plugin><!-- SQL 执行性能分析，开发环境使用，线上不推荐。 maxTime 指的是 sql 最大执行时长 --><plugin interceptor="com.baomidou.mybatisplus.extension.plugins.PerformanceInterceptor"><property name="maxTime" value="100" /><!--SQL是否格式化 默认false--><property name="format" value="true" /></plugin></plugins>

maxTime 指的是 sql 最大执行时长，以毫秒为单位。

4.2 执行测试用例【testSelect】

    @Testpublic void testSelect(){QueryWrapper<User> wrapper = new QueryWrapper<>();//SELECT id,name,age FROM tb_user WHERE name = ? OR age = ?wrapper.eq("name", "王五").or().eq("age", 21).select("id","name","age"); //指定查询的字段List<User> users = this.userMapper.selectList(wrapper);for (User user : users) {System.out.println(user);}}

4.3 执行结果

[main] [cn.itcast.mp.mapper.UserMapper.selectList]-[DEBUG] ==>  Preparing: SELECT id,name,age FROM tb_user WHERE name = ? OR age = ?
[main] [cn.itcast.mp.mapper.UserMapper.selectList]-[DEBUG] ==> Parameters: 王五(String), 21(Integer)
[main] [cn.itcast.mp.mapper.UserMapper.selectList]-[DEBUG] <==      Total: 2Time：24 ms - ID：cn.itcast.mp.mapper.UserMapper.selectList
Execute SQL：SELECTid,name,age FROMtb_user WHEREname = '王五' OR age = 21[main] [org.mybatis.spring.SqlSessionUtils]-[DEBUG] Closing non transactional SqlSession [org.apache.ibatis.session.defaults.DefaultSqlSession@1ecfcbc9]
User(id=2, userName=null, password=null, name=李四, age=21, mail=null, address=null)
User(id=3, userName=null, password=null, name=王五, age=22, mail=null, address=null)

可以看到，sql被格式化了，执行时间也打出来了。

如果执行时间操作了测试时间，就会提示你优化了。

Mybatisplus插件相关推荐

第 7 章 MybatisPlus 插件
第 7 章 MybatisPlus 插件 1.插件机制概述 MybatisPlusInterceptor 核心插件 MybatisPlus 通过插件(Interceptor)可以做到拦截四大对象(Ex ...
解决MybatisPlus插件分页查询不起作用，总是查询全部数据问题
问题描述: 在使用mybatisplus插件进行分页查询时分页参数不起作用,总是查出来全部数据. 原因分析: 查看打印的sql日志发现sql后面并没有limit条件,怀疑是缺少配置. 解决方案: 查阅 ...
idea mybatisplus 插件使用
在plugin中安装mybatisplus 插件使用配置数据库生成代码表新增字段,重新生成实体类覆盖因业务需求,表中可能会时不时增加一些字段,大多情况下实体类中不会添加表中没有的字段,因此可 ...
Mybatis-Plus插件配置
yml配置 1 # Mybatis-Plus 2 mybatis-plus: 3 # 配置mapper的扫描,找到所有的mapper.xml映射文件 4 mapper-locations: com.x ...
MyBatisPlus插件扩展_OptimisticLockerInterceptor乐观锁插件的使用
场景项目搭建专栏: https://blog.csdn.net/BADAO_LIUMANG_QIZHI/column/info/37194 简介意图: 当要更新一条记录的时候,希望这条记录没有被别 ...
MyBatisPlus插件扩展_PerformanceInterceptor性能分析插件的使用
场景项目搭建专栏: https://blog.csdn.net/BADAO_LIUMANG_QIZHI/column/info/37194 简介性能分析拦截器,用于输出每条 SQL 语句及其执行时 ...
MyBatisPlus插件扩展_SqlExplainInterceptor执行分析插件的使用
场景项目搭建专栏: https://blog.csdn.net/BADAO_LIUMANG_QIZHI/column/info/37194 简介 SQL 执行分析拦截器[ 目前只支持 MYSQL-5 ...
MyBatisPlus插件扩展_PaginationInterceptor分页插件的使用
场景项目搭建专栏: https://blog.csdn.net/BADAO_LIUMANG_QIZHI/column/info/37194 实现配置插件来到项目下的applicationCont ...
MyBatis-Plus插件
文章目录一. 分页插件 1. 添加配置类 2. 测试二. xml自定义分页 1. UserMapper中定义接口方法 2. UserMapper.xml中编写SQL 3. 测试三. 乐观锁 1. ...

Mybatisplus插件