Mybatis-Plus插件

• Mybatis+Mybatis-Plus
• Spring+Mybatis+Mybatis-Plus
• Spring Boot+Mybatis+Mybatis-Plus
• Mybatis-Plus通用CRUD
• Mybatis-Plus配置
• Mybatis-Plus条件构造器
• Mybatis-Plus ActiveRecord模式CRUD
• Mybatis-Plus Oracle 主键Sequence

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语法构建的处理

 
拦截器示例

@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();
    }

    @Override
    public Object plugin(Object target) {
        //创建target对象的代理对象,目的是将当前拦截器加入到该对象中
        return Plugin.wrap(target, this);
    }

    @Override
    public void setProperties(Properties properties) {
        //属性设置
    }
}

注入到Spring容器

@Bean // 注入自定义的拦截器（插件）
public MyInterceptor myInterceptor() {
	return new MyInterceptor();
}

或者通过mybatis-config.xml配置

<?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.com.javakf.interceptor.MyInterceptor"></plugin>
	</plugins>

</configuration>

执行分析插件

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

@Bean // SQL执行分析插件
public SqlExplainInterceptor sqlExplainInterceptor() {
	SqlExplainInterceptor sqlExplainInterceptor = new SqlExplainInterceptor();
	List<ISqlParser> list = new ArrayList<>();
	list.add(new BlockAttackSqlParser()); // 全表更新、删除的阻断器
	sqlExplainInterceptor.setSqlParserList(list);
	return sqlExplainInterceptor;
}

测试

/**
 * 测试全表更新，SQL分析器阻断效果
 */
@Test
public void testUpdateAll() {
	User user = new User();
	user.setAge(20); // 更新的数据
	
	boolean result = user.update(null); // 全表更新
	System.out.println("result => " + result);
}

结果

可以看到，当执行全表更新时，会抛出异常，这样有效防止了一些误操作。

性能分析插件

性能分析拦截器，用于输出每条 SQL 语句及其执行时间，可以设置最大执行时间，超过时间会抛出异常。注意：该插件只用于开发环境，不建议生产环境使用。
 
配置

<plugins>
	<!-- 性能分析插件 -->
	<plugin
		interceptor="com.baomidou.mybatisplus.extension.plugins.PerformanceInterceptor">
		<!--最大的执行时间，单位为毫秒 -->
		<property name="maxTime" value="100" />
		<!--对输出的SQL做格式化，默认为false -->
		<property name="format" value="true" />
	</plugin>
</plugins>

执行结果

可以看到，执行时间为18ms。如果将maxTime设置为1，那么，该操作会抛出异常。

乐观锁插件

主要适用场景
当要更新一条记录的时候，希望这条记录没有被别人更新
 
乐观锁实现方式：

• 取出记录时，获取当前version
• 更新时，带上这个version
• 执行更新时， set version = newVersion where version = oldVersion
• 如果version不对，就更新失败

 
插件配置
spring xml

<bean class="com.baomidou.mybatisplus.extension.plugins.OptimisticLockerInterceptor"/>

spring boot

@Bean // 乐观锁插件
public OptimisticLockerInterceptor optimisticLockerInterceptor() {
	return new OptimisticLockerInterceptor();
}

注解实体字段

第一步，为表添加version字段，并且设置初始值为1

ALTER TABLE `tb_user` ADD COLUMN `version` INT ( 10 ) NULL AFTER `email`;
UPDATE `tb_user` SET `version` = '1';

第二步，为User实体对象添加version字段，并且添加@Version注解

@Version // 乐观锁的版本字段
private Integer version;

测试

/**
 * 测试乐观锁
 */
@Test
public void testUpdateVersion() {
	User user = new User();
	user.setId(2L);// 查询条件

	User userVersion = user.selectById();

	user.setAge(23); // 更新的数据
	user.setVersion(userVersion.getVersion()); // 当前的版本信息

	boolean result = user.updateById();
	System.out.println("result => " + result);
}

执行日志

[main] [cn.com.javakf.mapper.UserMapper.updateById]-[DEBUG] ==>  Preparing: UPDATE tb_user SET age=?, version=? WHERE id=? AND version=? 
[main] [cn.com.javakf.mapper.UserMapper.updateById]-[DEBUG] ==> Parameters: 23(Integer), 2(Integer), 2(Long), 1(Integer)
[main] [cn.com.javakf.mapper.UserMapper.updateById]-[DEBUG] <==    Updates: 1
Time：50 ms - ID：cn.com.javakf.mapper.UserMapper.updateById
Execute SQL：
    UPDATE
        tb_user 
    SET
        age=23,
        version=2 
    WHERE
        id=2 
        AND version=1

[main] [org.mybatis.spring.SqlSessionUtils]-[DEBUG] Closing non transactional SqlSession [org.apache.ibatis.session.defaults.DefaultSqlSession@3b1ed14b]
result => true

可以看到，更新的条件中有version条件，并且更新的version为2。
 
特别说明

• 支持的数据类型只有:int,Integer,long,Long,Date,Timestamp,LocalDateTime
• 整数类型下 newVersion = oldVersion + 1
• newVersion 会回写到 entity 中
• 仅支持 updateById(id) 与 update(entity, wrapper) 方法
• 在 update(entity, wrapper) 方法下, wrapper 不能复用!!!