MyBatis-Plus （SpringBoot2 版） Learning Day01

Posted 2023-02-18

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了MyBatis-Plus （SpringBoot2 版） Learning Day01相关的知识，希望对你有一定的参考价值。

Day 01 学习任务

• 了解Mybatis-Plus

• 整合Mybatis-Plus

• 通用CRUD Mybatis-Plus的配置

• 条件构造器

1、了解 Mybatis-plus

1.1、Mybatis-Plus 介绍

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

官网：https://mybatis.plus/ 或 https://mp.baomidou.com/

MP愿景

我们的愿景是成为 MyBatis 最好的搭档，就像 魂斗罗 中的 1P、2P，基友搭配，效率翻倍。

1.2、代码以及文档

文档地址：https://mybatis.plus/guide/ 源码地址：https://github.com/baomidou/mybatis-plus

1.3、特性

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

1.4、架构

2、快速上手

对于Mybatis整合MP有常常有三种用法，分别是Mybatis+MP、Spring+Mybatis+MP、Spring Boot+Mybatis+MP。

2.1、创建数据库以及表

-- 创建测试表
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, \'[e-mail]\'),
(2, \'Jack\', 20, \'[e-mail]\'),
(3, \'Tom\', 28, \'[e-mail]\'),
(4, \'Sandy\', 21, \'[e-mail]\'),
(5, \'Billie\', 24, \'[e-mail]\');

2.2、创建 SpringBoot 工程

使用 Spring Initializr 快速初始化一个 Spring Boot 工程

引入依赖

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>
  <parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.4.5</version>
    <relativePath/> <!-- lookup parent from repository -->
  </parent>

  <groupId>com.riotian</groupId>
  <artifactId>MyBatis-Plus-Learn</artifactId>
  <version>0.0.1-SNAPSHOT</version>

  <properties>
    <maven.compiler.source>8</maven.compiler.source>
    <maven.compiler.target>8</maven.compiler.target>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  </properties>

  <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>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-web</artifactId>
      <scope>compile</scope>
    </dependency>

    <dependency>
      <groupId>com.baomidou</groupId>
      <artifactId>mybatis-plus-boot-starter</artifactId>
      <version>3.4.2</version>
    </dependency>

    <dependency>
      <groupId>org.projectlombok</groupId>
      <artifactId>lombok</artifactId>
      <version>1.18.20</version>
    </dependency>

    <dependency>
      <groupId>com.alibaba</groupId>
      <artifactId>fastjson</artifactId>
      <version>1.2.76</version>
    </dependency>

    <dependency>
      <groupId>commons-lang</groupId>
      <artifactId>commons-lang</artifactId>
      <version>2.6</version>
    </dependency>

    <dependency>
      <groupId>mysql</groupId>
      <artifactId>mysql-connector-java</artifactId>
      <scope>runtime</scope>
    </dependency>

    <dependency>
      <groupId>com.alibaba</groupId>
      <artifactId>druid-spring-boot-starter</artifactId>
      <version>1.1.23</version>
    </dependency>

  </dependencies>

  <build>
    <plugins>
      <plugin>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-maven-plugin</artifactId>
        <version>2.4.5</version>
      </plugin>
    </plugins>
  </build>

</project>

编写 application.yaml 文件

spring:
  datasource:
    druid:
      driver-class-name: com.mysql.cj.jdbc.Driver
      url: jdbc:mysql://localhost:3306/mybatis_plus?serverTimezone=Asia/Shanghai&useUnicode=true&characterEncoding=utf-8&zeroDateTimeBehavior=convertToNull&useSSL=false&allowPublicKeyRetrieval=true
      username: root
      password: kokoro

启动类设置

在Spring Boot启动类中添加@MapperScan注解，扫描mapper包

@SpringBootApplication
@MapperScan("com.riotian.mplearn.mapper") // mapper 包存放的路径
public class MyBatisPlusLearnApplication 

    public static void main(String[] args) 
        SpringApplication.run(MyBatisPlusLearnApplication.class, args);
    

添加实体

@Data
public class User 
    private Long id;
    private String name;
    private Integer age;
    private String email;

User类编译之后的结果：

添加 mapper

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

@Repository // 保障动态注入成功
public interface UserMapper extends BaseMapper<User> 

测试

@SpringBootTest
public class MP_Test 

    @Autowired
    private UserMapper userMapper; // @Repository 保障注入成功

    @Test
    public void testSelectList()
        //selectList()根据MP内置的条件构造器查询一个list集合，null表示没有条件，即查询所有
        userMapper.selectList(null).forEach(System.out::println);
    

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

添加日志

在application.yml中配置日志输出

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

3、基本 CRUD

3.1、BaseMapper

MyBatis-Plus中的基本CRUD在内置的BaseMapper中都已得到了实现，我们可以直接使用，接口如下：

Mapper 继承该接口后，无需编写 mapper.xml 文件，即可获得CRUD功能

package com.baomidou.mybatisplus.core.mapper;

public interface BaseMapper<T> 
    //插入一条记录  参数：实体  返回：int
    Integer insert(T entity);
 
    //根据 ID 删除  参数：主键ID  返回：int
    Integer deleteById(Serializable id);
    
     //根据 columnMap 条件，删除记录  参数：表字段 map 对象  返回：int
    Integer deleteByMap(@Param("cm") Map<String, Object> columnMap);
 
     //根据 entity 条件，删除记录  参数：实体对象封装操作类（可以为 null）  返回：int
    Integer delete(@Param("ew") Wrapper<T> wrapper);
 
     //删除（根据ID 批量删除）  参数：主键ID列表  返回：int
    Integer deleteBatchIds(List<? extends Serializable> idList);
 
     //根据 ID 修改  参数：实体对象  返回：int
    Integer updateById(T entity);
 
     //根据 whereEntity 条件，更新记录  参数：实体对象,实体对象封装操作类（可以为 null） 返回：int
    Integer update(@Param("et") T entity, @Param("ew") Wrapper<T> wrapper);
 
     //根据 ID 查询  参数：主键ID  返回：T
    T selectById(Serializable id);
 
     //查询（根据ID 批量查询）  参数：主键ID列表  返回：List<T>
    List<T> selectBatchIds(List<? extends Serializable> idList);
 
     //查询（根据 columnMap 条件）  参数：表字段 map 对象  返回：List<T>
    List<T> selectByMap(@Param("cm") Map<String, Object> columnMap);
 
     //根据 entity 条件，查询一条记录  参数：实体对象  返回：T
    T selectOne(@Param("ew") T entity);

     //根据 Wrapper 条件，查询总记录数  参数：实体对象  返回：int
    Integer selectCount(@Param("ew") Wrapper<T> wrapper);
 
     //根据 entity 条件，查询全部记录  参数：实体对象封装操作类（可以为 null）  返回：List<T>
    List<T> selectList(@Param("ew") Wrapper<T> wrapper);
 
     //根据 Wrapper 条件，查询全部记录  参数：实体对象封装操作类（可以为 null） 返回：List<T>
    List<Map<String, Object>> selectMaps(@Param("ew") Wrapper<T> wrapper);
 
     //根据 Wrapper 条件，查询全部记录  参数：实体对象封装操作类（可以为 null）  返回：List<Object>
    List<Object> selectObjs(@Param("ew") Wrapper<T> wrapper);
 
    /** 
     * 用法：(new RowBounds(offset, limit), ew);
     * 根据 entity 条件，查询全部记录（并翻页）
     * @param rowBounds
     * 分页查询条件（可以为 RowBounds.DEFAULT）
     * @param wrapper
     * 实体对象封装操作类（可以为 null）
     * @return List<T>
     */
     //根据 ID 删除  参数：主键ID  返回：int
    List<T> selectPage(RowBounds rowBounds, @Param("ew") Wrapper<T> wrapper);
 
    /** -- 不常用,
     * 根据 Wrapper 条件，查询全部记录（并翻页）
     * @param rowBounds
     * 分页查询条件（可以为 RowBounds.DEFAULT）
     * @param wrapper
     * 实体对象封装操作类
     * @return List<Map<String, Object>>
     */
     //根据 ID 删除  参数：主键ID  返回：int
    List<Map<String, Object>> selectMapsPage(RowBounds rowBounds, @Param("ew") Wrapper<T> wrapper);

// 用法举例
// 接口：
public interface UserDao extends BaseMapper<User> 
	//这里面不用做任何操作


//具体实现方法中:
QueryWrapper<User> queryWrapper=new QueryWrapper<>();
queryWrapper.lambda().eq(User::getName,"zhangsan");
List<User> userList = UserDao.selectList(queryWrapper); //调用UserDao中的方法

3.2、插入

@Test
public void Insert() 
    User user = new User();
    user.setAge(23);
    user.setName("zhangsan");
    user.setEmail("[e-mail]");
    // insert into user(id,name,age,email) values (?,?,?,?)
    int count = userMapper.insert(user);
    System.out.println("受影响的行数"+count);
    // 1626576039783362562
    System.out.println("ID 自动获取: " + user.getId());

最终执行的结果，所获取的id为 1626576039783362562

这是因为MyBatis-Plus在实现插入数据时，会默认基于雪花算法的策略生成id

3.3、删除

3.3.1 by ID 删除

@Test
public void testDeleteById() 
    // 通过 id 删除用户信息
    // Delete from user where id = ?
    int count = userMapper.deleteById(1626576039783362562L);
    System.out.println("受影响的行数"+count);

3.3.2 by ID 批量删除记录

@Test
public void testDeleteBatchIds() 
    // 通过多个 id 批量删除
    // Delete from user where id in (?, ?, ?)
    List<Long> idLists = Arrays.asList(1L, 2L, 3L);
    int count = userMapper.deleteBatchIds(idLists);
    System.out.println("受影响的行数"+count);

3.3.3 by map 条件删除记录

@Test
public void testDeleteByMap()
    //根据map集合中所设置的条件删除记录
    //DELETE FROM user WHERE name = ? AND age = ?
    Map<String,Object> map = new HashMap<>();
    map.put("age",23);
    map.put("name","zhangsan");
    int count = userMapper.deleteByMap(map);
    System.out.println("受影响的行数"+count);

3.4、修改

@Test
public void testUpdateById()
    User user = new User();
    user.setId(4L);
    user.setAge(10);
    user.setEmail(null);
    int count = userMapper.updateById(user);
    System.out.println("受影响的行数"+count);

3.5、查询

3.5.1 根据id查询用户信息

@Test
public void testSelectById()
    //根据id查询用户信息
    //SELECT id,name,age,email FROM user WHERE id=?
    User user = userMapper.selectById(4L);
    System.out.println(user);

3.5.2 根据多个id查询多个用户信息

@Test
public void testSelectBatchIds()
    //根据多个id查询多个用户信息
    //SELECT id,name,age,email FROM user WHERE id IN ( ? , ? )
    List<Long> idList = Arrays.asList(4L, 5L);
    List<User> list = userMapper.selectBatchIds(idList);
    list.forEach(System.out::println);

3.5.3 通过map条件查询用户信息

@Test
public void testSelectByMap()
    //通过map条件查询用户信息
    //SELECT id,name,age,email FROM user WHERE name = ? AND age = ?
    Map<String, Object> map = new HashMap<>();
    map.put("age", 22);
    map.put("name", "admin");
    List<User> list = userMapper.selectByMap(map);
    list.forEach(System.out::println);

3.5.3 查询所有数据

@Test
public void testSelectList()
    //selectList()根据MP内置的条件构造器查询一个list集合，null表示没有条件，即查询所有
    userMapper.selectList(null).forEach(System.out::println);

通过观察BaseMapper中的方法，大多方法中都有Wrapper类型的形参，此为条件构造器，可针对于SQL语句设置不同的条件，若没有条件，则可以为该形参赋值null，即查询（删除/修改）所有数据

3.6、通用Service

说明:

• 通用 Service CRUD 封装IService (opens new window)接口，进一步封装 CRUD 采用 get 查询单行 remove 删除 list 查询集合 page 分页 前缀命名方式区分 Mapper 层避免混淆，
• 泛型 T 为任意实体对象
• 建议如果存在自定义通用 Service 方法的可能，请创建自己的 IBaseService 继承 Mybatis-Plus 提供的基类
• 对象 Wrapper 为 条件构造器

3.7、创建Service接口和实现类

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

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

3.8、测试查询记录数

@Autowired
private UserService userService;

@Test
public void testGetCount()
    System.out.println("总记录数：" + userService.count());

3.9、测试批量插入

@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("demo-0"+i);
        user.setAge(20 + i);
        users.add(user);
    
    //SQL:INSERT INTO t_user ( username, age ) VALUES ( ?, ? )
    userService.saveBatch(users);

4、常用注解

4.1、@TableName

经过以上的测试，在使用MyBatis-Plus实现基本的CRUD时，我们并没有指定要操作的表，

只是在 Mapper接口继承BaseMapper时，设置了泛型User，而操作的表为user表

由此得出结论，MyBatis-Plus在确定操作的表时，

由BaseMapper的泛型决定，即实体类型决 定，且默认操作的表名和实体类型的类名一致

4.1.1、Question

若实体类类型的类名和要操作的表的表名不一致，会出现什么问题？

我们将表user更名为t_user，测试查询功能

程序抛出异常，Table \'mybatis_plus.user\' doesn\'t exist，因为现在的表名为 t_user，而默认操作的表名和实体类型的类名一致，即user表

4.1.2、通过@TableName解决问题

在实体类类型上添加@TableName("t_user")，标识实体类对应的表，即可成功执行SQL语句

4.1.3、通过全局配置解决问题

在开发的过程中，我们经常遇到以上的问题，即实体类所对应的表都有固定的前缀，例如 t_ 或 tbl_

此时，可以使用 MP 提供的全局配置，为实体类所对应的表名设置默认的前缀，那么就 不需要在每个实体类上通过@TableName标识实体类对应的表

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

4.2、@Tabled

经过以上的测试，MyBatis-Plus在实现CRUD时，会默认将id作为主键列，并在插入数据时，默认基于雪花算法的策略生成id

以上是关于MyBatis-Plus （SpringBoot2 版） Learning Day01的主要内容，如果未能解决你的问题，请参考以下文章

springboot2.x+MyBatis-Plus+mysql5.7 动态拼接sql语句 分页查询 自定义sql 查询条件 分组 排序

springboot、mybatis-plus、Druid多数据源环境搭建

Mybatis-plus 实体类继承关系 插入默认值

尝试前后端分离博客项目

SpringBoot + MyBatis-plus + SpringSecurity + Thymeleaf 实现系统基础模块功能

SpringBoot2基于SpringBoot实现SSMP整合