3 、插件
3.1、mybatis的插件机制
MyBatis 允许你在已映射语句执行过程中的某一点进行拦截调用。默认情况下，MyBatis 允许使用插件来拦截的方法调用包括：
1. Executor (update, query, flushStatements, commit, rollback, getTransaction, close, isClosed)
2. ParameterHandler (getParameterObject, setParameters)
3. ResultSetHandler (handleResultSets, handleOutputParameters)
4. StatementHandler (prepare, parameterize, batch, update, query)
我们看到了可以拦截Executor接口的部分方法，比如update，query，commit，rollback等方法，还有其他接口的
一些方法等。
总体概括为：
1. 拦截执行器的方法
2. 拦截参数的处理
3. 拦截结果集的处理
4. 拦截Sql语法构建的处理
拦截器示例：
package cn.itcast.mp.plugins; 1 import org.apache.ibatis.executor.Executor; import org.apache.ibatis.mapping.MappedStatement; import org.apache.ibatis.plugin.*;
import java.util.Properties;
@Intercepts({@Signature( type= Executor.class, method = "update", args = {MappedStatement.class,Object.class})}) public class MyInterceptor implements Interceptor {
@Override public Object intercept(Invocation invocation) throws Throwable { //拦截方法，具体业务逻辑编写的位置 return invocation.proceed();
注入到Spring容器：
或者通过xml配置，mybatis-config.xml：
3.2、执行分析插件
在MP中提供了对SQL执行的分析的插件，可用作阻断全表更新、删除的操作，注意：该插件仅适用于开发环境，不
适用于生产环境。
SpringBoot配置： } @Override public Object plugin(Object target) { //创建target对象的代理对象,目的是将当前拦截器加入到该对象中 return Plugin.wrap(target, this); }
@Override public void setProperties(Properties properties) { //属性设置 } }
自定义拦截器
@Bean public MyInterceptor myInterceptor(){ return new MyInterceptor(); }
<?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="cn.itcast.mp.plugins.MyInterceptor"></plugin> </plugins> </configuration>
测试：
结果：
@Bean public SqlExplainInterceptor sqlExplainInterceptor(){ SqlExplainInterceptor sqlExplainInterceptor = new SqlExplainInterceptor();
List<ISqlParser> sqlParserList = new ArrayList<>(); // 攻击 SQL 阻断解析器、加入解析链 sqlParserList.add(new BlockAttackSqlParser()); sqlExplainInterceptor.setSqlParserList(sqlParserList); return sqlExplainInterceptor; }
@Test public void testUpdate(){ User user = new User(); user.setAge( 20 ); int result = this.userMapper.update(user, null); System.out.println("result = " + result); }
可以看到，当执行全表更新时，会抛出异常，这样有效防止了一些误操作。
3.3、性能分析插件
性能分析拦截器，用于输出每条 SQL 语句及其执行时间，可以设置最大执行时间，超过时间会抛出异常。
该插件只用于开发环境，不建议生产环境使用。
配置：
Caused by: com.baomidou.mybatisplus.core.exceptions.MybatisPlusException: Prohibition of table update operation at com.baomidou.mybatisplus.core.toolkit.ExceptionUtils.mpe(ExceptionUtils.java: 49 ) at com.baomidou.mybatisplus.core.toolkit.Assert.isTrue(Assert.java: 38 ) at com.baomidou.mybatisplus.core.toolkit.Assert.notNull(Assert.java: 72 ) at com.baomidou.mybatisplus.extension.parsers.BlockAttackSqlParser.processUpdate(BlockAtt ackSqlParser.java: 45 ) at com.baomidou.mybatisplus.core.parser.AbstractJsqlParser.processParser(AbstractJsqlPars er.java: 92 ) at com.baomidou.mybatisplus.core.parser.AbstractJsqlParser.parser(AbstractJsqlParser.java : 67 ) at com.baomidou.mybatisplus.extension.handlers.AbstractSqlParserHandler.sqlParser(Abstrac tSqlParserHandler.java: 76 ) at com.baomidou.mybatisplus.extension.plugins.SqlExplainInterceptor.intercept(SqlExplainI nterceptor.java: 63 ) at org.apache.ibatis.plugin.Plugin.invoke(Plugin.java: 61 ) at com.sun.proxy.$Proxy 70 .update(Unknown Source) at org.apache.ibatis.session.defaults.DefaultSqlSession.update(DefaultSqlSession.java: 197 ) ... 41 more
<?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> <!-- 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> </configuration>
执行结果：
可以看到，执行时间为11ms。如果将maxTime设置为 1 ，那么，该操作会抛出异常。
3.4、乐观锁插件
3.4.1、主要适用场景
意图：
当要更新一条记录的时候，希望这条记录没有被别人更新
乐观锁实现方式：
取出记录时，获取当前version
更新时，带上这个version
执行更新时， set version = newVersion where version = oldVersion
如果version不对，就更新失败
3.4.2、插件配置
spring xml: spring boot: Time： 11 ms - ID：cn.itcast.mp.mapper.UserMapper.selectById Execute SQL： SELECT id, user_name, password, name, age, email FROM tb_user WHERE id= 7
Caused by: com.baomidou.mybatisplus.core.exceptions.MybatisPlusException: The SQL execution time is too large, please optimize! at com.baomidou.mybatisplus.core.toolkit.ExceptionUtils.mpe(ExceptionUtils.java: 49 ) at com.baomidou.mybatisplus.core.toolkit.Assert.isTrue(Assert.java: 38 ) ................
1 <bean class="com.baomidou.mybatisplus.extension.plugins.OptimisticLockerInterceptor"/> 1
3.4.3、注解实体字段
需要为实体字段添加@Version注解。
第一步，为表添加version字段，并且设置初始值为 1 ：
第二步，为User实体对象添加version字段，并且添加@Version注解：
3.4.4、测试
测试用例：
执行日志：
@Bean public OptimisticLockerInterceptor optimisticLockerInterceptor() { return new OptimisticLockerInterceptor(); }
ALTER TABLE `tb_user` ADD COLUMN `version` int( 10 ) NULL AFTER `email`;
UPDATE `tb_user` SET `version`=' 1 ';
@Version private Integer version;
@Test public void testUpdate(){ User user = new User(); user.setAge( 30 ); user.setId( 2 L); user.setVersion( 1 ); //获取到version为 1
int result = this.userMapper.updateById(user); System.out.println("result = " + result); }
可以看到，更新的条件中有version条件，并且更新的version为 2 。
如果再次执行，更新则不成功。这样就避免了多人同时更新时导致数据的不一致。
3.4.5、特别说明
支持的数据类型只有:int,Integer,long,Long,Date,Timestamp,LocalDateTime
整数类型下 newVersion = oldVersion + 1
newVersion 会回写到 entity 中
仅支持 updateById(id) 与 update(entity, wrapper) 方法
在 update(entity, wrapper) 方法下, wrapper 不能复用!!!
4 、Sql 注入器
我们已经知道，在MP中，通过AbstractSqlInjector将BaseMapper中的方法注入到了Mybatis容器，这样这些方法才可以正常执行。
那么，如果我们需要扩充BaseMapper中的方法，又该如何实现呢？
下面我们以扩展findAll方法为例进行学习。
4.1、编写MyBaseMapper
main] [com.baomidou.mybatisplus.extension.parsers.BlockAttackSqlParser]-[DEBUG] Original SQL: UPDATE tb_user SET age=?,
version=? WHERE id=? AND version=? [main] [com.baomidou.mybatisplus.extension.parsers.BlockAttackSqlParser]-[DEBUG] parser sql: UPDATE tb_user SET age = ?, version =? WHERE id =? AND version =? [main] [org.springframework.jdbc.datasource.DataSourceUtils]-[DEBUG] Fetching JDBC Connection from DataSource [main] [org.mybatis.spring.transaction.SpringManagedTransaction]-[DEBUG] JDBC Connection [HikariProxyConnection@ 540206885 wrapping com.mysql.jdbc.JDBC 4 Connection@ 27 e 0 f 2 f 5 ] will not be managed by Spring [main] [cn.itcast.mp.mapper.UserMapper.updateById]-[DEBUG] ==> Preparing: UPDATE tb_user SET age=?, version=? WHERE id=? AND version=? [main] [cn.itcast.mp.mapper.UserMapper.updateById]-[DEBUG] ==> Parameters: 30 (Integer), 2 (Integer), 2 (Long), 1 (Integer) [main] [cn.itcast.mp.mapper.UserMapper.updateById]-[DEBUG] <== Updates: 1 [main] [org.mybatis.spring.SqlSessionUtils]-[DEBUG] Closing non transactional SqlSession [org.apache.ibatis.session.defaults.DefaultSqlSession@ 30135202 ] result = 1
其他的Mapper都可以继承该Mapper，这样实现了统一的扩展。
如：
4.2、编写MySqlInjector
如果直接继承AbstractSqlInjector的话，原有的BaseMapper中的方法将失效，所以我们选择继承DefaultSqlInjector
进行扩展。
package cn.itcast.mp.mapper; import com.baomidou.mybatisplus.core.mapper.BaseMapper; import java.util.List; public interface MyBaseMapper<T> extends BaseMapper<T> { List<T> findAll(); }
package cn.itcast.mp.mapper; import cn.itcast.mp.pojo.User; public interface UserMapper extends MyBaseMapper<User> { User findById(Long id); }
package cn.itcast.mp.sqlInjector;
import com.baomidou.mybatisplus.core.injector.AbstractMethod; import com.baomidou.mybatisplus.core.injector.DefaultSqlInjector;
import java.util.List; public class MySqlInjector extends DefaultSqlInjector { @Override public List<AbstractMethod> getMethodList() { List<AbstractMethod> methodList = super.getMethodList();
methodList.add(new FindAll()); // 再扩充自定义的方法 list.add(new FindAll()); return methodList; } }
4.3、编写FindAll
4.4、注册到Spring容器
4.5、测试
输出的SQL：
package cn.itcast.mp.sqlInjector; import com.baomidou.mybatisplus.core.enums.SqlMethod; import com.baomidou.mybatisplus.core.injector.AbstractMethod; import com.baomidou.mybatisplus.core.metadata.TableInfo; import org.apache.ibatis.mapping.MappedStatement; import org.apache.ibatis.mapping.SqlSource;
public class FindAll extends AbstractMethod { @Override public MappedStatement injectMappedStatement(Class<?> mapperClass, Class<?> modelClass, TableInfo tableInfo) { String sqlMethod = "findAll"; String sql = "select * from " + tableInfo.getTableName(); SqlSource sqlSource = languageDriver.createSqlSource(configuration, sql, modelClass); return this.addSelectMappedStatement(mapperClass, sqlMethod, sqlSource, modelClass, tableInfo); } }
/** * 自定义SQL注入器 */ @Bean public MySqlInjector mySqlInjector(){ return new MySqlInjector(); }
@Test public void testFindAll(){ List<User> users = this.userMapper.findAll(); for (User user : users) { System.out.println(user); } }
至此，我们实现了全局扩展SQL注入器。
