MyBatis-Plus详解

前言

• SQL语句的编写：MyBatis将SQL语句和Java代码解耦，使用XML文件或注解编写SQL语句，降低了代码的耦合度。

• 对象关系映射（ORM）：MyBatis通过配置文件或者注解将Java对象与数据库表进行映射，从而实现Java对象与数据库表的关联

• 数据库连接管理：Mybatis使用数据源来管理数据库连接，提高了数据库的访问效率。同时可以自定义连接池大小、超时时间等参数，以适应不同场景下的需求。

• 分页查询：Mybatis提供了分页查询的支持，可以通过配置文件或注解来实现分页查询。

连接池：

1. driver：指定数据库驱动类名。

2. url：指定数据库连接字符串。

3. username：指定数据库用户名。

4. password：指定数据库密码。

5. initialSize：连接池中初始化连接数。

6. maxActive：连接池中最大活动连接数。

7. maxIdle：连接池中最大空闲连接数。

8. minIdle：连接池中最小空闲连接数。

9. maxWait：获取连接的最大等待时间（毫秒）。

10. timeBetweenEvictionRunsMillis：连接回收器线程运行间隔时间。

11. minEvictableIdleTimeMillis：连接在池中保持空闲而不被使用的最短时间。

12. testWhileIdle：是否开启空闲连接检测。

13. testOnBorrow：是否开启获取连接时的检测。

14. testOnReturn：是否开启归还连接时的检测。

15. validationQuery：用来检验连接是否有效的 SQL 语句。

16. removeAbandoned：是否移除废弃的连接。

17. removeAbandonedTimeout：废弃连接超时时间。

<dataSource type="com.mchange.v2.c3p0.ComboPooledDataSource">
  <property name="driverClass" value="com.mysql.jdbc.Driver"/>
  <property name="jdbcUrl" value="jdbc:mysql://localhost:3306/mybatis"/>
  <property name="user" value="root"/>
  <property name="password" value="root"/>
  <property name="initialPoolSize" value="5"/>
  <property name="maxPoolSize" value="10"/>
  <property name="minPoolSize" value="2"/>
  <property name="maxIdleTime" value="3600"/>
</dataSource>

MyBatis-Plus简介

• 无侵入：只做增强不做改变，引入它不会对现有工程产生影响，如丝般顺滑

• 损耗小：启动即会自动注入基本 CURD，性能基本无损耗，直接面向对象操作

• 强大的 CRUD 操作：内置通用 Mapper、通用 Service，仅仅通过少量配置即可实现单表大部分 CRUD 操作，更有强大的条件构造器，满足各类使用需求

• 支持 Lambda 形式调用：通过 Lambda 表达式，方便的编写各类查询条件，无需再担心字段写错

• 支持主键自动生成：支持多达 4 种主键策略（内含分布式唯一 ID 生成器 - Sequence），可自由配置，完美解决主键问题

• 支持 ActiveRecord 模式：支持 ActiveRecord 形式调用，实体类只需继承 Model 类即可进行强大的 CRUD 操作

• 支持自定义全局通用操作：支持全局通用方法注入（ Write once, use anywhere ）

• 内置代码生成器：采用代码或者 Maven 插件可快速生成 Mapper 、 Model 、 Service 、 Controller 层代码，支持模板引擎，更有超多自定义配置等您来使用

• 内置分页插件：基于 MyBatis 物理分页，开发者无需关心具体操作，配置好插件之后，写分页等同于普通 List 查询

• 分页插件支持多种数据库：支持 MySQL、MariaDB、Oracle、DB2、H2、HSQL、SQLite、Postgre、SQLServer 等多种数据库

• 内置性能分析插件：可输出 SQL 语句以及其执行时间，建议开发测试时启用该功能，能快速揪出慢查询

• 内置全局拦截插件：提供全表 delete 、 update 操作智能分析阻断，也可自定义拦截规则，预防误操作

框架结构

如何使用

注解

• @TableName

• @TableId

IdType

• @TableField

• @Version
描述：乐观锁注解、标记 @Version 在字段上

• @EnumValue
描述：普通枚举类注解(注解在枚举字段上)

• @TableLogic

• @KeySequence
• 描述：序列主键策略 oracle
• 属性：value、dbType

属性	类型	必须指定	默认值	描述
value	String	否	""	序列名
dbType	Enum	否	DbType.OTHER	数据库类型，未配置默认使用注入 IKeyGenerator 实现，多个实现必须指定

• @OrderBy(opens new window)

• 描述：内置 SQL 默认指定排序，优先级低于 wrapper 条件查询

MyBatis-Plus分页原理

1. 基于 RowBounds 的分页

1. 基于 PageHelper 的分页

MyBatis-Plus插件

属性

private List<InnerInterceptor> interceptors = new ArrayList<>();

InnerInterceptor

• 自动分页: PaginationInnerInterceptor

• 多租户: TenantLineInnerInterceptor

• 动态表名: DynamicTableNameInnerInterceptor

• 乐观锁: OptimisticLockerInnerInterceptor

• sql 性能规范: IllegalSQLInnerInterceptor

• 防止全表更新与删除: BlockAttackInnerInterceptor

使用方式：

@Configuration
@MapperScan("scan.your.mapper.package")
public class MybatisPlusConfig {

    /**
     * 新的分页插件,一缓和二缓遵循mybatis的规则,需要设置 MybatisConfiguration#useDeprecatedExecutor = false 避免缓存出现问题(该属性会在旧插件移除后一同移除)
     */
    @Bean
    public MybatisPlusInterceptor mybatisPlusInterceptor() {
        MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
        interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.H2));
        return interceptor;
    }

    @Bean
    public ConfigurationCustomizer configurationCustomizer() {
        return configuration -> configuration.setUseDeprecatedExecutor(false);
    }
}

乐观锁

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

@Version
private Integer version;

• 支持的数据类型只有:int,Integer,long,Long,Date,Timestamp,LocalDateTime

• 整数类型下 newVersion = oldVersion + 1

• newVersion 会回写到 entity 中

• 仅支持 updateById(id) 与 update(entity, wrapper) 方法

• 在 update(entity, wrapper) 方法下, wrapper 不能复用!!!