Mybatis-Plus：插件（mybatis的插件机制、执行分析插件、性能分析插件、乐观锁插件）

已于 2022-08-21 22:24:06 修改
阅读量1.5k 收藏 6
点赞数 1
分类专栏： # SSM  MP 文章标签： java 开发语言 插件 Mybatis-Plus
于 2022-03-17 13:36:03 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/I_r_o_n_M_a_n/article/details/123542782
版权

本节案例承接自上节案例

文章目录

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)

总体概括为：

  1. 拦截执行器的方法
  2. 拦截参数的处理
  3. 拦截结果集的处理
  4. 拦截Sql语法构建的处理

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

拦截器示例:

在这里插入图片描述

MyInterceptor.java

package com.tian.plugins;

import org.apache.ibatis.executor.Executor;
import org.apache.ibatis.mapping.MappedStatement;
import org.apache.ibatis.plugin.*;

import java.util.Properties;

@Intercepts({@Signature(	
		// 要拦截的是 Executor 执行器的 update方法
        type = Executor.class,
        method = "update",
        args = {MappedStatement.class, Object.class})})
public class MyInterceptor implements Interceptor {

    @Override
     //拦截方法，具体业务逻辑编写的位置 现在是只有update方法会进入该方法
    public Object intercept(Invocation invocation) throws Throwable {
        return invocation.proceed(); // invocation.proceed()是放行
    }

    @Override
    // 执行sql都会进入该方法 并且会执行4次 因为有4个处理器 
    /*
    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) 拦截Sql语法构建的处理
    */
    public Object plugin(Object target) {
        // 创建target对象的代理对象,目的是将当前拦截器加入到该对象中
        return Plugin.wrap(target, this);
    }

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

将拦截器注入到Spring容器：

在这里插入图片描述
MybatisPlusConfig.java
在这里插入图片描述

package com.tian.springbootmybatisplus;

import com.baomidou.mybatisplus.extension.plugins.PaginationInterceptor;
import com.tian.plugins.MyInterceptor;
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
@MapperScan("com.tian.mapper") //设置mapper接口的扫描包
public class MybatisPlusConfig {
    @Bean //配置分页插件
    public PaginationInterceptor paginationInterceptor() {
        return new PaginationInterceptor();
    }

    /*** 自定义拦截器 */
    @Bean
    public MyInterceptor myInterceptor() {
        return new MyInterceptor();
    }
}

或者通过xml配置，mybatis-config.xml：
在这里插入图片描述

2. 执行分析插件（阻断全表更新、删除的操作）

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

2.1 配置

在这里插入图片描述

MyInterceptor.java

    @Bean //SQL分析插件
    public SqlExplainInterceptor sqlExplainInterceptor() {

        SqlExplainInterceptor sqlExplainInterceptor = new SqlExplainInterceptor();

        List<ISqlParser> list = new ArrayList<>();
        
        // 攻击 SQL 阻断解析器、加入解析链
        list.add(new BlockAttackSqlParser()); //全表更新、删除的阻断器

        sqlExplainInterceptor.setSqlParserList(list);

        return sqlExplainInterceptor;
    }

BlockAttackSqlParser.java源码查看
在这里插入图片描述

在这里插入图片描述

2.2 测试

在这里插入图片描述

SpringbootMybatisplusApplicationTests.java

package com.tian.springbootmybatisplus;

import com.tian.mapper.UserMapper;
import com.tian.pojo.User;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;

@SpringBootTest
class SpringbootMybatisplusApplicationTests {

    @Autowired
    private UserMapper userMapper;

    @Test
    public void testUpdate() {
        User user = new User();
        user.setAge(20);

        // 把所有人的age设置为20
        int result = this.userMapper.update(user, null);
        System.out.println("result = " + result);
    }
}

运行结果：

在这里插入图片描述

3. 性能分析插件

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

和执行分析插件一样，该插件只用于开发环境，不建议生产环境使用。

说明：我最开始用的Mybatis-Plus 3.3.2，发现没有PerformanceInterceptor类。于是我把Mybatis-Plus版本降到了 3.1.0 。然后就可以正常使用性能分析插件了。
在这里插入图片描述

3.1 Spring Boot 配置

在这里插入图片描述
MybatisPlusConfig.java

    @Bean
    // SQL 执行性能分析，开发环境使用，线上不推荐。
    public PerformanceInterceptor performanceInterceptor() {
        PerformanceInterceptor performanceInterceptor = new PerformanceInterceptor();
        // maxTime 指的是 sql 最大执行时长, 单位为ms
        performanceInterceptor.setMaxTime(100);
        // SQL是否格式化 默认为true
        performanceInterceptor.setFormat(true);
        return performanceInterceptor;
    }

编写测试用例：

在这里插入图片描述

SpringbootMybatisplusApplicationTests.java

package com.tian.springbootmybatisplus;

import com.tian.mapper.UserMapper;
import com.tian.pojo.User;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;

@SpringBootTest
class SpringbootMybatisplusApplicationTests {

    @Autowired
    private UserMapper userMapper;

    @Test
    public void testSelectById() {
        User user = new User();
        // 查询Id为2的用户
        user.setId(2L);
        User user1 = user.selectById();
        System.out.println(user1);
    }
}

运行结果：

在这里插入图片描述

异常情况补充：

在这里插入图片描述

3.2 配置文件方式配置

上面一直使用的代码注入Bean的方式去配置，现在我们来尝试着使用配置文件的方式去配置，这样可以练练手。
在这里插入图片描述

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="com.baomidou.mybatisplus.extension.plugins.PerformanceInterceptor">
            <!--最大的执行时间，单位为毫秒-->
            <property name="maxTime" value="100"/>
            <!--对输出的SQL做格式化，默认为false-->
            <property name="format" value="true"/>
        </plugin>
    </plugins>
</configuration>

然后在SpringBoot的全局配置文件指定Mybatis的配置文件即可：
在这里插入图片描述
application.properties
在这里插入图片描述

# 指定全局的配置文件
mybatis-plus.config-location=classpath:mybatis-config.xml

4. 乐观锁插件

当要更新一条记录的时候，希望这条记录没有被别人更新

乐观锁实现方式：

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

4.1 插件配置

配置文件方式：

在这里插入图片描述

  <!--乐观锁插件-->
        <plugin interceptor="com.baomidou.mybatisplus.extension.plugins.OptimisticLockerInterceptor"/>

spring boot代码注入Bean的方式：

在这里插入图片描述
MybatisPlusConfig.java

在这里插入图片描述

    @Bean
    public OptimisticLockerInterceptor optimisticLockerInterceptor() {
        return new OptimisticLockerInterceptor();
    }

4.2 注解实体字段

需要为实体字段添加@Version注解。

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

Navicat执行下面的sql语句：

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

在这里插入图片描述

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

在这里插入图片描述

4.3 测试

在这里插入图片描述

SpringbootMybatisplusApplicationTests.java

package com.tian.springbootmybatisplus;

import com.tian.mapper.UserMapper;
import com.tian.pojo.User;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;

@SpringBootTest
class SpringbootMybatisplusApplicationTests {

    @Autowired
    private UserMapper userMapper;

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

运行结果：

生成的SQL语句为：
在这里插入图片描述

  • 可以看到，更新的条件中有version条件，并且更新的version为2。
  • 如果再次执行，更新则不成功。这样就避免了多人同时更新时导致数据的不一致。

4.4 说明

在这里插入图片描述

CodeJiao
关注
  • 1
    点赞
  • 踩
  • 6
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
专栏目录
mybatis-plus快速入门项目-mybatis-plus基本操作大全-附带sql+项目文档
11-24
MyBatis-Plus支持乐观锁机制，通过在实体类中添加version或timestamp字段，可以在更新数据时防止并发问题。 10. **项目文档** 提供的项目文档应该详细介绍了如何搭建环境、配置MyBatis-Plus、使用各种API以及如何...
MybatisPlus-插件篇
王梦杰_MengJie
08-29 2522
本文将详细介绍mybatisplus中常用插件的使用。Mybatis-Plus 插件提供了很多便捷的方法和功能，能够大幅简化 MyBatis 的开发，减少重复劳动。通过配置依赖、实体类、Mapper 接口以及相应的插件，可以在 Spring Boot 项目中高效地进行数据库操作。
MybatisPlus常用插件
Dawn的博客
09-22 5199
介绍 MybatisPlus 的常用插件，包括分页插件，乐观锁插件以及 MybatisX 插件。
【微服务】第4节：MybatisPlus的分页插件
最新发布
m0_46013789的博客
06-10 1603
大家在日常开发中应该能发现，单表的CRUD功能代码重复度很高，也没有什么难度。而这部分代码量往往比较大，开发起来比较费时。因此，目前企业中都会使用一些组件来简化或省略单表的CRUD开发工作。目前在国内使用较多的一个组件就是MybatisPlus。
Mybatisplus-插件使用
qq_33879443的博客
07-16 3475
mybatis的插件使用（建议这些共用的字段放到BaseBean.java）
mybatis-plus之插件
努力是为了让自己不平庸。。。
03-24 966
本文介绍了mybatis-plus的插件机制、执行分析插件、性能分析插件、乐观锁插件。
MyBatis-Plus特性及插件整合
yuqu1028的博客
02-28 2053
mybatisPlus在mybatis的基础上继续针对CRUD操作进行优化，在原有的基础上提供了公共的接口BaseMapper，我们在创建接口Mapper时只需要继承这个接口即可调用MyBatisPlus已经提供好的方法，sql和方法都是已经被MyBatisPlus内置的。表示并不是真正的将数据从数据库中删除，而是让其失效。比如手机中删除照片的最近删除，要删除这些已经“删除”的数据再进行一次深度删除即可，使用时只需要在数据库表中定义一个字段，并在实体类对应字段上用注解标注字段即可。默认再用雪花算法实现。
mybatis-plus源码（mybatis-plus-3.5.1.zip）
03-03
此源码包`mybatis-plus-3.5.1.zip`包含了MyBatis-Plus 3.5.1版本的全部源代码，有助于我们深入理解其内部实现机制和工作原理。 MyBatis-Plus的主要功能包括： 1. **CRUD操作**：MyBatis-Plus提供了简化版的CRUD...
mybatis-plus源码（mybatis-plus-3.5.1.tar.gz）
03-03
- MyBatis-Plus允许开发者自定义插件，如性能分析插件，实现对SQL执行的监控。 12. **事务管理**： - MyBatis-Plus的事务管理可以通过Spring的TransactionManager进行，也可以手动控制，提供了一套完整的事务处理...
Mybatis-Plus和Mybatis的区别详解
09-07
4. **乐观锁支持**：MP内置了乐观锁机制，防止并发更新导致的数据不一致问题。 5. **代码生成器**：Mybatis-Plus Generator可以生成Entity、Mapper、Service、Controller等代码，进一步减少重复工作。 6. **SQL监控*...
全面学习Mybatis插件之Mybatis-Plus_Java框架视频教程
11-05
n 乐观锁插件 主讲内容 章节一：快速入门 1. Mybatis-Plus简介 2. 快速入门 3. 通用CRUD 4. 配置 5. 条件构造器 章节二：进阶 1. ActiveRecord 2. Oracle 主键Sequence 3. 插件 章节三：高级应用 1. Sql 注入器 2. ...
MybatisPlus----- 插件功能
m0_59281987的博客
05-10 1250
其中缺少的仅仅是分页条件，而分页条件不仅仅用户分页查询需要，以后其它业务也都有分页查询的需求。这里用到了分页参数，Page，即可以支持分页参数，也可以支持排序参数。MybatisPlus提供了很多的插件功能，进一步拓展其功能。在查询出分页结果后，数据的非空校验，数据的vo转换都是模板代码，编写起来很麻烦。所以，我们必须配置分页插件。：分页查询条件的实体，包含分页、排序参数、过滤条件。：分页结果实体，包含总条数、总页数、当前页数据。如果排序字段为空，默认按照更新时间排序。排序字段不为空，则按照排序字段排序。
MyBatis-Plus插件
巧克力布丁的博客
03-15 2357
文章目录一. 分页插件1. 添加配置类2. 测试二. xml自定义分页1. UserMapper中定义接口方法2. UserMapper.xml中编写SQL3. 测试三. 乐观锁1. 场景2. 乐观锁与悲观锁3. 模拟修改冲突3.1 数据库中增加商品表3.2 添加实体3.3 添加mapper3.4 测试3.5 乐观锁实现流程3.6 Mybatis-Plus实现乐观锁 一. 分页插件 MyBatis Plus自带分页插件，只要简单的配置即可实现分页功能 1. 添加配置类 2. 测试 二. xml自定
【MybatisPlus】快速使用MybatisPlus和几种常见插件
m0_46628950的博客
10-18 2975
（简称 MP）是一个的增强工具，在 MyBatis 的基础上只做增强不做改变，为简化开发、提高效率而生。简介 | MyBatis-Plus (baomidou.com)自定义输入策略使用方法1. 首先添加@Bean//注册Bean容器@Bean}//配置类};i++) {}}}2. 设置实体类主键tpye = NONE。
SpringCloud或SpringBoot+Mybatis-Plus利用mybatis插件实现数据操作记录及更新对比
yong472727322的博客
11-02 3409
引文 　　本文主要介绍如何使用mybatis插件实现拦截数据库操作并根据不同需求进行数据对比分析，主要适用于系统中需要对数据操作进行记录、在更新数据时准确记录更新字段 核心：mybatis插件（拦截器）、mybatis-Plus实体规范、数据对比 1、相关技术简介 mybatis插件： 　　mybatis插件实际上就是官方针对4层数据操作处理预留的拦截器，使用者可以根据不同的需求进行操作拦截并处理。这边笔者不做详细描述，详细介绍请到官网了解，这里笔者就复用官网介绍。 插件（plugins）.
MyBatis-Plus 常用插件
m0_53067943的博客
08-02 2601
主要对 MyBatis-Plus 的常用插件的简单使用进行总结
Spring AOP实现记录mybatis-plus操作数据变化01
Myron_007的博客
03-14 4012
spring aop实现记录mybatis-plus mapper接口,在执行删除及修改数据时操作日志,自动比对历史数据.
mybtisplus性能分析插件
程序员阿红的博客
06-05 1111
我们在平时的开发中，会遇到一些慢sql。测试！ druid,,,,, 作用：性能分析拦截器，用于输出每条 SQL 语句及其执行时间 MP也提供性能分析插件，如果超过这个时间就停止运行！
MyBatis-Plus 实战教程三 拓展插件
个人博客，记录了本人学习的各种有趣的技术。
10-30 1507
我们定义一个用户状态的枚举：import comNORMAL(1 , "正常") , FREEZE(2 , "冻结");} }NORMAL(1 , "正常") , FREEZE(2 , "冻结");} }NORMAL(1 , "正常") , FREEZE(2 , "冻结");Getter;@GetterNORMAL(1, "正常"),FREEZE(2, "冻结");
mybatis-plus+插件
07-28
另外，Mybatis-plus还提供了其他常用的插件，如自动分页插件、防止全表更新与删除插件、乐观锁插件等，可以根据需要进行配置和使用。如果想要使用Mybatis-plus插件，需要在配置类或启动类中进行相应的配置，比如配置...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

CodeJiao

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值