java spring 【MyBatisPlus】一文带你快速上手MyBatisPlus

文章目录

MyBatisPlus学习笔记前言1、MyBatisPlus概述2、快速体验3、CRUD接口3.1 Mapper层CRUD接口3.1.1 Insert3.1.2 Delete3.1.3 Update3.1.4 Select

3.2 Service层CRUD接口3.2.1 Save3.2.2 Remove3.2.3 Update3.2.4 Get

3.3 自定义SQL接口4、常用注解和配置4.1 @TableId4.2 @TableField4.3 @TableLogic

5、条件构造器和常用接口5.1 QueryWrapper5.2 UpdateWrapper5.3 使用Condition动态组装条件5.4 LaｍdaQueryWrapper5.5 LamdaUpdateWrapper

6、插件6.1 MyBatisPlus分页插件6.2 悲观锁与乐观锁6.3 MyBatisX插件

7、通用枚举8、代码生成器8.1 快速生成8.2 交互式生成

9、多数据源

MyBatisPlus学习笔记

前言

  本文是参考MyBatisPlus官网对MyBatisPlus的一个学习笔记，主要是对MyBatisPlus的一个简单的入门学习，大致对MyBatisPlus有一个整体认知，熟悉使用MyBatisPlus提供的各种API（比如MyBatisPlus提供的增删改查接口），以及各种便利的特性和插件（比如自动生成代码、MyBatisPlus分页插件）。当然主要目的是想利用费曼学习方法将学到的知识进行一个输出，这样能够加深我对知识有一个更加深刻的认知，因为这些知识在官方是都能够查看到的，我用自己的认知、自己的排版对这些知识进行重复输出。

1、MyBatisPlus概述

MyBatisPlus是什么？

MyBatisPlus（简称MP）是MyBatis的增强版，在 MyBatis 的基础上只做增强不做改变，为简化开发、提高效率而生。和MyBatis一样是一款数据访问层的框架，可以大大简化对SQL的操作

官方文档地址：MyBatis-Plus Gitee开源地址：mybatis-plus: mybatis GitHub开源地址：baomidou/mybatis-plus 创始人：青苗

MyBatisPlus的t特点：

无侵入：只做增强不做改变，引入它不会对现有工程产生影响，如丝般顺滑损耗小：启动即会自动注入基本 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 操作智能分析阻断，也可自定义拦截规则，预防误操作 支持的数据库

国外：MySQL，Oracle，DB2，H2，HSQL，SQLite，PostgreSQL，SQLServer，Phoenix，Gauss ，ClickHouse，Sybase，OceanBase，Firebird，Cubrid，Goldilocks，csiidb，informix，TDengine，redshift国内：达梦数据库，虚谷数据库，人大金仓数据库，南大通用(华库)数据库，南大通用数据库，神通数据库，瀚高数据库，优炫数据库 框架结构

2、快速体验

#mermaid-svg-wEwO7RlaQNDn36ZG {font-family:"trebuchet ms",verdana,arial,sans-serif;font-size:16px;fill:#333;}#mermaid-svg-wEwO7RlaQNDn36ZG .error-icon{fill:#552222;}#mermaid-svg-wEwO7RlaQNDn36ZG .error-text{fill:#552222;stroke:#552222;}#mermaid-svg-wEwO7RlaQNDn36ZG .edge-thickness-normal{stroke-width:2px;}#mermaid-svg-wEwO7RlaQNDn36ZG .edge-thickness-thick{stroke-width:3.5px;}#mermaid-svg-wEwO7RlaQNDn36ZG .edge-pattern-solid{stroke-dasharray:0;}#mermaid-svg-wEwO7RlaQNDn36ZG .edge-pattern-dashed{stroke-dasharray:3;}#mermaid-svg-wEwO7RlaQNDn36ZG .edge-pattern-dotted{stroke-dasharray:2;}#mermaid-svg-wEwO7RlaQNDn36ZG .marker{fill:#333333;stroke:#333333;}#mermaid-svg-wEwO7RlaQNDn36ZG .marker.cross{stroke:#333333;}#mermaid-svg-wEwO7RlaQNDn36ZG svg{font-family:"trebuchet ms",verdana,arial,sans-serif;font-size:16px;}#mermaid-svg-wEwO7RlaQNDn36ZG .label{font-family:"trebuchet ms",verdana,arial,sans-serif;color:#333;}#mermaid-svg-wEwO7RlaQNDn36ZG .cluster-label text{fill:#333;}#mermaid-svg-wEwO7RlaQNDn36ZG .cluster-label span{color:#333;}#mermaid-svg-wEwO7RlaQNDn36ZG .label text,#mermaid-svg-wEwO7RlaQNDn36ZG span{fill:#333;color:#333;}#mermaid-svg-wEwO7RlaQNDn36ZG .node rect,#mermaid-svg-wEwO7RlaQNDn36ZG .node circle,#mermaid-svg-wEwO7RlaQNDn36ZG .node ellipse,#mermaid-svg-wEwO7RlaQNDn36ZG .node polygon,#mermaid-svg-wEwO7RlaQNDn36ZG .node path{fill:#ECECFF;stroke:#9370DB;stroke-width:1px;}#mermaid-svg-wEwO7RlaQNDn36ZG .node .label{text-align:center;}#mermaid-svg-wEwO7RlaQNDn36ZG .node.clickable{cursor:pointer;}#mermaid-svg-wEwO7RlaQNDn36ZG .arrowheadPath{fill:#333333;}#mermaid-svg-wEwO7RlaQNDn36ZG .edgePath .path{stroke:#333333;stroke-width:2.0px;}#mermaid-svg-wEwO7RlaQNDn36ZG .flowchart-link{stroke:#333333;fill:none;}#mermaid-svg-wEwO7RlaQNDn36ZG .edgeLabel{background-color:#e8e8e8;text-align:center;}#mermaid-svg-wEwO7RlaQNDn36ZG .edgeLabel rect{opacity:0.5;background-color:#e8e8e8;fill:#e8e8e8;}#mermaid-svg-wEwO7RlaQNDn36ZG .cluster rect{fill:#ffffde;stroke:#aaaa33;stroke-width:1px;}#mermaid-svg-wEwO7RlaQNDn36ZG .cluster text{fill:#333;}#mermaid-svg-wEwO7RlaQNDn36ZG .cluster span{color:#333;}#mermaid-svg-wEwO7RlaQNDn36ZG div.mermaidTooltip{position:absolute;text-align:center;max-width:200px;padding:2px;font-family:"trebuchet ms",verdana,arial,sans-serif;font-size:12px;background:hsl(80, 100%, 96.2745098039%);border:1px solid #aaaa33;border-radius:2px;pointer-events:none;z-index:100;}#mermaid-svg-wEwO7RlaQNDn36ZG :root{--mermaid-font-family:"trebuchet ms",verdana,arial,sans-serif;}

搭建环境

编写配置文件

编写实体类

编写Mapper

编写测试类

扫描Mapper

Step1：搭建环境 1）建表（使用的是MySQL） 建立一张 user 表 DROP TABLE IF EXISTS user;

CREATE TABLE user

(

id BIGINT(20) NOT NULL COMMENT '主键ID',

name VARCHAR(30) NULL DEFAULT NULL COMMENT '姓名',

age INT(11) NULL DEFAULT NULL COMMENT '年龄',

email VARCHAR(50) NULL DEFAULT NULL COMMENT '邮箱',

PRIMARY KEY (id)

);

往表中添加数据： DELETE FROM user;

INSERT INTO user (id, name, age, email)

VALUES (1, 'Jone', 18, 'test1@baomidou.com'),

(2, 'Jack', 20, 'test2@baomidou.com'),

(3, 'Tom', 28, 'test3@baomidou.com'),

(4, 'Sandy', 21, 'test4@baomidou.com'),

(5, 'Billie', 24, 'test5@baomidou.com');

2）导入依赖

mysql

mysql-connector-java

org.springframework.boot

spring-boot-starter

org.springframework.boot

spring-boot-starter-test

test

org.projectlombok

lombok

com.baomidou

mybatis-plus-boot-starter

3.5.2

3）编写配置文件 application.yml server:

port: 8080

spring:

datasource:

driver-class-name: com.mysql.cj.jdbc.Driver

url: jdbc:mysql://localhost:3306/mybatis-plus_study?serverTimezone=UTC

username: root

password: 32345678

mybatis-plus:

configuration:

log-impl: org.apache.ibatis.logging.stdout.StdOutImpl # 开启标准日志

Step2：编写实体类 @Data

public class User {

private Long id;

private String name;

private Integer age;

private String email;

}

Step3：编写Mapper package com.hhxy.mapper;

import com.baomidou.mybatisplus.core.mapper.BaseMapper;

import com.hhxy.entity.User;

import org.apache.ibatis.annotations.Mapper;

@Mapper

public interface UserMapper extends BaseMapper {

/*

说明: BaseMapper

BaseMapper是MP封装了通用CRUD的接口，Mapper只需要集成BaseMapper

T为任意实体类，只要让Mapper集成BaseMapper并且关联对应的实体类，就能使用Mapper对象操作实体类对应的表了

*/

}

Step4：扫描Mapper 在SpringBoot的启动类上添加**@MapperScan("com.hhxy.mapper")**注解 PS：如果我们在Mapper接口上添加了@Mapper注解，则这个注解可以省略 Step5：编写测试类 @SpringBootTest

public class SampleTest {

@Autowired

private UserMapper userMapper;

@Test

public void testSelect() {

System.out.println(("----- selectAll method test ------"));

List userList = userMapper.selectList(null);

Assertions.assertEquals(5, userList.size());

userList.forEach(System.out::println);

}

}

知识拓展：关于MP中的SQL是如何确定要操作的表是谁

我们在使用MP时，我们自己编写的Mapper必须继承BaseMapper，通过这一步，我们MP底层会自动将T映射为SQL操作表，举个例子吧：当我们的T是User时，那么SQL操作的表就是user

那如果数据库中的表是tb_user，如何确保SQL操作的表是tb_user呢？

方案一：最直接的方法肯定是修改entity的格式，比如可以将entity修改成tb_user、TbUser、tbUser、Tb_User、Tb_User。 方案二：通过@TableName注解映射表名，比如@TableName("tb_user") 方案二：通过编写配置文件，给user添加一个前缀 mybatis-plus:

global-config:

db-config:

table-prefix: tb_

需要注意的是，通过配置文件是全局有效的，也就是所有的实体类都会增加一个前缀tb_

3、CRUD接口

MP在MyBatis的基础上做了增强，底层封装了大量通用的SQL，主要有BaseMapper和IService两个CRUD接口，其中IService的实现类是ServiceImpl，BaseMapper中的方法以insert、delete、update、select开始，IService中的方法以save、remove、get开始

insert、delete、update的返回值都是int类型，返回值为0说明无数据更新，此时SQL执行失败save、remove的返回值都是boolean类型，返回值为false说明SQL执行失败

3.1 Mapper层CRUD接口

参数说明：

类型参数名描述Tentity实体对象Wrapperwrapper实体对象封装操作类（可以为 null，里面的 entity 用于生成 where 语句）CollectionidList主键 ID 列表(不能为 null 以及 empty)Serializableid主键 ID（可以是任何实现了序列化接口的数据类型）MapcolumnMap表字段 map 对象IPagepage分页查询条件（可以为 RowBounds.DEFAULT）

备注：基本数据类型的包装类都实现了序列化接口，String也实现了序列化接口

3.1.1 Insert

int insert(T entity)：插入一条记录，返回值为更新数据的条数

@Test

public void testInsert(){

User user = new User("张三", 23, "123@qq.com");

// INSERT INTO user ( id, name, age, email ) VALUES ( ?, ?, ?, ? );

int result = userMapper.insert(user);

System.out.println("insert = " + result); // result = 1

// MP很贴心，它会将Insert后自动生成的id，重新赋值给user对象（不用向MyBatis还要进行配置才能获取生成id）

System.out.println("MP自动生成的id为: "+user.getId());

}

备注：不止是BaseMapper的Insert方法能够通过getId直接获取自动生成的Id，IService的save方法也能够通过getId直接获取自动生成的Id。总的来讲MP真的简化了MyBatis，让开发变得更简单

3.1.2 Delete

int deleteById(Serializable id)：根据id删除一条记录，返回值为更新数据的条数 int deleteById(T entity)：根据entity的id删除一条记录，返回值为更新数据的条数 注意事项：entity必须具有getId()这个方法，否则会报错 PS：其实可以通过@TableId配置自定义的主键，详情键第四节【常用注解和配置】 int deleteByMap(Map columnMap)：以map的value作为条件进行删除 注意事项：map的key必须要与表中的字段进行对应（不区分大小写） int deleteBachIds(Cellection idList)：批量删除 int delete(Wrapper queryWrapper)：条件删除

int result = 0;

// DELETE FROM user WHERE id=?;

result = userMapper.deleteById(1613825708092678146L);

User user = new User(1L,"张三", 23, "123@qq.com");

// DELETE FROM user WHERE id=?;

result = userMapper.deleteById(user);

Map map = new HashMap<>();

map.put("name", "张三");

map.put("age", 23);

// DELETE FROM user WHERE name=? AND age=?;

result = userMapper.deleteByMap(map);

List idList = Arrays.asList(1L, 2L, 3L);

// DELETE FROM user WHERE id IN (?, ?, ?);

result = userMapper.deleteBatchIds(idList);

3.1.3 Update

int updateById(T entity)：根据id进行修改 entity必须具有getId()这个方法，否则会报错 int update(T entity, Wrapper updateWrapper)：根据条件进行修改

int result = 0;

User user = new User(1L,"张三", 23, "123@qq.com");

// UPDATE user SET name=?, age=?, email=? WHERE id=?;

result = userMapper.updateById(user);

3.1.4 Select

T selectById(Serializable id)：根据id进行查询 List selectBatchIds(Collection idList)：批量查询 List selectByMap(Map columnMap)：根据map的value进行条件查询 注意事项：map的key必须要与表中的字段进行对应（不区分大小写） List selectList(Wrapper queryWrapper)：条件查询

// SELECT id,name,age,email FROM user WHERE id=?;

User user = userMapper.selectById(1L);

List idList = Arrays.asList(1l, 2l, 3l);

// SELECT id,name,age,email FROM user WHERE id IN ( ? , ? , ? );

List users = userMapper.selectBatchIds(idList);

Map map = new HashMap<>();

map.put("name", "张三");

map.put("age", 23);

// SELECT id,name,age,email FROM user WHERE name = ? AND age = ?;

List users = userMapper.selectByMap(map);

// SELECT id,name,age,email FROM user;

List users1 = userMapper.selectList(null);

3.2 Service层CRUD接口

类型参数名描述intbatchSize插入批次数量Tentity实体对象WrapperupdateWrapper实体对象封装操作类 UpdateWrapperCollectionentityList实体对象集合CollectionidListidListFunctionmapper转换函数

3.2.1 Save

boolean save(T entity)：新增一条记录 boolean saveBatch(Collection entityList)：批量添加 温馨提示：

使用saveBatch，最好在数据库连接的url中添加一个rewriteBatchedStatements=true参数，实现高性能的批量插入 使用saveBatch，底层使用了事务，执行多条新增只会提交一次事务；但是如果在for循环中使用，会提交多次事务（不建议在循环中使用saveBatch方法） saveBatch(Collection entityList)底层就是调用saveBatch(Colection entityList, int batchSize)，只是前一个他设置了默认值batchSize=1000，也就是一个批次会插入1000条，超过一千条需要等待下一批次执行 备注：saveBatch底层是通过JDBC的executeBatch实现的。批次只针对增删改操作，它是指将执行SQL的语句的请求先存起来，等到达到一定数量，就当作一批发送给MySQL服务器，让MySQL服务器一次将这些SQL执行完，这样做可以避免频繁和MySQL数据库交互，造成效率低下

参考文章：

MyBatis-plus批量写入数据方法saveBatch速度很慢原因排查 Mybatis-Plus批量插入的简单自测Mybatis Plus saveBatch批量插入如何高效Java-Mysql之批处理_veejaLiu的博客-CSDN博客什么是批处理？

boolean saveBatch(Colection entityList, int batchSize)：批量添加 当batchSize=1时，都是一条一条执行单一的insert语句 当batchSize>=list.size()时，底层通过executeBatch方法将list中的数据拼接成一条SQL，最终执行性一条SQL boolean saveOrUpdate(T entity)： boolean saveOrUpdate(T entity, Wrapper updateWrapper)： boolean saveOrUpdateBatch(Collection entityList)： boolean saveOrUpdateBatch(CollectionentityList, int batchSize)：

// INSERT INTO user ( id, name, age, email ) VALUES ( ?, ?, ?, ? );

User user = new User("张三", 22, "123@qq.com");

boolean result = userService.save(user);

List users = new ArrayList<>();

for (int i = 0; i < 3; i++) {

User user = new User("张三", 18, "123@qq.com");

users.add(user);

}

// INSERT INTO user ( id, name, age, email ) VALUES ( ?, ?, ?, ? ),( ?, ?, ?, ? ),( ?, ?, ?, ? );

boolean result = userService.saveBatch(users);

// 执行三次: INSERT INTO user ( id, name, age, email ) VALUES ( ?, ?, ?, ? );

boolean result = userService.saveBatch(users, 1);

3.2.2 Remove

boolean removeById(Serializable id)：根据id删除数据boolean removeById(T entity)：根据id删除数据boolean removeById(Serializable id, boolean useFill)：boolean removeBatchByIds(Collection list)：更具id进行批量删除boolean removeBatchByIds(Collection list, int batchSize)：boolean removeBatchByIds(Collection list, boolean useFill)：boolean removeBatchByIds(Collection list, int batchSize, boolean useFill)：

3.2.3 Update

// 根据 UpdateWrapper 条件，更新记录 需要设置sqlset

boolean update(Wrapper updateWrapper);

// 根据 whereWrapper 条件，更新记录

boolean update(T updateEntity, Wrapper whereWrapper);

// 根据 ID 选择修改

boolean updateById(T entity);

// 根据ID 批量更新

boolean updateBatchById(Collection entityList);

// 根据ID 批量更新

boolean updateBatchById(Collection entityList, int batchSize);

3.2.4 Get

// 根据 ID 查询

T getById(Serializable id);

// 根据 Wrapper，查询一条记录。结果集，如果是多个会抛出异常，随机取一条加上限制条件 wrapper.last("LIMIT 1")

T getOne(Wrapper queryWrapper);

// 根据 Wrapper，查询一条记录

T getOne(Wrapper queryWrapper, boolean throwEx);

// 根据 Wrapper，查询一条记录

Map getMap(Wrapper queryWrapper);

// 根据 Wrapper，查询一条记录

V getObj(Wrapper queryWrapper, Function mapper);

// 查询所有

List list();

// 查询列表

List list(Wrapper queryWrapper);

// 查询（根据ID 批量查询）

Collection listByIds(Collection idList);

// 查询（根据 columnMap 条件）

Collection listByMap(Map columnMap);

// 查询所有列表

List> listMaps();

// 查询列表

List> listMaps(Wrapper queryWrapper);

// 查询全部记录

List