简介

MyBatis-Plus (opens new window)（简称 MP）是一个 MyBatis (opens new window)的增强工具，在 MyBatis 的基础上只做增强不做改变，为简化开发、提高效率而生。

特性

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

  • 损耗小：启动即会自动注入基本 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 操作智能分析阻断，也可自定义拦截规则，预防误操作

支持数据库

任何能使用 MyBatis 进行 CRUD, 并且支持标准 SQL 的数据库，具体支持情况如下，如果不在下列表查看分页部分教程 PR 您的支持。

  • MySQL，Oracle，DB2，H2，HSQL，SQLite，PostgreSQL，SQLServer，Phoenix，Gauss ，ClickHouse，Sybase，OceanBase，Firebird，Cubrid，Goldilocks，csiidb，informix，TDengine，redshift

  • 达梦数据库，虚谷数据库，人大金仓数据库，南大通用(华库)数据库，南大通用数据库，神通数据库，瀚高数据库，优炫数据库

快速开始

添加依赖

全新的 MyBatis-Plus 3.0 版本基于 JDK8，提供了 lambda 形式的调用，所以安装集成 MP3.0 要求如下：

  • JDK 8+

  • Maven or Gradle

Spring Boot项目

maven:

com.baomidoumybatis-plus-boot-starter最新版本

Spring 项目

maven:

com.baomidoumybatis-plus最新版本

配置

在 application.yml 配置文件中添加 H2 数据库的相关配置：

# DataSource Configspring:datasource:driver-class-name: org.h2.Driverschema: classpath:db/schema-h2.sqlusername: rootpassword: testsql:init:schema-locations: classpath:db/schema-h2.sqldata-locations: classpath:db/data-h2.sql

在 Spring Boot 启动类中添加 @MapperScan 注解，扫描 Mapper 文件夹：

@SpringBootApplication@MapperScan("com.baomidou.mybatisplus.samples.quickstart.mapper")public class Application {public static void main(String[] args) {SpringApplication.run(Application.class, args);}}

Page分页

方式一：

使用mybatis-plus 的 Service page 接口

@GetMapping("/pageList")@ApiOperation(value = "分页列表", notes = "query和user")public R<IPage> pageList(@ApiIgnore User user, Query query) {//无条件分页IPage pages = userService.page(Condition.getPage(query));//有条件分页IPage pages = userService.page(Condition.getPage(query), Wrappers.lambdaQuery(user));return R.data(pages);}

方式二：

自定义sql分页

controller层代码：

@GetMapping("/pageList") @ApiOperation(value = "分页列表", notes = "query和user")public R<IPage> pageList(@ApiIgnore User user, Query query) {IPage pages = userService.selectUserPage(Condition.getPage(query), user);return R.data(pages);}

service 里调用自定义分页sql mapper方法

@Overridepublic IPage selectUserPage(IPage page, User user) {return page.setRecords(baseMapper.selectUserPage(page, user));}

定义mapper分页接口：

import com.baomidou.mybatisplus.core.mapper.BaseMapper;import com.baomidou.mybatisplus.core.metadata.IPage;import com.gis.spacedata.bladex.domain.entity.system.User;import org.apache.ibatis.annotations.Param;import java.util.List;import java.util.List;public interface UserMapper extends BaseMapper {List selectUserPage(IPage page, @Param("user") User user);}

mybatis xml:

select * from blade_user where is_deleted = 0and tenant_id = #{user.tenantId}and account like CONCAT('%',#{user.account},'%')and real_name like CONCAT('%',#{user.realName},'%')and CAST(#{user.roleId} AS VARCHAR)= ANY(STRING_TO_ARRAY(role_id, ','))ORDER BY id

Condition 工具类：

import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;import com.baomidou.mybatisplus.core.metadata.IPage;import com.baomidou.mybatisplus.extension.plugins.pagination.Page;import org.springblade.core.launch.constant.TokenConstant;import org.springblade.core.tool.support.Kv;import org.springblade.core.tool.utils.BeanUtil;import org.springblade.core.tool.utils.Func;import java.util.Map;/** * 分页工具 * * @author Chill */public class Condition {/** * 转化成mybatis plus中的Page * * @param query 查询条件 * @return IPage */public static  IPage getPage(Query query) {Page page = new Page(Func.toInt(query.getCurrent(), 1), Func.toInt(query.getSize(), 10));page.setAsc(Func.toStrArray(SqlKeyword.filter(query.getAscs())));page.setDesc(Func.toStrArray(SqlKeyword.filter(query.getDescs())));return page;}/** * 获取mybatis plus中的QueryWrapper * * @param entity 实体 * @param 类型 * @return QueryWrapper */public static  QueryWrapper getQueryWrapper(T entity) {return new QueryWrapper(entity);}/** * 获取mybatis plus中的QueryWrapper * * @param query 查询条件 * @param clazz 实体类 * @param  类型 * @return QueryWrapper */public static  QueryWrapper getQueryWrapper(Map query, Class clazz) {Kv exclude = Kv.create().set(TokenConstant.HEADER, TokenConstant.HEADER).set("current", "current").set("size", "size").set("ascs", "ascs").set("descs", "descs");return getQueryWrapper(query, exclude, clazz);}/** * 获取mybatis plus中的QueryWrapper * * @param query 查询条件 * @param exclude 排除的查询条件 * @param clazz 实体类 * @param  类型 * @return QueryWrapper */public static  QueryWrapper getQueryWrapper(Map query, Map exclude, Class clazz) {exclude.forEach((k, v) -> query.remove(k));QueryWrapper qw = new QueryWrapper();qw.setEntity(BeanUtil.newInstance(clazz));SqlKeyword.buildCondition(query, qw);return qw;}}

方式三：

使用mybatis-plus的Db类

说明:

  • 使用静态调用的方式，执行CRUD方法，避免Spring环境下Service循环注入、简洁代码，提升效率

  • 需要项目中已注入对应实体的BaseMapper

  • 完整使用方式见: 测试用例(opens new window)

  • 对于参数为Wrapper的，需要在Wrapper中传入Entity或者EntityClass供寻找对应的Mapper

  • 不建议在循环中调用，如果是批量保存，建议将数据构造好后使用 Db.saveBatch(数据) 保存

@Testvoid testPage() {IPage page = Db.page(new Page(1, 1), Entity.class);Assertions.assertEquals(2, page.getTotal());page = Db.page(new Page(1, 1), Wrappers.lambdaQuery(Entity.class));Assertions.assertEquals(1, page.getRecords().size());}

Page分页插件

奇怪的是，它查询出来的数据还是所有数据，并没有起到我们的分页效果

我们都知道分页的原理是where limit ?,?

那是不是只要在这条查询语句后加上where条件就好了，我们可以把这条语句拦截下来，为它添加我们的where条件，这也是AOP思想的提现（在原有代码上只进行增强，不做修改）

插件主体MybatisPlusInterceptor

该插件是核心插件,目前代理了 Executor#query 和 Executor#update 和 StatementHandler#prepare 方法

InnerInterceptor

我们提供的插件都将基于此接口来实现功能

目前已有的功能:

  • 自动分页: PaginationInnerInterceptor

  • 多租户: TenantLineInnerInterceptor

  • 动态表名: DynamicTableNameInnerInterceptor

  • 乐观锁: OptimisticLockerInnerInterceptor

  • sql 性能规范: IllegalSQLInnerInterceptor

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

分页插件配置

Spring事务、MybatisPlus分页插件、Mybatis包扫描等配置

import com.baomidou.mybatisplus.extension.plugins.MybatisPlusInterceptor;import com.baomidou.mybatisplus.extension.plugins.inner.PaginationInnerInterceptor;import org.mybatis.spring.annotation.MapperScan;import org.springframework.context.annotation.Bean;import org.springframework.context.annotation.Configuration;import org.springframework.transaction.annotation.EnableTransactionManagement;/** * spring事务、MybatisPlus分页插件、mybatis包扫描等配置 * * @author tarzan liu * @since JDK1.8 * @date 2021年5月11日 */@EnableTransactionManagement@Configuration@MapperScan(basePackages = "com.tarzan.**.mapper")public class MybatisPlusConfig {/** * 分页插件 */@Beanpublic MybatisPlusInterceptor paginationInterceptor() {PaginationInnerInterceptor paginationInnerInterceptor = new PaginationInnerInterceptor();paginationInnerInterceptor.setMaxLimit(-1L);MybatisPlusInterceptor mybatisPlusInterceptor = new MybatisPlusInterceptor();mybatisPlusInterceptor.addInnerInterceptor(paginationInnerInterceptor);return mybatisPlusInterceptor;}}

代码中paginationInnerInterceptor.setMaxLimit(-1L);意思是不做最大分页数量限制，默认的话，最大限制是，一页500条数据。