MyBatis 允许你在已映射语句执行过程中的某一点进行拦截调用。默认情况下，MyBatis 允许使用插件来拦截的方法
调用包括：
- Executor (update, query, flflushStatements, commit, rollback, getTransaction, close, isClosed)
- ParameterHandler (getParameterObject, setParameters)
- ResultSetHandler (handleResultSets, handleOutputParameters)
- StatementHandler (prepare, parameterize, batch, update, query)
我们看到了可以拦截Executor接口的部分方法，比如update，query，commit，rollback等方法，还有其他接口的一些方法等。
总体概括为：
- 拦截执行器的方法
- 拦截参数的处理
- 拦截结果集的处理
- 拦截结果集的处理
在当前工程中创建一个plugins包文件，创建MyInterceptor类来完成示例
package cn.itcast.mp.plugins;
import org.apache.ibatis.javassist.bytecode.analysis.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();
}
@Override
public Object plugin(Object target) {
//创建target对象的代理对象,目的是将当前拦截器加入到该对象中
return Plugin.wrap(target, this);
}
@Override
public void setProperties(Properties properties) {
// 属性设置
}
}
在SpringBoot配置核心文件中注入拦截器
@Bean
public MyInterceptor myInterceptor() {
return new MyInterceptor();
}
通过xml配置，mybatis-confifig.xml：
测试说明：上面的拦截器示例主要是拦截update修改方法的，当我们执行update方法时，如果断点会进入到拦截器的位置，同时第一次进入的是plugin方法，再之后就是intercept,当intercept方法结束后又会继续执行plugin方法一个执行四次代表不同的范围，参考总体概括为：
1、执行分析插件SpringBoot配置：在MP中提供了对SQL执行的分析的插件，可用作阻断全表更新、删除的操作，注意：该插件仅适用于开发环境，不适用于生产环境。
// SQL分析插件
@Bean
public SqlExplainInterceptor sqlExplainInterceptor() {
SqlExplainInterceptor sqlExplainInterceptor = new SqlExplainInterceptor();
List list = new ArrayList<>();
// 全表更新或删除阻塞器
list.add(new BlockAttackSqlParser());
sqlExplainInterceptor.setSqlParserList(list);
return sqlExplainInterceptor;
}
测试说明
当我们执行删除所有表数据删除或更新时，就会直接报异常拦截下来，如果是更新或删除一条数据的话就不会拦截，有效阻止了误操作
2、性能分析插件mybatis-config.xml配置：性能分析拦截器，用于输出每条 SQL 语句及其执行时间，可以设置最大执行时间，超过时间会抛出异常
该插件只用于开发环境，不建议生产环境使用。
测试用例
@Test
public void testSelect4(){
User user = new User();
QueryWrapper queryWrapper = new QueryWrapper<>();
queryWrapper.gt("age",30);
List users = user.selectList(queryWrapper);
for (User user1 : users) {
System.out.println(user1);
}
}
执行效果
Time：15 ms执行时间
下面的是格式化后的sql语句对比上面的
[main] [cn.itcast.mp.mapper.UserMapper.selectList]-[DEBUG] ==> Preparing: SELECT id,user_name,password,name,age,email FROM tb_user WHERe age > ?
[main] [cn.itcast.mp.mapper.UserMapper.selectList]-[DEBUG] ==> Parameters: 30(Integer)
[main] [cn.itcast.mp.mapper.UserMapper.selectList]-[DEBUG] <== Total: 28
Time：15 ms - ID：cn.itcast.mp.mapper.UserMapper.selectList
Execute SQL：
SELECT
id,
user_name,
password,
name,
age,
email
FROM
tb_user
WHERe
age > 30
3、乐观锁插件
当要更新一条记录的时候，希望这条记录没有被别人更新
乐观锁实现方式：
- 取出记录时，获取当前version
- 更新时，带上这个version
- 执行更新时， set version = newVersion where version = oldVersion
- 如果version不对，就更新失败
spring xml:
spring boot:
@Bean public OptimisticLockerInterceptor optimisticLockerInterceptor() {
return new OptimisticLockerInterceptor();
}
mybatis-config.xml
使用实例
-
注解实体字段
需要为实体字段添加@Version注解。
@Version private Integer version;
-
为表添加version字段，并且设置初始值为1：
ALTER TABLE `tb_user` ADD COLUMN `version` int(10) NULL AFTER `email`; UPDATe `tb_user` SET `version`='1';
-
测试用例
@Test public void testUpdate(){ User user = new User(); user.setAge(30); user.setId(2L); user.setVersion(1); //获取到version为1 int result = this.userMapper.updateById(user); System.out.println("result = " + result); }可以看到，更新的条件中有version条件，并且更新的version为2。
如果再次执行，更新则不成功。这样就避免了多人同时更新时导致数据的不一致
- 支持的数据类型只有**:int,Integer,long,Long,Date,Timestamp,LocalDateTime**
- 整数类型下 newVersion = oldVersion + 1
- newVersion 会回写到 entity 中
- 仅支持 updateById(id) 与 update(entity, wrapper) 方法
- 在 update(entity, wrapper) 方法下**, wrapper** 不能复用**!!!**
5、自动填充默认数据通过自己继承接口来完成新的方法开发
添加@TableField注解
@TableField(fill = FieldFill.INSERT) //插入数据时进行填充 private String password;
为password添加自动填充功能，在新增数据时有效。
提供多种填充模式的选择
public enum FieldFill {
DEFAULT,
INSERT,
UPDATE,
INSERT_UPDATE
}
配置，创建一个MyMetaObjectHandler继承MetaObjectHandler
@Component
public class MyMetaObjectHandler implements MetaObjectHandler {
@Override
public void insertFill(MetaObject metaObject) {
Object password = getFieldValByName("password", metaObject);
if(null == password){
//字段为空，可以进行填充
setFieldValByName("password", "123456", metaObject);
}
}
@Override
public void updateFill(MetaObject metaObject) {
}
}
测试说明
6、逻辑删除编写添加测试用例的时候，不对password进行赋值，就会使用到上面的MyMetaObjectHandler设置的默认值来进行密码的数据填充，而如果一开始就有赋值密码，那么就会使用赋值的密码进行数据填充，只有当没有设置密码的时候才会使用到默认的自动填充功能
6.1、修改表的结构开发系统时，有时候在实现功能时，删除操作需要实现逻辑删除，所谓逻辑删除就是将数据标记为删除，而并非真正的物理删除（非DELETE操作），查询时需要携带状态条件，确保被标记的数据不被查询到。这样做的目的就是避免数据被真正的删除。
为需要删除的数据库表添加一个deleted字段，用于表示数据是否被删除，1代表删除，0代表未删除。
ALTER TABLE `tb_user` ADD COLUMN `deleted` int(1) NULL DEFAULT 0 COMMENT '1代表删除，0代表未删除' AFTER `version`;
同时，也修改User实体，增加deleted属性并且添加@TableLogic注解：
@TableLogic private Integer deleted;6.2、SpringBoot环境测试
application.properties：
# 逻辑已删除值(默认为 1) mybatis-plus.global-config.db-config.logic-delete-value=1 # 逻辑未删除值(默认为 0) mybatis-plus.global-config.db-config.logic-not-delete-value=06.3、测试
@Test
public void testDeleteById(){
this.userMapper.deleteById(2L);
}
测试代码中使用的是根据id查询数据并执行删除操作，而我们设置了逻辑删除并且也设置了相关的数据库字段和实体的注解说明，所以执行deleteById的时候底层是调用了update修改方法，而不上delete删除数据，修改的是新添加的deleted字段数据为1，标识为已近删除，当我们继续使用查询数据的时候，mybatisplus也会为我们添加上对象的查询条件，如下AND deleted=0
SELECT id,user_name,password,name,age,email,version,deleted FROM tb_user WHERe id=? AND deleted=0
7、通用枚举上面代码执行的就是所谓哦的逻辑删除
7.1、修改表结构解决了繁琐的配置，让 mybatis 优雅的使用枚举属性！
ALTER TABLE `tb_user` ADD COLUMN `sex` int(1) NULL DEFAULT 1 COMMENT '1-男，2-女' AFTER `deleted`;
7.2、定义枚举‘1-男，2-女’
package cn.itcast.mp.enums; import com.baomidou.mybatisplus.core.enums.IEnum; public enum SexEnum implements IEnum7.3、SpringBoot中的配置扫描枚举定义{ MAN(1,"男"), WOMAN(2,"女"); private int value; private String desc; SexEnum(int value, String desc) { this.value = value; this.desc = desc; } @Override public Integer getValue() { return null; } @Override public String toString() { return this.desc; } }
# 枚举包扫描 mybatis-plus.type-enums-package=cn.itcast.mp.enums7.4、修改实体数据 7.5、测试说明
8、代码生成器在mybatisPlus中可以优雅的使用枚举进行转换，而在mybatis中需要很繁琐的方式转换后才能进行使用，查询、更新都可以使用
AutoGenerator 是 MyBatis-Plus 的代码生成器，通过 AutoGenerator 可以快速生成 Entity、Mapper、MapperXML、Service、Controller 等各个模块的代码，极大的提升了开发效率。
