MybatisPlus入门详解

最新推荐文章于 2024-07-15 21:21:12 发布

深夜无眠T

最新推荐文章于 2024-07-15 21:21:12 发布

阅读量626

点赞数 23

分类专栏：学习笔记框架文章标签： spring boot 后端 java 数据库 spring

本文链接：https://blog.csdn.net/m0_62902381/article/details/136421424

版权

学习笔记同时被 2 个专栏收录

18 篇文章 0 订阅

订阅专栏

框架

11 篇文章 0 订阅

订阅专栏

前言

本篇文章将对MybatisPlus进行一个入门级别的讲解，将会讲解MybatisPlus的大部分知识点，可以帮助你成功入门MybatisPlus。另外要注意，本篇文章的讲解是在springboot的环境下进行讲解，如果你对springboot没有了解，推荐先去了解学习springboot，我之前也发过springboot的入门讲解，可以去看一看，两篇文章结合起来观看效果更佳。

简介

MyBatis-Plus （简称 MP）是一个 MyBatis的增强工具，在 MyBatis 的基础上只做增强不做改变，为简化开发、提高效率而生。Mybatis-Plus提供了通用的Mapper和Service，可以在不编写任何SQL语句的前提下，快速的实现单表的增删改查（CURD），批量，逻辑删除，分页等操作。只要把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 操作智能分析阻断，也可自定义拦截规则，预防误操作

配置

创建一个数据库和表以便于后面的操作演示
创建表（因为MybatisPlus在生成id主键时采用的是雪花算法，因此主键要用Bigint类型

CREATE DATABASE `mybatis_plus` /*!40100 DEFAULT CHARACTER SET utf8mb4 */; use `mybatis_plus`;
CREATE TABLE `user` (
`id` bigint(20) NOT NULL COMMENT '主键ID',
`name` varchar(30) DEFAULT NULL COMMENT '姓名 ',
`age` int(11) DEFAULT NULL COMMENT '年龄 ',
`email` varchar(50) DEFAULT NULL COMMENT '邮箱 ',
PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;

添加数据

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');

下面简单介绍以下雪花算法
雪花算法是由Twitter公布的分布式主键生成算法，它能够保证不同表的主键的不重复性，以及相同表的主键的有序性。
①核心思想：长度共64bit（一个long型）。
首先是一个符号位， 1bit标识，由于long基本类型在Java中是带符号的，最高位是符号位，正数是0，负数是1，所以id一般是正数，最高位是0。
41bit时间截(毫秒级)，存储的是时间截的差值（当前时间截 - 开始时间截)，结果约等于69.73年。
10bit作为机器的ID（ 5个bit是数据中心， 5个bit的机器ID，可以部署在1024个节点）。
12bit作为毫秒内的流水号（意味着每个节点在每毫秒可以产生 4096 个 ID）。
在这里插入图片描述
②优点：整体上按照时间自增排序，并且整个分布式系统内不会产生ID碰撞，并且效率较高。

创建一个SpringBoot项目
引入依赖

<dependencies>
   <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter</artifactId>
   </dependency>
   <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-test</artifactId>
      <scope>test</scope>
   </dependency>
   <dependency>
      <groupId>com.baomidou</groupId>
      <artifactId>mybatis-plus-boot-starter</artifactId>
      <version>3.5.1</version>
   </dependency>
   <dependency>
      <groupId>org.projectlombok</groupId>
      <artifactId>lombok</artifactId>
      <optional>true</optional>
   </dependency>
   <dependency>
      <groupId>mysql</groupId>
      <artifactId>mysql-connector-java</artifactId>
      <scope>runtime</scope>
   </dependency>
</dependencies>

之后在idea中安装lombok插件
在这里插入图片描述

编写基本代码

配置application.yml

spring:
  datasource:
    username: root
    password: root
    # 根据电脑中数据库的版本来决定要不要加时区
    url: jdbc:mysql://localhost:3306/mybatis_plus?serverTimezone=GMT%2B8
    driver-class-name: com.mysql.cj.jdbc.Driver
    type: com.zaxxer.hikari.HikariDataSource

注意：
1、驱动类driver-class-name
spring boot 2.0（内置jdbc5驱动），驱动类使用：
driver-class-name: com.mysql.jdbc.Driver
spring boot 2.1及以上（内置jdbc8驱动），驱动类使用：
driver-class-name: com.mysql.cj.jdbc.Driver
否则运行测试用例的时候会有 WARN 信息
2、连接地址url
MySQL5.7版本的url：
jdbc:mysql://localhost:3306/mybatis_plus?characterEncoding=utf-8&useSSL=false
MySQL8.0版本的url：
jdbc:mysql://localhost:3306/mybatis_plus?
serverTimezone=GMT%2B8&characterEncoding=utf-8&useSSL=false
否则运行测试用例报告如下错误：
java.sql.SQLException: The server time zone value’ÖÐ¹ú±ê×¼Ê±¼ä’ is unrecognized or represents more

启动类
创建mapper文件夹，并在Spring Boot启动类中添加@MapperScan注解，扫描mapper包

@SpringBootApplication
@MapperScan("com.qcby.springboot.mapper")
public class MybatisPlusApplication {
    public static void main(String[] args) {
        SpringApplication.run(MybatisPlusApplication.class, args); }
}

添加实体
例如添加User实体（TableName注解中对应的是数据库中表名）

@NoArgsConstructor//生成无参构造器
@AllArgsConstructor//生成有参构造器
@Data
@TableName("user")
public class User {
    //id值雪花算法，mybaitsPlus的生成主键是Bigint
    private Long id;
    private String name;
    private Integer age;
    private String email;
}

注意，这里用到了lombak插件，在实体类上方
添加@Setter即可认为其已经生成set方法
添加@Getter即可认为其已经生成get方法
添加@NoArgsConstructor即可认为其生成无参构造器
添加@ArgsConstructor即可认为其生成无参构造器
添加@Data，会为类的所有属性自动添加Set/Get方法，equals,canEqual,hashCode,toString方法。

添加mapper
BaseMapper是MyBatis-Plus提供的模板mapper，其中包含了基本的CRUD方法，泛型为操作的实体类型

@Repository
public interface UserMapper extends BaseMapper<User> {
}

注意：IDEA在 userMapper 处报错，因为找不到注入的对象，因为类是动态创建的，但是程序可以正确的执行。
为了避免报错，可以在mapper接口上添加 @Repository 注解
例如：在测试类中

@Autowired
private UserMapper userMapper;

@Test
public void test(){
    List<User> userList = userMapper.selectList(null);
    for(User user:userList){
        System.out.println(user);
    }
}

结果如下：可以查询到数据
在这里插入图片描述
添加日志
在application.yml中配置日志输出

#配置mybatis日志
mybatis-plus:
  configuration:
    log-impl: org.apache.ibatis.logging.stdout.StdOutImp

加上后输出就会带有日志信息
在这里插入图片描述

基本CRUD

通用Mapper

MyBatis-Plus中的基本CRUD在内置的BaseMapper中都已得到了实现，我们可以直接使用.
所以在编写mapper类时直接继承既可以使用MybatisPlus中已经写好的很多方法（增删改查）
例如：

public interface UserMapper extends BaseMapper<User> {
}

增删改查

新增

@Test
public void testInsert(){
    //创建User对象进行新增
    User user = new User();
    user.setAge(16);
    user.setEmail("45131@qqcom");
    user.setName("阿斯蒂芬");
    int insert = userMapper.insert(user);
    System.out.println(insert);
}

删除
这里演示三种删除方式

@Test
public void deleteTest(){
    //根据id删除
    int res = userMapper.deleteById(1760629000947924994L);
    //因为是雪花算法生成的id，在数据库中bigint类型，因此在数值的最后加上L
    System.out.println("影响了"+res+"行");
    //根据map集合
    Map<String, Object> map = new HashMap<>();
    map.put("age", 21);
    map.put("name", "Sandy");
    int result = userMapper.deleteByMap(map);
    System.out.println("受影响行数："+result);
    //根据id批量删除
    List<Long> idList = Arrays.asList(1760630385126961154L, 1760630323579748354L, 3L);
    int r = userMapper.deleteBatchIds(idList);
    System.out.println("受影响行数："+r);
}

修改
根据Id修改

@Test
public void update(){
    //创建实体
    User user = new User();
    user.setId(1L);
    user.setName("sadas");
    user.setAge(16);
    user.setEmail("3424@jk.com");
    int result = userMapper.updateById(user);
    System.out.println("受影响行数："+result);
}

查询

@Test
public void select(){
    //根据id查询
    User user = userMapper.selectById(1L);
    System.out.println(user);
    //根据多个id查询多个用户信息
    List<Long> idList = Arrays.asList(1L, 5L);
    List<User> list = userMapper.selectBatchIds(idList);
    list.forEach(System.out::println);
    //通过map条件查询用户信息
    Map<String, Object> map = new HashMap<>();
    map.put("age", 20);
    map.put("name", "Jack");
    List<User> list2 = userMapper.selectByMap(map);
    list2.forEach(System.out::println);
    //查询所有数据
    List<User> listTotal = userMapper.selectList(null);
    listTotal.forEach(System.out::println);
}

通用Service

说明:
通用 Service CRUD 封装IService接口，进一步封装 CRUD 采用 get 查询单行 remove 删除 list 查询集合 page 分页前缀命名方式区分 Mapper 层避免混淆。
泛型 T 为任意实体对象。
如果存在自定义通用 Service 方法的可能，请创建自己的 IBaseService 继承Mybatis-Plus 提供的基类
IService
MyBatis-Plus中有一个接口 IService和其实现类 ServiceImpl，封装了常见的业务层逻辑
详情可以查看源码IService和ServiceImpl
创建Service接口和实现类
接口：

/**
* UserService继承IService模板提供的基础功能
*/
public interface UserService extends IService<User> {
}

实现类：（记得加@Service)

/**
* ServiceImpl实现了IService，提供了IService中基础功能的实现
* 若ServiceImpl无法满足业务需求，则可以使用自定的UserService定义方法，并在实现类中实现 */
@Service
public class UserServiceImpl extends ServiceImpl<UserMapper,User> implements UserService {
}

测试查询记录数

@Autowired
private UserService userService;
@Test
public void testCount(){
    long count = userService.count();
    System.out.println(count);
}

测试批量插入

@Test
public void testSaveBatch(){
   // SQL长度有限制，海量数据插入单条SQL无法实行，
   // 因此MP将批量插入放在了通用Service中实现，而不是通用Mapper
   ArrayList<User> users = new ArrayList<>();
   for (int i = 0; i < 5; i++) {
       User user = new User();
       user.setName("ybc" + i);
       user.setAge(20 + i);
       users.add(user);
   }
   userService.saveBatch(users);
}

常用注解

@TableName

若实体类类型的类名和要操作的表的表名不一致时会导致程序报错
例如：如果将表user更名为t_user ，测试查询功能，程序会抛出异常， Table 'mybatis_plus.user’doesn’t exist，因为现在的表名为t_user ，而默认操作的表名和实体类型的类名一致，即user表。
那么如何解决呢？
可以通过@TableName来解决问题
在实体类类型上添加@TableName(“t_user”)，标识实体类对应的表，即可成功执行SQL语句
在这里插入图片描述
那么如果很多表名都发生了更改，一个一个实体类加注解就会很慢，
这种情况可以通过springboot的yaml配置文件中增加Mybatis的全局配置来解决

mybatis-plus:
  configuration:
    # 配置MyBatis日志
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
  global-config:
    db-config:
      # 配置MyBatis-Plus操作表的默认前缀
      table-prefix: t_

这样就给全部的实体类的前面都加上t_前缀，就可以和数据库中对应上了

@TableId

MyBatis-Plus在实现CRUD时，会默认将id作为主键列，并在插入数据时，默认基于雪花算法的策略生成id
若实体类和表中表示主键的不是id，而是其他字段，例如uid ， MyBatis-Plus不会自动识别uid为主键列，会报错。
面对这个问题可以通过@TableId注解来解决
在实体类中uid属性上通过@TableId将其标识为主键，即可成功执行SQL语句
在这里插入图片描述
@TableId的value属性
若实体类中主键对应的属性为id，而表中表示主键的字段为uid，此时若只在属性id上添加注解 @TableId，则抛出异常Unknown column’id’in’field list’，即MyBatis-Plus仍然会将id作为表的主键操作，而表中表示主键的是字段uid
此时需要通过@TableId注解的value属性，指定表中的主键字段， @TableId(“uid”)或@TableId(value=“uid”)
@TableId的type属性
type属性用来定义主键策略
IdType.ASSIGN_ID （默认）：基于雪花算法的策略生成数据id，与数据库id是否设置自增无关
IdType.AUTO：使用数据库的自增策略，注意，该类型请确保数据库设置了id自增，否则无效
也可以在配置中设置主键配置

mybatis-plus:
  configuration:
    # 配置MyBatis日志
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
  global-config:
    db-config:
      # 配置MyBatis-Plus操作表的默认前缀
      table-prefix: t_
      # 配置MyBatis-Plus的主键策略
      id-type: auto

@TableField

经过以上的测试，我们可以发现， MyBatis-Plus在执行SQL语句时，要保证实体类中的属性名和表中的字段名一致
如果实体类中的属性名和字段名不一致的情况，会出现以下问题：
问题1：
若实体类中的属性使用的是驼峰命名风格，而表中的字段使用的是下划线命名风格
例如实体类属性userName，表中字段user_name，此时MyBatis-Plus会自动将下划线命名风格转化为驼峰命名风格
相当于在MyBatis中配置。
问题2：
若实体类中的属性和表中的字段不满足情况1
例如实体类属性name ，表中字段username
面对问题2，此时需要在实体类属性上使用@TableField(“username”)设置属性所对应的字段名，就像前面修正id一样
在这里插入图片描述

@TableLogic

该注解可以实现逻辑删除
那么什么是逻辑删除？
逻辑删除：假删除，将对应数据中代表是否被删除字段的状态修改为“被删除状态”，之后在数据库
中仍旧能看到此条数据记录。可以用来进行数据恢复（例如商城网站的商品上架下架功能）

实现逻辑删除：
1.数据库中创建逻辑删除状态列，设置默认值为0
2.实体类中添加逻辑删除属性，并加上注解
在这里插入图片描述
这样就可以实现逻辑删除了
这样实现逻辑删除后，在使用时就会发生变化，
当我们使用删除功能时，真正执行的其实是修改功能，例如：UPDATE t_user SET is_deleted=1 WHERE id=? AND is_deleted=0
当使用查询功能，被逻辑删除的数据默认不会被查询，例如：SELECT id,username AS name,age,email,is_deleted FROM t_user WHERE is_deleted=0

条件构造器和常用接口

在这里插入图片描述

Wrapper ：条件构造抽象类，最顶端父类
AbstractWrapper ：用于查询条件封装，生成 sql 的 where 条件
QueryWrapper ：查询条件封装
UpdateWrapper ： Update 条件封装
AbstractLambdaWrapper ：使用Lambda 语法
LambdaQueryWrapper ：用于Lambda语法使用的查询Wrapper
LambdaUpdateWrapper ： Lambda 更新封装Wrapper

QueryWrappr

组装查询条件

/**
 * 测试体哦阿健构造器的查询功能
 */
@Test
public void test01(){
    //创造查询条件的条件构造器对象
    QueryWrapper<User> wrapper = new QueryWrapper<>();
    //构造条件
    wrapper.like("name","a")
          .between("age",20,30)
          .isNotNull("email");
    List<User> userList = userMapper.selectList(wrapper);
    //遍历结果
    userList.forEach(System.out::println);
}

组装排序条件

**
 * 测试排序
 */
@Test
public void test3(){
    //按年龄降序查询用户，如果年龄相同则按id升序排列
    //SELECT id,username AS name,age,email,is_deleted FROM t_user WHERE is_deleted=0 ORDER BY age DESC,id ASC
    QueryWrapper<User> wrapper = new QueryWrapper<>();
    wrapper.orderByDesc("age")
            .orderByAsc("id");
    List<User> userList = userMapper.selectList(wrapper);
    userList.forEach(System.out::println);
}

组装删除条件

/**
 * 测试条件构造器的删除功能
 */
@Test
public void test(){
    //创造查询条件的条件构造器对象
    QueryWrapper<User> wrapper = new QueryWrapper<>();
    wrapper.isNull("email");
    //根据条件构造器进行删除
    int delete= userMapper.delete(wrapper);
    System.out.println(delete);
}

条件的优先级

/**
 * 测试条件构造器的优先级
 */
@Test
public void test4(){
    QueryWrapper<User> wrapper = new QueryWrapper<>();
    //将（年龄大于20并且用户名中包含有a）或邮箱为null的用户信息修改
    //UPDATE t_user SET age=?, email=? WHERE (username LIKE ? AND age > ? OR email IS NULL)
    wrapper.lt("age",20)
            .like("name","a")
            .or()
            .isNull("email");
    User user = new User();
    user.setName("gdsmfd");
    user.setEmail("8955.com");
    //修改
    int update=userMapper.update(user,wrapper);
    System.out.println("影响行数："+update);
}
@Test
public void test5(){
    QueryWrapper<User> wrapper = new QueryWrapper<>();
    //将用户名中包含有a并且（年龄大于20或邮箱为null）的用户信息修改
    //UPDATE t_user SET age=?, email=? WHERE (username LIKE ? AND (age > ? OR email IS NULL))
    //jdk8 lamada表达式的语法 箭头函数 i指的是当前的条件构造器对象
    //因为mp在组装sql时会认为 lamada表达式条件优先执行
    wrapper.like("name","a")
            .and(i->i.gt("age",20).or().isNull("email"));
    User user = new User();
    user.setName("hhhhhh");
    user.setEmail("89554315.com");
    //修改
    int update=userMapper.update(user,wrapper);
    System.out.println("影响行数："+update);
}

组装select子句

/**
 * 测试条件构造器的指定字段查询
 */
@Test
public void test6(){
    QueryWrapper<User> wrapper = new QueryWrapper<>();
    wrapper.select("name","age");
    List<Map<String,Object>> maps = userMapper.selectMaps(wrapper);
    maps.forEach(System.out::println);
}

实现子查询

/**
 * 测试条件构造器的子查询构造
 */
@Test
public void test7(){
    QueryWrapper<User> wrapper = new QueryWrapper<>();
    wrapper.inSql("id","select id from user where id < 90");
    List<User> userList = userMapper.selectList(wrapper);
    userList.forEach(System.out::println);
}

UpdateWrapper
与QueryWrapper相比不用再单独创建user对象，可以直接在wrapper中设置修改值，但是一般只用在修改的场景

/**
 * 测试updatewrapper
 */
@Test
public void test8(){
    //将（年龄大于20或邮箱为null）并且用户名中包含有a的用户信息修改
    //组装set子句以及修改条件
    UpdateWrapper<User> updateWrapper = new UpdateWrapper<>();
    updateWrapper.set("age",18)
            .set("email","sad123.com")
            .like("name","g")
            .and(i->i.lt("age",20).or().isNull("email"));
    //这里必须要创建User对象，否则无法应用自动填充。如果没有自动填充，可以设置为null
    int result = userMapper.update(null,updateWrapper);
    System.out.println(result);
}

condition

在真正开发的过程中，编写动态SQL语句，组装条件是常见的功能，而这些条件数据来源于用户输入，是可选的，因此我们在组装这些条件时，必须先判断用户是否选择了这些条件，若选择则需要组装该条件，若没有选择则一定不能组装，以免影响SQL执行的结果
面对这种情况，一个挨个判断，但是太麻烦，此时就可以使用带condition参数的重载方法构建查询条件，简化代码的编写
思路一（麻烦）

@Test
public void test08() {
   //定义查询条件，有可能为null（用户未输入或未选择）
   String username = null;
   Integer ageBegin = 10;
   Integer ageEnd = 24;
   QueryWrapper<User> queryWrapper = new QueryWrapper<>();
   //StringUtils.isNotBlank()判断某字符串是否不为空且长度不为0且不由空白符(whitespace) 构成
   if(StringUtils.isNotBlank(username)){
      queryWrapper.like("username","a");
   }
   if(ageBegin != null){
      queryWrapper.ge("age", ageBegin);
   }
   if(ageEnd != null){
      queryWrapper.le("age", ageEnd);
   }
   //SELECT id,username AS name,age,email,is_deleted FROM t_user WHERE (age >= ? AND age <= ?)
   List<User> users = userMapper.selectList(queryWrapper);
   users.forEach(System.out::println);
}

思路二（简单）带condition参数

@Test
public void test08UseCondition() {
   //定义查询条件，有可能为null（用户未输入或未选择）
   String username = null;
   Integer ageBegin = 10;
   Integer ageEnd = 24;
   QueryWrapper<User> queryWrapper = new QueryWrapper<>();
   //StringUtils.isNotBlank()判断某字符串是否不为空且长度不为0且不由空白符(whitespace) 构成
   queryWrapper
      .like(StringUtils.isNotBlank(username), "username", "a")
      .ge(ageBegin != null, "age", ageBegin)
      .le(ageEnd != null, "age", ageEnd);
   //SELECT id,username AS name,age,email,is_deleted FROM t_user WHERE (age >= ? AND age <= ?)
   List<User> users = userMapper.selectList(queryWrapper);
   users.forEach(System.out::println);
}

LambdaQueryWrapper、LambdaUpdateWrapper

我们在使用前面的方法时在写字段时可能会写错
在这里插入图片描述
我们可以使用Lambada表达式来避免这种失误，通过写表达式就不会出现这种情况
例如：

@Test
public void test10(){
    String name = "a";
    Integer ageBegin = 10;
    Integer ageEnd = 24;
    LambdaQueryWrapper<User> queryWrapper = new LambdaQueryWrapper<>();
    //避免使用字符串表示字段，防止运行时错误
    queryWrapper
            .like(StringUtils.isNotBlank(name), User::getName, name) .ge(ageBegin != null, User::getAge, ageBegin)
            .le(ageEnd != null, User::getAge, ageEnd);
    List<User> users = userMapper.selectList(queryWrapper);
    users.forEach(System.out::println);
}
@Test
public void test11(){
    LambdaUpdateWrapper<User> updateWrapper = new LambdaUpdateWrapper<>(); updateWrapper
            .set(User::getAge, 18)
            .set(User::getEmail, "user@atguigu.com")
            .like(User::getName, "a")
            .and(i -> i.lt(User::getAge, 24).or().isNull(User::getEmail)); //lambda 表达式内的逻辑优先运算
    User user = new User();
    int result = userMapper.update(user, updateWrapper);
    System.out.println("受影响的行数：" + result);
}

插件

分页插件

MyBatis Plus自带分页插件，只要简单的配置即可实现分页功能
添加配置类，构建分页插件交给spring去管理，构建了一个拦截来处理分页
注意：每一个数据库厂商对分页的实现有所不同，因此在声明的时候应该指定好所用的数据库来避免出错

@Configuration
@MapperScan("com.qcby.springboot.mapper")
public class MyConfig {
    @Bean
    public MybatisPlusInterceptor mybatisPlusInterceptor() {
        MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
        interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL));
        return interceptor;
    }
}

测试

@Test
public void testPage(){
    //设置分页参数
    Page<User> page = new Page<>(1, 5);
    userMapper.selectPage(page, null);
     //获取分页数据
    List<User> list = page.getRecords();
    list.forEach(System.out::println);
    System.out.println("当前页："+page.getCurrent());
    System.out.println("每页显示的条数："+page.getSize());
    System.out.println("总记录数："+page.getTotal());
    System.out.println("总页数："+page.getPages());
    System.out.println("是否有上一页："+page.hasPrevious());
    System.out.println("是否有下一页："+page.hasNext());
}

测试结果：
在这里插入图片描述

自定义分页

想要自定义的分页查询需要使用另一种方式，比如我想要查询年龄大于20岁的人并进行分页展示
先在UserMapper中定义接口方法

@Repository
public interface UserMapper extends BaseMapper<User> {
    /**
     * 根据年龄查询用户列表，分页显示
     * @param page 分页对象 ,xml中可以从里面进行取值 ,传递参数 Page 即自动分页 ,必须放在第一位
     * @param age 年龄
     * @return */
    //@param注解处理对各参数
    Page<User> selectPageVo(@Param("page") Page<User> page, @Param("age") Integer age);
}

UserMapper.xml中编写SQL
在resources文件夹下的mapper文件夹下创建配置文件
编写自定义的sql语句

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.qcby.springboot.mapper.UserMapper">
    <!--这里依旧使用MP的分页插件，因此不需要写limit，最后会自动拼接上-->
    <!--注意此时的sql一定不要加;，最好也不要加注释，因为会影响到最后的limit拼接-->
    <select id="selectPageVo" resultType="com.qcby.springboot.pojo.User">
        SELECT id,name,age,email from user WHERE age > #{age}
    </select>
</mapper>

进行测试：

@Test
public void testPage2(){
    //设置分页参数
    Page<User> page = new Page<>(1, 5);
    userMapper.selectPageVo(page, 20);
    //获取分页数据
    List<User> list = page.getRecords();
    list.forEach(System.out::println);
    System.out.println("当前页："+page.getCurrent());
    System.out.println("每页显示的条数："+page.getSize());
    System.out.println("总记录数："+page.getTotal());
    System.out.println("总页数："+page.getPages());
    System.out.println("是否有上一页："+page.hasPrevious());
    System.out.println("是否有下一页："+page.hasNext());
}

结果：数据库中符合条件的只有一条
在这里插入图片描述

乐观锁

假设有以下场景
一件商品，成本价是80元，售价是100元。老板先是通知小李，说你去把商品价格增加50元。小李正在玩游戏，耽搁了一个小时。正好一个小时后，老板觉得商品价格增加到150元，价格太高，可能会影响销量。又通知小王，你把商品价格降低30元。此时，小李和小王同时操作商品后台系统。小李操作的时候，系统先取出商品价格100元；小王也在操作，取出的商品价格也是100元。小李将价格加了50元，并将100+50=150元存入了数据库；小王将商品减了30元，并将100-30=70元存入了数据库。是的，如果没有锁，小李的操作就完全被小王的覆盖了。
现在商品价格是70元，比成本价低10元。几分钟后，这个商品很快出售了1千多件商品，老板亏1 万多。

上面的故事，如果是乐观锁，小王保存价格前，会检查下价格是否被人修改过了。如果被修改过了，则重新取出的被修改后的价格，150元，这样他会将120元存入数据库。
如果是悲观锁，小李取出数据后，小王只能等小李操作完之后，才能对价格进行操作，也会保证最终的价格是120元。

模拟修改冲突
现在用一个实际的程序来模拟这个修改冲突
数据库中建立一个商品表，增加一个数据

CREATE TABLE t_product
(
id BIGINT(20) NOT NULL COMMENT '主键ID',
NAME VARCHAR(30) NULL DEFAULT NULL COMMENT '商品名称 ',
price INT(11) DEFAULT 0 COMMENT '价格 ',
VERSION INT(11) DEFAULT 0 COMMENT '乐观锁版本号 ',
PRIMARY KEY (id)
);
INSERT INTO t_product (id, NAME, price) VALUES (1, '外星人笔记本 ', 100);

想要对该表进行操作需要建立一个实体和一个mapper接口
实体：

@Data
@TableName("t_product")
public class Product {
    //id值
    private Long id;
    //商品名称
    private String name;
    //商品价格
    private Integer price;
    //版本号 获取完数据 操作了更新数据 版本号+1进行修改
    private Integer version;
}

添加mapper

//商品的持久层接口，继承BaseMapper实现乐观锁
@Repository
public interface ProductMapper extends BaseMapper<Product> {
}

测试模拟冲突：

@SpringBootTest
public class TestConcurrentUpdate {
    @Autowired
    private ProductMapper productMapper;
    @Test
    public void testConcurrentVersionUpdate() {
        //小李取数据 价格：100
        Product p1 = productMapper.selectById(1L);
        System.out.println("小李拿到的价格："+p1.getPrice());
        //小王取数据 价格：100
        Product p2 = productMapper.selectById(1L);
        System.out.println("小王拿到的价格："+p2.getPrice());
        //小李修改 + 50
        p1.setPrice(p1.getPrice() + 50);
        int result1 = productMapper.updateById(p1);
        //小王修改 - 30
        p2.setPrice(p2.getPrice() - 30);
        int result2 = productMapper.updateById(p2);
        System.out.println("小王修改重试的结果：" + result2);
        //老板看价格，此时最后结果会是70
        Product p3 = productMapper.selectById(1L);
        System.out.println("老板看价格：" + p3.getPrice());
    }
}

这样测试出来结果就像上面冲突中说的一样，结果为70，出现了错误。
我们可以用MybatisPlus的乐观锁或者悲观锁来避免这种情况，现在使用乐观锁。

乐观锁的工作流程：
数据库中添加version字段
取出记录时，获取当前version

SELECT id,`name`,price,`version` FROM product WHERE id=1

更新时， version + 1，如果where语句中的version版本不对，则更新失败

UPDATE product SET price=price+50, `version`=`version` + 1 WHERE id=1 AND `version`=1

MybatisPlus中实现乐观锁
首先之前在表中添加的version字段，这个字段用来记录版本号，记录下每次的修改，后面就可以根据该字段判断是否修改过
下面在实体类的version变量上加上@version注解
后面在配置类中添加乐观锁配置

@Configuration
public class MyConfig {
    @Bean
    public MybatisPlusInterceptor mybatisPlusInterceptor() {
        MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
        //添加分页插件
        interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL));
        //添加乐观锁插件
        interceptor.addInnerInterceptor(new OptimisticLockerInnerInterceptor());
        return interceptor;
    }
}

最后优化流程，即可使结果正确，避免了冲突

@SpringBootTest
public class TestConcurrentUpdate {
    @Autowired
    private ProductMapper productMapper;
    @Test
    public void testConcurrentVersionUpdate() {
        //小李取数据 价格：100
        Product p1 = productMapper.selectById(1L);
        System.out.println("小李拿到的价格："+p1.getPrice());
        //小王取数据 价格：100
        Product p2 = productMapper.selectById(1L);
        System.out.println("小王拿到的价格："+p2.getPrice());
        //小李修改 + 50
        p1.setPrice(p1.getPrice() + 50);
        int result1 = productMapper.updateById(p1);
        //小王修改 - 30
        p2.setPrice(p2.getPrice() - 30);
        int result2 = productMapper.updateById(p2);
        if(result2 == 0){
            //如果失败则重试，重新获取version并更新
            p2 = productMapper.selectById(1L);
            p2.setPrice(p2.getPrice() - 30);
            result2 = productMapper.updateById(p2);
        }
        System.out.println("小王修改重试的结果：" + result2);
        //老板看价格，此时的价格是正确的
        Product p3 = productMapper.selectById(1L);
        System.out.println("老板看价格：" + p3.getPrice());
    }
}

通用枚举

数据表中的有些字段值是固定的，例如性别（男或女），此时我们可以使用MyBatis-Plus的通用枚举来实现
我们的用户表添加一个性别字段来实现枚举功能
首先数据库中添加一个sex字段，用int类型来表示
在这里插入图片描述
创建通用枚举类型：

/**
 * 创建一个枚举来定义性别
 */
@Getter//里面是写死的，一般只用来获取值，所以只需要get就可以
public enum SexEnum {
    MALE(1, "男"),
    FEMALE(2, "女");//1代表男，2代表女
    @EnumValue
    private Integer sex;
    private String sexName;
    SexEnum(Integer sex, String sexName) {
        this.sex = sex;
        this.sexName = sexName;
    }
}

在实体类User中添加sex属性，并加上注解
@EnumValue //此注解标注的属性值存入数据库
private SexEnum sex;

在配置文件中添加mybatisplus的枚举配置

#配置mybatis日志
mybatis-plus:
  configuration:
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
  type-enums-package: com.qcby.springboot.enums

进行测试：添加一条信息

@Autowired
private UserMapper userMapper;
/**
 * 测试枚举设置性别信息
 */
@Test
public void test01(){
    User user = new User();
    user.setName("Enum");
    user.setAge(20);
    //设置性别信息为枚举项，会将@EnumValue注解所标识的属性值存储到数据库
    user.setSex(SexEnum.MALE);
    //INSERT INTO t_user ( username, age, sex ) VALUES ( ?, ?, ? ) //Parameters: Enum(String), 20(Integer), 1(Integer)
    userMapper.insert(user);
}

代码生成器

使用代码生成器可以在指定目录自动生成各种代码（mapper，service,controller等）
首先导入依赖

<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-generator</artifactId>
    <version>3.5.1</version>
</dependency>
<dependency>
    <groupId>org.freemarker</groupId>
    <artifactId>freemarker</artifactId>
    <version>2.3.31</version>
</dependency>

编写一个类进行快速生成

public class FastAutoGeneratorTest {
    public static void main(String[] args) {
        //连接数据库
        FastAutoGenerator.create("jdbc:mysql://127.0.0.1:3306/mybatis_plus?serverTimezone=GMT%2B8",
                "root",
                "202306")
                //全局配置
                .globalConfig(builder -> {
                    builder.author("qcby") // 设置作者
                            //.enableSwagger() // 开启 swagger 模式
                            .fileOverride() // 覆盖已生成文件
                            .outputDir("D://mybatis_plus"); // 指定输出目录
                })
                //设置包的
                .packageConfig(builder -> {
                    builder.parent("com.qcby") // 设置父包名
                            .moduleName("springboot") // 设置父包模块名
                            .pathInfo(Collections.singletonMap(OutputFile.mapperXml, "D://mybatis_plus"));
                    // 设置mapperXml生成路径
                })
                //策略的配置
                .strategyConfig(builder -> {
                    builder.addInclude("user"); // 设置需要生成的表名
//                           // .addTablePrefix("t_", "c_"); // 设置过滤表前缀 可以设置多个值
                })
                .templateEngine(new FreemarkerTemplateEngine())
                // 使用Freemarker引擎模板，默认的是Velocity引擎模板
                //.execute()执行的意思
                .execute();
    }
}

通过运行主方法便生成了user表要用到的各种文件
结果如下：
在这里插入图片描述

多数据源

适用于多种场景：纯粹多库、读写分离、一主多从、混合模式等
目前我们就来模拟一个纯粹多库的一个场景，其他场景类似
场景说明：
我们创建两个库，分别为： mybatis_plus（以前的库不动）与mybatis_plus_1 （新建），将
mybatis_plus库的product表移动到mybatis_plus_1库，这样每个库一张表，通过一个测试用例分别获取用户数据与商品数据，如果获取到说明多库模拟成功
首先导入依赖

<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>dynamic-datasource-spring-boot-starter</artifactId>
    <version>3.5.0</version>
</dependency>

再创建一个数据库mybatisplus_1,并把product表移到该库中
yaml文件配置多数据源，
primary参数用于设置默认的数据源或者数据源组，下面设置的默认为master
strict参数用于严格匹配数据源 ,默认false。如果设置为true时，未匹配到指定数据源时抛异常，false如果没有匹配到会自动使用默认数据源

spring:
  datasource:
    dynamic:
    # 设置默认的数据源或者数据源组 ,默认值即为master
      primary: master
    # 严格匹配数据源 ,默认false.true未匹配到指定数据源时抛异常 ,false使用默认数据源
      strict: false
      datasource:
        master:
            url: jdbc:mysql://localhost:3306/mybatis_plus?serverTimezone=GMT%2B8
            driver-class-name: com.mysql.cj.jdbc.Driver
            username: root
            password: 202306
        slave_1:
            url: jdbc:mysql://localhost:3306/mybatis_plus_1?serverTimezone=GMT%2B8
            driver-class-name: com.mysql.cj.jdbc.Driver
            username: root
            password: 202306

创建product的service和实现类，注意在实现类上要加上注解@DS来匹配多个数据库，如果不加会自动使用默认数据源

public interface ProductService extends IService<Product> {
}
@Service
@DS("slave_1")
public class ProductServiceImpl extends ServiceImpl<ProductMapper,Product> implements ProductService {
}

测试：

@SpringBootTest
public class TestDataSource {
    @Autowired
    private UserService userService;
    @Autowired
    private ProductService productService;

    @Test
    public void testDynamicDataSource(){
        System.out.println(userService.getById(1L));
        System.out.println(productService.getById(1L));
    }
}

如果能顺利获取对象，则测试成功
至此MybatisPlus的内容介绍完毕，希望可以帮助到你。

深夜无眠T

关注

23
点赞
踩
26

收藏

觉得还不错? 一键收藏
1
评论
MybatisPlus入门详解

本篇文章将对MybatisPlus进行一个入门级别的讲解，将会讲解MybatisPlus的大部分知识点，可以帮助你成功入门MybatisPlus。另外要注意，本篇文章的讲解是在springboot的环境下进行讲解，如果你对springboot没有了解，推荐先去了解学习springboot，我之前也发过springboot的入门讲解，可以去看一看，两篇文章结合起来观看效果更佳。
复制链接

扫一扫