1. MyBatis-Plus简介及特性

1.1. 简介

MyBatis-Plus(简称 MP)是一个 MyBatis的增强工具,在 MyBatis 的基础上只做增强不做改变,为 简化开发、提高效率而生。MyBatis-Plus提供了通用的mapper和service,可以在不编写任何SQL语句的情况下,快速的实现对单表的CRUD、批量、逻辑删除、分页等操作。本视频从MyBatis-Plus的特性及使用,到MyBatis-Plus所提供的优秀的插件,以及多数据源的配置都有详细的讲解。并对Idea中的快速开发插件MyBatisX也进行了功能的演示。本视频主要以MySQL数据库为案例,使用Idea作为IDE,使用Maven作为构建工具,使用Spring Boot为大家展示MyBatis-Plus的各个功能,所以学习本视频需要有MyBatis和Spring Boot的基础。

以下为课程的主要内容:

MyBatis-Plus学习笔记 - 图1

1.2. 特性

  • 无侵入:只做增强不做改变,引入它不会对现有工程产生影响,如丝般顺滑
  • 损耗小:启动即会自动注入基本 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.3. 支持数据库

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

  • MySQL,Oracle,DB2,H2,HSQL,SQLite,PostgreSQL,SQLServer,Phoenix,Gauss ,ClickHouse,Sybase,OceanBase,Firebird,Cubrid,Goldilocks,csiidb
  • 达梦数据库,虚谷数据库,人大金仓数据库,南大通用(华库)数据库,南大通用数据库,神通数据库,瀚高数据库

1.4. 框架结构

MyBatis-Plus学习笔记 - 图2

1.5. 代码及文档地址

官方地址: https://baomidou.com/

代码发布地址:

Github: https://github.com/baomidou/mybatis-plus

Gitee: https://gitee.com/baomidou/mybatis-plus

文档发布地址: https://baomidou.com/pages/24112f/

2. 入门案例

2.1. 开发环境

IDE:idea 2019.2

JDK:JDK8+

构建工具:maven 3.5.4

MySQL版本:MySQL 5.7

Spring Boot:2.6.3

MyBatis-Plus:3.5.1

2.2. 创建数据库及表

创建表结构:

  1. CREATE DATABASE `mybatis_plus` /*!40100 DEFAULT CHARACTER SET utf8mb4 */;
  2. use `mybatis_plus`;
  3. CREATE TABLE `user` (
  4. `id` bigint(20) NOT NULL COMMENT '主键ID',
  5. `name` varchar(30) DEFAULT NULL COMMENT '姓名',
  6. `age` int(11) DEFAULT NULL COMMENT '年龄',
  7. `email` varchar(50) DEFAULT NULL COMMENT '邮箱',
  8. PRIMARY KEY (`id`)
  9. ) 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');

2.3. 创建Spring Boot工程

2.3.1. 初始化工程

在初始化工程之前检查我们Idea中的Maven是否配置成功

选择configure —> Settings

MyBatis-Plus学习笔记 - 图3

选择好如下几个路径

MyBatis-Plus学习笔记 - 图4

点击Create NewProject

MyBatis-Plus学习笔记 - 图5

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

MyBatis-Plus学习笔记 - 图6

填写工程的基本信息

MyBatis-Plus学习笔记 - 图7

选择Spring Boot的版本为2.6.3,先不勾选任何的依赖,后面手动在pom.xml中添加即可,最后点击next

MyBatis-Plus学习笔记 - 图8

填写工程的信息,最后点击Finish

MyBatis-Plus学习笔记 - 图9

创建成功之后,可以选择删除如下的文件(这一步操作时可选的)

MyBatis-Plus学习笔记 - 图10

2.3.2. 引入依赖

<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>

    <!-- mybatis-plus启动器 -->
    <dependency>
        <groupId>com.baomidou</groupId>
        <artifactId>mybatis-plus-boot-starter</artifactId>
        <version>3.5.1</version>
    </dependency>

    <!-- lombok用于简化实体类的开发 -->
    <dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
        <optional>true</optional>
    </dependency>

    <!-- mysql驱动 -->
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <scope>runtime</scope>
    </dependency>
</dependencies>

2.3.3. idea中安装lombok插件

在settings —> plugins —> 搜索lombok —> 点击install

MyBatis-Plus学习笔记 - 图11

安装之后idea会提示你重启,重启之后就可以在实体类中使用lombok插件的功能了

2.4. 编写代码

2.4.1. 配置application.yml

spring:
  # 配置数据源信息
  datasource:
    # 配置数据源类型
    type: com.zaxxer.hikari.HikariDataSource
    # 配置连接数据库信息
    driver-class-name: com.mysql.cj.jdbc.Driver
    url: jdbc:mysql://localhost:3306/mybatis_plus?characterEncoding=utf-8&useSSL=false
    username: root
    password: 123456

注意:

  • 驱动类driver-class-name

    • 如果我们当前使用的mysql的驱动是5版本的,那么driver-class-name就填com.mysql.jdbc.Driver,如果我们当前使用的mysql的驱动是8版本的,那么driver-class-name就填com.mysql.cj.jdbc.Driver。

    • 怎么样才能知道我们使用的mysql的驱动是什么版本的呢?
      我们可以当前工程的pom.xml中查看我们引入的mysql的驱动的依赖的版本,但是通过查看pom.xml发现我们引入的mysql驱动的依赖是继承自Spring Boot父工程的,所以我们可以点击如下图所示的这个按钮查看Spring Boot父工程中使用的mysql驱动的依赖是什么版本
      MyBatis-Plus学习笔记 - 图12
      然后查看mysql.version属性的值就可以知道Spring Boot父工程中使用的mysql驱动的依赖的版本号了
      MyBatis-Plus学习笔记 - 图13
      Ctrl+F 搜索mysql.version,查看mysql驱动版本号
      MyBatis-Plus学习笔记 - 图14

    • spring boot 2.0内置的mysql的驱动都是5版本的,driver-class-name使用com.mysql.jdbc.Driver。spring boot2.1及以上内置的mysql的驱动都是8版本的,driver-class-name使用com.mysql.cj.jdbc.Driver。否则运行测试用例的时候会有 WARN 信息

  • 连接地址url
    url跟我们当前使用的mysql的驱动类版本没有关系,但是它却跟我们当前连接的mysql的版本有关系。

    • 如果你使用的是MySQL5.7版本,那么url填
      jdbc:mysql://localhost:3306/数据库名称?characterEncoding=utf-8&useSSL=false
      
  • 如果你使用的是MySQL8.0版本,那么url填
    jdbc:mysql://localhost:3306/数据库名称?serverTimezone=GMT%2B8&characterEncoding=utf-8&useSSL=false
    
  • 如果你填的url和使用的mysql版本不对应的话运行测试用例报告如下错误:
    java.sql.SQLException: The server time zone value 'Öйú±ê׼ʱ¼ä' is unrecognized or represents more
    

2.4.2. 添加实体类

在com.atguigu.mybatisplus.pojo包下面创建User.java

//lombok注解
@Data
public class User {

    private Long id;

    private String name;

    private Integer age;

    private String email;
}

@Data注解会为当前类添加get方法、set方法、equals()、hashcode()、toString()方法。

User类编译之后的结果:

MyBatis-Plus学习笔记 - 图15

2.4.3. 添加mapper

在com.atguigu.mybatisplus.mapper包下面创建UserMapper接口

public interface UserMapper extends BaseMapper<User> {
}

2.4.4. 启动类

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

@SpringBootApplication
//扫描mapper接口所在的包
@MapperScan("com.atguigu.mybatisplus.mapper")
public class MybatisplusApplication {

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

}

2.4.5. 测试

在src/test/java目录下的com.atguigu.mybatisplus包下面创建MyBatisPlusTest测试类

@SpringBootTest
public class MyBatisPlusTest {

    @Autowired
    private UserMapper userMapper;

    @Test
    public void testSelectList(){
        //通过条件构造器查询一个list集合,若没有条件,则可以设置null为参数
        List<User> list = userMapper.selectList(null);
        list.forEach(System.out::println);
    }

}

运行结果:

MyBatis-Plus学习笔记 - 图16

注意:

IDEA在 userMapper 处报错,说是找不到注入的对象,报错的原因是因为UserMapper接口的代理类是代码运行时动态创建的,但是程序可以正确的执行。如果想让IDEA不报错,可以在mapper接口上面添加@Repository注解。

2.4.6. 添加日志

在application.yml中配置日志输出

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

作了上面的配置之后,再次执行测试类中的方法,控制台中就会打印sql语句了

==>  Preparing: SELECT id,name,age,email FROM user
==> Parameters: 
<==    Columns: id, name, age, email
<==        Row: 1, Jone, 18, test1@baomidou.com
<==        Row: 2, Jack, 20, test2@baomidou.com
<==        Row: 3, Tom, 28, test3@baomidou.com
<==        Row: 4, Sandy, 21, test4@baomidou.com
<==        Row: 5, Billie, 24, test5@baomidou.com
<==      Total: 5
Closing non transactional SqlSession [org.apache.ibatis.session.defaults.DefaultSqlSession@7e00ed0f]
User(id=1, name=Jone, age=18, email=test1@baomidou.com)
User(id=2, name=Jack, age=20, email=test2@baomidou.com)
User(id=3, name=Tom, age=28, email=test3@baomidou.com)
User(id=4, name=Sandy, age=21, email=test4@baomidou.com)
User(id=5, name=Billie, age=24, email=test5@baomidou.com)

3. 基本CRUD

3.1. BaseMapper

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

package com.baomidou.mybatisplus.core.mapper;
public interface BaseMapper<T> extends Mapper<T> {

/**
 * 插入一条记录
 * @param entity 实体对象
 */
int insert(T entity);

/**
 * 根据 ID 删除
 * @param id 主键ID
 */
int deleteById(Serializable id);

/**
 * 根据实体(ID)删除
 * @param entity 实体对象
 * @since 3.4.4
 */
int deleteById(T entity);

/**
 * 根据 columnMap 条件,删除记录
 * @param columnMap 表字段 map 对象
 */
int deleteByMap(@Param(Constants.COLUMN_MAP) Map<String, Object> columnMap);

/**
 * 根据 entity 条件,删除记录
 * @param queryWrapper 实体对象封装操作类(可以为 null,里面的 entity 用于生成 where语句)
 */
int delete(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);

/**
 * 删除(根据ID 批量删除)
 * @param idList 主键ID列表(不能为 null 以及 empty)
 */
int deleteBatchIds(@Param(Constants.COLLECTION) Collection<? extends Serializable> idList);

/**
 * 根据 ID 修改
 * @param entity 实体对象
 */
int updateById(@Param(Constants.ENTITY) T entity);

/**
 * 根据 whereEntity 条件,更新记录
 * @param entity 实体对象 (set 条件值,可以为 null)
 * @param updateWrapper 实体对象封装操作类(可以为 null,里面的 entity 用于生成where 语句)
 */
int update(@Param(Constants.ENTITY) T entity, @Param(Constants.WRAPPER) Wrapper<T> updateWrapper);

/**
 * 根据 ID 查询
 * @param id 主键ID
 */
T selectById(Serializable id);

/**
 * 查询(根据ID 批量查询)
 * @param idList 主键ID列表(不能为 null 以及 empty)
 */
List<T> selectBatchIds(@Param(Constants.COLLECTION) Collection<? extends Serializable> idList);

/**
 * 查询(根据 columnMap 条件)
 * @param columnMap 表字段 map 对象
 */
List<T> selectByMap(@Param(Constants.COLUMN_MAP) Map<String, Object> columnMap);

/**
 * 根据 entity 条件,查询一条记录
 * <p>查询一条记录,例如 qw.last("limit 1") 限制取一条记录, 注意:多条数据会报异常</p>
 * @param queryWrapper 实体对象封装操作类(可以为 null)
 */
default T selectOne(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper) {
    List<T> ts = this.selectList(queryWrapper);
    if (CollectionUtils.isNotEmpty(ts)) {
        if (ts.size() != 1) {
            throw ExceptionUtils.mpe("One record is expected, but the query
            result is multiple records");
        }
        return ts.get(0);
    }
    return null;
}

/**
 * 根据 Wrapper 条件,查询总记录数
 * @param queryWrapper 实体对象封装操作类(可以为 null)
 */
Long selectCount(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);

/**
 * 根据 entity 条件,查询全部记录
 * @param queryWrapper 实体对象封装操作类(可以为 null)
 */
List<T> selectList(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);

/**
 * 根据 Wrapper 条件,查询全部记录
 * @param queryWrapper 实体对象封装操作类(可以为 null)
 */
List<Map<String, Object>> selectMaps(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);

/**
 * 根据 Wrapper 条件,查询全部记录
 * <p>注意: 只返回第一个字段的值</p>
 * @param queryWrapper 实体对象封装操作类(可以为 null)
 */
List<Object> selectObjs(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);

/**
 * 根据 entity 条件,查询全部记录(并翻页)
 * @param page 分页查询条件(可以为 RowBounds.DEFAULT)
 * @param queryWrapper 实体对象封装操作类(可以为 null)
 */
<P extends IPage<T>> P selectPage(P page, @Param(Constants.WRAPPER) Wrapper<T> queryWrapper);

/**
 * 根据 Wrapper 条件,查询全部记录(并翻页)
 * @param page 分页查询条件
 * @param queryWrapper 实体对象封装操作类
 */
<P extends IPage<Map<String, Object>>> P selectMapsPage(P page, @Param(Constants.WRAPPER) Wrapper<T> queryWrapper);

3.2. 插入

在src/test/java目录下的com.atguigu.mybatisplus包的MyBatisPlusTest类中添加如下的测试方法

@Test
public void testInsert(){
    //实现新增用户信息
    //INSERT INTO user ( id, name, age, email ) VALUES ( ?, ?, ?, ? )
    User user = new User();
    //user.setId(100L);
    user.setName("张三");
    user.setAge(23);
    user.setEmail("zhangsan@atguigu.com");
    int result = userMapper.insert(user);
    System.out.println("result:"+result);
    System.out.println("id:"+user.getId());
}

执行结果如下:

MyBatis-Plus学习笔记 - 图17

最终执行的结果,所获取的id为1492767055210991617

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

3.3. 删除

3.3.1. 通过id删除记录

在src/test/java目录下的com.atguigu.mybatisplus包的MyBatisPlusTest类中添加如下的测试方法

@Test
public void testDeleteById(){
    //通过id删除用户信息
    //DELETE FROM user WHERE id=?
    int result = userMapper.deleteById(1492767055210991617L);
    System.out.println("result:"+result);
}

执行结果如下:

MyBatis-Plus学习笔记 - 图18

3.3.2. 通过map条件删除记录

在src/test/java目录下的com.atguigu.mybatisplus包的MyBatisPlusTest类中添加如下的测试方法

@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", "张三");
    int result = userMapper.deleteByMap(map);
    System.out.println("result:"+result);
}

执行结果如下:

MyBatis-Plus学习笔记 - 图19

3.3.3. 通过id批量删除记录

在src/test/java目录下的com.atguigu.mybatisplus包的MyBatisPlusTest类中添加如下的测试方法

@Test
public void testDeleteBatchIds(){
    //通过多个id实现批量删除
    //DELETE FROM user WHERE id IN ( ? , ? , ? )
    List<Long> idList = Arrays.asList(1L, 2L, 3L);
    int result = userMapper.deleteBatchIds(idList);
    System.out.println("result:"+result);
}

执行结果如下:

MyBatis-Plus学习笔记 - 图20

3.4. 修改

3.4.1. 通过id修改记录

在src/test/java目录下的com.atguigu.mybatisplus包的MyBatisPlusTest类中添加如下的测试方法

@Test
public void testUpdateById(){
    User user = new User();
    user.setId(4L);
    user.setName("李四");
    user.setEmail("lisi@atguigu.com");
    //UPDATE user SET name=?, email=? WHERE id=?
    int result = userMapper.updateById(user);
    System.out.println("resutl:"+result);
}

执行结果如下:

MyBatis-Plus学习笔记 - 图21

3.5. 查询

3.5.1. 根据id查询用户信息

在src/test/java目录下的com.atguigu.mybatisplus包的MyBatisPlusTest类中添加如下的测试方法

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

执行结果如下:

==>  Preparing: SELECT id,name,age,email FROM user WHERE id=?
==> Parameters: 1(Long)
<==    Columns: id, name, age, email
<==        Row: 1, Jone, 18, test1@baomidou.com
<==      Total: 1
Closing non transactional SqlSession [org.apache.ibatis.session.defaults.DefaultSqlSession@62db0521]
User(id=1, name=Jone, age=18, email=test1@baomidou.com)

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

在src/test/java目录下的com.atguigu.mybatisplus包的MyBatisPlusTest类中添加如下的测试方法

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

执行结果如下:

==>  Preparing: SELECT id,name,age,email FROM user WHERE id IN ( ? , ? , ? )
==> Parameters: 1(Long), 2(Long), 3(Long)
<==    Columns: id, name, age, email
<==        Row: 1, Jone, 18, test1@baomidou.com
<==        Row: 2, Jack, 20, test2@baomidou.com
<==        Row: 3, Tom, 28, test3@baomidou.com
<==      Total: 3
Closing non transactional SqlSession [org.apache.ibatis.session.defaults.DefaultSqlSession@6d7cada5]
User(id=1, name=Jone, age=18, email=test1@baomidou.com)
User(id=2, name=Jack, age=20, email=test2@baomidou.com)
User(id=3, name=Tom, age=28, email=test3@baomidou.com)

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

在src/test/java目录下的com.atguigu.mybatisplus包的MyBatisPlusTest类中添加如下的测试方法

@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", 20);
    map.put("name", "jack");
    List<User> list = userMapper.selectByMap(map);
    list.forEach(System.out::println);
}

执行结果如下:

MyBatis-Plus学习笔记 - 图22

3.5.4. 查询所有数据

在src/test/java目录下的com.atguigu.mybatisplus包的MyBatisPlusTest类中添加如下的测试方法

@Test
public void testSelectList(){
    //查询所有用户信息
    //SELECT id,name,age,email FROM user
    List<User> list = userMapper.selectList(null);
    list.forEach(System.out::println);
}

执行结果如下:

==>  Preparing: SELECT id,name,age,email FROM user
==> Parameters: 
<==    Columns: id, name, age, email
<==        Row: 1, Jone, 18, test1@baomidou.com
<==        Row: 2, Jack, 20, test2@baomidou.com
<==        Row: 3, Tom, 28, test3@baomidou.com
<==        Row: 4, Sandy, 21, test4@baomidou.com
<==        Row: 5, Billie, 24, test5@baomidou.com
<==      Total: 5
Closing non transactional SqlSession [org.apache.ibatis.session.defaults.DefaultSqlSession@4d654825]
User(id=1, name=Jone, age=18, email=test1@baomidou.com)
User(id=2, name=Jack, age=20, email=test2@baomidou.com)
User(id=3, name=Tom, age=28, email=test3@baomidou.com)
User(id=4, name=Sandy, age=21, email=test4@baomidou.com)
User(id=5, name=Billie, age=24, email=test5@baomidou.com)

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

3.6. 自定义mapper接口的方法

当BaseMapper中的方法无法满足我们的需求时,我们可以自定义方法,

mybatis-plus中默认配置了mapper配置文件的存放位置:

# 下面这行配置是mybatis-plus的默认配置,我们可以不写,如果我们没有写,默认mapper配置文件的存放位置就是在src/main/resources/mapper/目录下面
mybatis-plus:
  mapper-locations: classpath*:/mapper/**/*.xml

演示:

在src/main/resources/目录下创建mapper目录,在mapper目录下创建UserMapper.xml

<?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.atguigu.mybatisplus.mapper.UserMapper">

    <!--Map<String, Object> selectMapById(Long id);-->
    <select id="selectMapById" resultType="map">
        select id,name,age,email from user where id = #{id}
    </select>

</mapper>

在UserMapper接口中添加对应的方法

/**
 * 根据id查询用户信息为map集合
 * @param id
 * @return
 */
Map<String, Object> selectMapById(Long id);

在src/test/java目录下的com.atguigu.mybatisplus包的MyBatisPlusTest类中添加如下的测试方法

@Test
public void testSelectMapById(){
    Map<String, Object> map = userMapper.selectMapById(1L);
    System.out.println(map);
}

执行结果如下:

MyBatis-Plus学习笔记 - 图23

3.7. 通用Service

说明:

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

3.7.1. IService

MyBatis-Plus中有一个接口 IService和其实现类 ServiceImpl,封装了常见的业务层逻辑

详情查看源码IServiceServiceImpl

3.7.2. 创建Service接口和实现类

在com.atguigu.mybatisplus.service包下面创建UserService接口,让UserService接口去继承IService接口

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

}

在com.atguigu.mybatisplus.service.impl包下面创建UserServiceImpl类去实现UserService接口,然后继承ServiceImpl类

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

}

3.7.3. 测试查询记录数

在src/test/java目录的com.atguigu.mybatisplus包中创建MyBatisPlusServiceTest测试类

@SpringBootTest
public class MyBatisPlusServiceTest {

    @Autowired
    private UserService userService;

    @Test
    public void testGetCount(){
        //查询总记录数
        //SELECT COUNT( * ) FROM user
        long count = userService.count();
        System.out.println("总记录数:"+count);
    }

}

执行结果如下:

==>  Preparing: SELECT COUNT( * ) FROM user
==> Parameters: 
<==    Columns: COUNT( * )
<==        Row: 5
<==      Total: 1
Closing non transactional SqlSession [org.apache.ibatis.session.defaults.DefaultSqlSession@3901f6af]
总记录数:5

3.7.4. 测试批量插入

在src/test/java目录的com.atguigu.mybatisplus包中的MyBatisPlusServiceTest类中添加如下的测试方法

@Test
public void testInsertMore(){
    // SQL长度有限制,海量数据插入单条SQL无法执行,
    // 因此MP将批量插入放在了通用Service中实现,而不是通用Mapper
    //批量添加
    //INSERT INTO user ( id, name, age ) VALUES ( ?, ?, ? )
    List<User> list = new ArrayList<>();
    for (int i = 1; i <= 10; i++) {
        User user = new User();
        user.setName("ybc"+i);
        user.setAge(20+i);
        list.add(user);
    }
    boolean b = userService.saveBatch(list);
    System.out.println(b);
}

执行结果如下:

==>  Preparing: INSERT INTO user ( id, name, age ) VALUES ( ?, ?, ? )
==> Parameters: 1514256119395037186(Long), ybc0(String), 20(Integer)
==> Parameters: 1514256119499894785(Long), ybc1(String), 21(Integer)
==> Parameters: 1514256119499894786(Long), ybc2(String), 22(Integer)
==> Parameters: 1514256119499894787(Long), ybc3(String), 23(Integer)
==> Parameters: 1514256119499894788(Long), ybc4(String), 24(Integer)
==> Parameters: 1514256119499894789(Long), ybc5(String), 25(Integer)
==> Parameters: 1514256119499894790(Long), ybc6(String), 26(Integer)
==> Parameters: 1514256119499894791(Long), ybc7(String), 27(Integer)
==> Parameters: 1514256119499894792(Long), ybc8(String), 28(Integer)
==> Parameters: 1514256119499894793(Long), ybc9(String), 29(Integer)
true

从控制台打印的sql语句可以发现MyBatisPlus的通用Service的批量插入方法saveBatch其实是循环执行insert语句从而达到批量添加的功能。不是执行一条insert语句,而是执行多条insert语句

4. 常用注解

4.1. @TableName

经过以上的测试,在使用MyBatis-Plus实现基本的CRUD时,我们并没有指定要操作的表,只是在 Mapper接口继承BaseMapper时,设置了泛型User,而操作的表为user表

由此得出结论,MyBatis-Plus在确定操作的表时,由BaseMapper的泛型决定,即实体类型决定,且默认操作的表名和实体类型的类名一致

4.1.1. 提出问题

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

我们将表user更名为t_user,测试添加功能

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

MyBatis-Plus学习笔记 - 图24

4.1.2. 通过@TableName解决问题

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

MyBatis-Plus学习笔记 - 图25

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

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

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

在application.yml配置文件中作如下的配置

mybatis-plus:
  # 设置MyBatis-Plus的全局配置
  global-config:
    db-config:
      # 设置实体类所对应的表的统一前缀
      table-prefix: t_

此时就算把User类上面的@TableName注解注释掉仍然可以正常执行SQL语句

4.2. @TableId

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

4.2.1. 提出问题

若实体类和表中表示主键的不是id,而是其他字段,例如uid,MyBatis-Plus会自动识别uid为主键列吗?

我们将实体类中的属性id改为uid,将表中的字段id也改为uid,测试添加功能

程序抛出异常,Field ‘uid’ doesn’t have a default value,以及日志中的sql语句可以说明MyBatis-Plus没有将uid作为主键进行赋值

MyBatis-Plus学习笔记 - 图26

4.2.2. 通过@TableId解决问题

在实体类中uid属性上通过@TableId将其标识为主键,即可成功执行SQL语句

MyBatis-Plus学习笔记 - 图27

4.2.3. @TableId注解的value属性

若实体类中主键对应的属性为id,而表中表示主键的字段为uid,此时若只在属性id上添加注解 @TableId,则抛出异常Unknown column ‘id’ in ‘field list’,即MyBatis-Plus仍然会将id作为表的主键操作,而表中表示主键的是字段uid

MyBatis-Plus学习笔记 - 图28

在我们当前的字段列表中没有id这个字段,当我们操作id属性的时候,mybatis-plus会认为它所对应数据库中的字段也是id,但是我们的数据库表中如果没有id这个字段,就会报上面这个错。

此时需要通过@TableId注解的value属性,指定表中的主键字段,@TableId(“uid”) 或 @TableId(value=”uid”)就可以解决这个问题

MyBatis-Plus学习笔记 - 图29

当实体类中属性名和数据库表中的主键字段名称不一致的时候,就需要用到@TableId主键的value属性来指定主键的字段名称。

4.2.4. @TableId注解的type属性

type属性用来定义主键策略

常用的主键策略:

描述
IdType.ASSIGN_ID(默 认) 基于雪花算法的策略生成数据id,与数据库id是否设置自增无关
IdType.AUTO 使用数据库的自增策略,注意,该类型请确保数据库设置了id自增, 否则无效

配置全局主键策略:

mybatis-plus:
  # 设置MyBatis-Plus的全局配置
  global-config:
    db-config:
      # 设置统一的主键生成策略
      id-type: auto

id-type属性的值可以设置的值有auto、assign_id、assign_uuid、input、none

MyBatis-Plus学习笔记 - 图30

4.2.5. 雪花算法

a> 背景

需要选择合适的方案去应对数据规模的增长,以应对逐渐增长的访问压力和数据量。

数据库的扩展方式主要包括:业务分库、主从复制,数据库分表。

b> 数据库分表

将不同业务数据分散存储到不同的数据库服务器,能够支撑百万甚至千万用户规模的业务,但如果业务 继续发展,同一业务的单表数据也会达到单台数据库服务器的处理瓶颈。例如,淘宝的几亿用户数据, 如果全部存放在一台数据库服务器的一张表中,肯定是无法满足性能要求的,此时就需要对单表数据进行拆分。

单表数据拆分有两种方式:垂直分表和水平分表。示意图如下:

MyBatis-Plus学习笔记 - 图31

c> 垂直分表

垂直分表适合将表中某些不常用且占了大量空间的列拆分出去。

例如,前面示意图中的 nickname 和 description 字段,假设我们是一个婚恋网站,用户在筛选其他用户的时候,主要是用 age 和 sex 两个字段进行查询,而 nickname 和 description 两个字段主要用展示,一般不会在业务查询中用到。description 本身又比较长,因此我们可以将这两个字段独立到另外一张表中,这样在查询 age 和 sex 时,就能带来一定的性能提升。

d> 水平分表

水平分表适合表行数特别大的表,有的公司要求单表行数超过 5000 万就必须进行分表,这个数字可以作为参考,但并不是绝对标准,关键还是要看表的访问性能。对于一些比较复杂的表,可能超过 1000 万就要分表了;而对于一些简单的表,即使存储数据超过 1 亿行,也可以不分表。

但不管怎样,当看到表的数据量达到千万级别时,作为架构师就要警觉起来,因为这很可能是架构的性能瓶颈或者隐患。

水平分表相比垂直分表,会引入更多的复杂性,例如要求全局唯一的数据id该如何处理

主键自增

①以最常见的用户 ID 为例,可以按照 1000000 的范围大小进行分段,1 ~ 999999 放到表 1中, 1000000 ~ 1999999 放到表2中,以此类推。

②复杂点:分段大小的选取。分段太小会导致切分后子表数量过多,增加维护复杂度;分段太大可能会导致单表依然存在性能问题,一般建议分段大小在 100 万至 2000 万之间,具体需要根据业务选取合适的分段大小。

③优点:可以随着数据的增加平滑地扩充新的表。例如,现在的用户是 100 万,如果增加到 1000 万, 只需要增加新的表就可以了,原有的数据不需要动。

④缺点:分布不均匀。假如按照 1000 万来进行分表,有可能某个分段实际存储的数据量只有 1 条,而 另外一个分段实际存储的数据量有 1000 万条。

取模

①同样以用户 ID 为例,假如我们一开始就规划了 10 个数据库表,可以简单地用 user_id % 10 的值来 表示数据所属的数据库表编号,ID 为 985 的用户放到编号为 5 的子表中,ID 为 10086 的用户放到编号 为 6 的子表中。

②复杂点:初始表数量的确定。表数量太多维护比较麻烦,表数量太少又可能导致单表性能存在问题。

③优点:表分布比较均匀。

④缺点:扩充新的表很麻烦,所有数据都要重分布。

雪花算法

雪花算法是由Twitter公布的分布式主键生成算法,它能够保证不同表的主键的不重复性,以及相同表的主键的有序性。

①核心思想:

长度共64bit(一个long型)。

首先是一个符号位,1bit标识,由于long基本类型在Java中是带符号的,最高位是符号位,正数是0,负 数是1,所以id一般是正数,最高位是0。

41bit时间截(毫秒级),存储的是时间截的差值(当前时间截 - 开始时间截),结果约等于69.73年。

10bit作为机器的ID(5个bit是数据中心,5个bit的机器ID,可以部署在1024个节点)。

12bit作为毫秒内的流水号(意味着每个节点在每毫秒可以产生 4096 个 ID)。

MyBatis-Plus学习笔记 - 图32

②优点:整体上按照时间自增排序,并且整个分布式系统内不会产生ID碰撞,并且效率较高。

4.3. @TableField

经过以上的测试,我们可以发现,MyBatis-Plus在执行SQL语句时,要保证实体类中的属性名和表中的字段名一致

如果实体类中的属性名和字段名不一致的情况,会出现什么问题呢?

4.3.1. 情况1:

若实体类中的属性使用的是驼峰命名风格,而表中的字段使用的是下划线命名风格

例如实体类属性userName,表中字段user_name

此时MyBatis-Plus会自动将下划线命名风格转化为驼峰命名风格

mybatis-plus:
  # 开启下划线转驼峰(默认配置是true)
  map-underscore-to-camel-case: true

4.3.2. 情况2:

若实体类中的属性和表中的字段不满足情况1

例如实体类属性name,表中字段user_name

此时需要在实体类属性上使用@TableField(“user_name”)设置属性所对应的字段名

MyBatis-Plus学习笔记 - 图33

4.4. @TableLogic

4.4.1. 逻辑删除

物理删除:真实删除,将对应数据从数据库中删除,之后查询不到此条被删除的数据

逻辑删除:假删除,将对应数据中代表是否被删除字段的状态修改为“被删除状态”,之后在数据库 中仍旧能看到此条数据记录

使用场景:可以进行数据恢复

4.4.2. 实现逻辑删除

步骤1:数据库中创建逻辑删除状态列,设置默认值为0

MyBatis-Plus学习笔记 - 图34

步骤2:实体类中添加逻辑删除属性,然后在这个属性上添加@TableLogic注解

MyBatis-Plus学习笔记 - 图35

步骤3:测试

测试删除功能,真正执行的是修改

例如:执行MyBatisPlusTest类的testDeleteBatchIds方法,执行结果如下:

MyBatis-Plus学习笔记 - 图36

测试查询功能,被逻辑删除的数据默认不会被查询

例如:执行MyBatisPlusTest类的testSelectList方法,执行结果如下:

MyBatis-Plus学习笔记 - 图37

5. 条件构造器和常用接口

5.1. wrapper介绍

MyBatis-Plus学习笔记 - 图38

  • Wrapper : 条件构造抽象类,最顶端父类

    • AbstractWrapper : 用于查询条件封装,生成 sql 的 where 条件

      • QueryWrapper : 查询条件封装
      • UpdateWrapper : Update 条件封装
      • AbstractLambdaWrapper : 使用Lambda 语法

        • LambdaQueryWrapper :用于Lambda语法使用的查询Wrapper
        • LambdaUpdateWrapper : Lambda 更新封装Wrapper

5.2. QueryWrapper

QueryWrapper主要用于查询和删除中,修改功能也可以使用QueryWrapper来完成。

5.2.1. 组装查询条件

在src/test/java目录下的com.atguigu.mybatisplus包创建MyBatisPlusWrapperTest类

@SpringBootTest
public class MyBatisPlusWrapperTest {

    @Autowired
    private UserMapper userMapper;

    @Test
    public void test01(){
        //查询用户名包含a,年龄在20到30之间,邮箱信息不为null的用户信息
        //SELECT uid AS id,user_name AS name,age,email,is_deleted FROM t_user WHERE is_deleted=0 AND (user_name LIKE ? AND age BETWEEN ? AND ? AND email IS NOT NULL)
        QueryWrapper<User> queryWrapper = new QueryWrapper<>();
        queryWrapper.like("user_name", "a")
                .between("age", 20, 30)
                .isNotNull("email");
        List<User> list = userMapper.selectList(queryWrapper);
        list.forEach(System.out::println);
    }

}

执行结果如下:

MyBatis-Plus学习笔记 - 图39

5.2.2. 组装排序条件

在src/test/java目录下的com.atguigu.mybatisplus包的MyBatisPlusWrapperTest测试类中添加如下方法

@Test
public void test02(){
    //查询用户信息,按照年龄的降序排序,若年龄相同,则按照id升序排序
    //SELECT uid AS id,user_name AS name,age,email,is_deleted FROM t_user WHERE is_deleted=0 ORDER BY age DESC,uid ASC
    QueryWrapper<User> queryWrapper = new QueryWrapper<>();
    queryWrapper.orderByDesc("age")
        .orderByAsc("uid");
    List<User> list = userMapper.selectList(queryWrapper);
    list.forEach(System.out::println);
}

执行结果如下:

==>  Preparing: SELECT uid AS id,user_name AS name,age,email,is_deleted FROM t_user WHERE is_deleted=0 ORDER BY age DESC,uid ASC
==> Parameters: 
<==    Columns: id, name, age, email, is_deleted
<==        Row: 1514256119499894793, ybc9, 29, null, 0
<==        Row: 1514256119499894792, ybc8, 28, null, 0
<==        Row: 1514256119499894791, ybc7, 27, null, 0
<==        Row: 1514256119499894790, ybc6, 26, null, 0
<==        Row: 1514256119499894789, ybc5, 25, null, 0
<==        Row: 5, Billie, 24, test5@baomidou.com, 0
<==        Row: 1514256119499894788, ybc4, 24, null, 0
<==        Row: 1514256119499894787, ybc3, 23, null, 0
<==        Row: 1514260843288600578, 张三, 23, zhangsan@atguigu.com, 0
<==        Row: 1514261985414475778, 张三, 23, zhangsan@atguigu.com, 0
<==        Row: 1514261985414475779, 张三, 23, zhangsan@atguigu.com, 0
<==        Row: 1514261985414475790, 张三, 23, zhangsan@atguigu.com, 0
<==        Row: 1514256119499894786, ybc2, 22, null, 0
<==        Row: 4, Sandy, 21, test4@baomidou.com, 0
<==        Row: 1514256119499894785, ybc1, 21, null, 0
<==        Row: 1514256119395037186, ybc0, 20, null, 0
<==      Total: 16
Closing non transactional SqlSession [org.apache.ibatis.session.defaults.DefaultSqlSession@53a9fcfd]
User(id=1514256119499894793, name=ybc9, age=29, email=null, isDeleted=0)
User(id=1514256119499894792, name=ybc8, age=28, email=null, isDeleted=0)
User(id=1514256119499894791, name=ybc7, age=27, email=null, isDeleted=0)
User(id=1514256119499894790, name=ybc6, age=26, email=null, isDeleted=0)
User(id=1514256119499894789, name=ybc5, age=25, email=null, isDeleted=0)
User(id=5, name=Billie, age=24, email=test5@baomidou.com, isDeleted=0)
User(id=1514256119499894788, name=ybc4, age=24, email=null, isDeleted=0)
User(id=1514256119499894787, name=ybc3, age=23, email=null, isDeleted=0)
User(id=1514260843288600578, name=张三, age=23, email=zhangsan@atguigu.com, isDeleted=0)
User(id=1514261985414475778, name=张三, age=23, email=zhangsan@atguigu.com, isDeleted=0)
User(id=1514261985414475779, name=张三, age=23, email=zhangsan@atguigu.com, isDeleted=0)
User(id=1514261985414475790, name=张三, age=23, email=zhangsan@atguigu.com, isDeleted=0)
User(id=1514256119499894786, name=ybc2, age=22, email=null, isDeleted=0)
User(id=4, name=Sandy, age=21, email=test4@baomidou.com, isDeleted=0)
User(id=1514256119499894785, name=ybc1, age=21, email=null, isDeleted=0)
User(id=1514256119395037186, name=ybc0, age=20, email=null, isDeleted=0)

5.2.3. 组装删除条件

在src/test/java目录下的com.atguigu.mybatisplus包的MyBatisPlusWrapperTest测试类中添加如下方法

@Test
public void test03(){
    //删除邮箱地址为null的用户信息
    //UPDATE t_user SET is_deleted=1 WHERE is_deleted=0 AND (email IS NULL)
    QueryWrapper<User> queryWrapper = new QueryWrapper<>();
    queryWrapper.isNull("email");
    int result = userMapper.delete(queryWrapper);
    System.out.println("result:"+result);
}

执行结果如下:

MyBatis-Plus学习笔记 - 图40

5.2.4. 使用QueryWrapper实现修改功能

实现修改功能有两种方法:一个是QueryWrapper,另一个是UpdateWrapper

  • update(T entity, Wrapper queryWrapper):第一个参数设置修改的内容,第二个参数QueryWrapper对象来设置修改的条件。
  • update(null, Wrapper updateWrapper):第一个参数可以设置为null,第二个参数UpdateWrapper对象既可以设置修改的条件,也可以设置修改的内容。

这里先演示QueryWrapper的方式来实现修改功能,UpdateWrapper的方式后面再演示

在src/test/java目录下的com.atguigu.mybatisplus包的MyBatisPlusWrapperTest测试类中添加如下方法

@Test
public void test04(){
    //将(年龄大于20并且用户名中包含有a)或邮箱为null的用户信息修改
    //UPDATE t_user SET user_name=?, email=? WHERE is_deleted=0 AND (age > ? AND user_name LIKE ? OR email IS NULL)
    QueryWrapper<User> queryWrapper = new QueryWrapper<>();
    queryWrapper.gt("age", 20)
        .like("user_name", "a")
        .or()
        .isNull("email");
    User user = new User();
    user.setName("小明");
    user.setEmail("test@atguigu.com");
    int result = userMapper.update(user, queryWrapper);
    System.out.println("result:"+result);
}

执行结果如下:

MyBatis-Plus学习笔记 - 图41

通过上面执行的SQL可以发现只有对象中那些属性值不为null的才会被修改。例如我们这里只是设置了User对象的name属性和email属性,所以SQL语句中只修改了这两个字段的值。

5.2.5. 条件的优先级

在src/test/java目录下的com.atguigu.mybatisplus包的MyBatisPlusWrapperTest测试类中添加如下方法

@Test
public void test05(){
    //将用户名中包含有a并且(年龄大于20或邮箱为null)的用户信息修改
    //lambda中的条件优先执行
    //UPDATE t_user SET user_name=?, email=? WHERE is_deleted=0 AND (user_name LIKE ? AND (age > ? OR email IS NULL))
    QueryWrapper<User> queryWrapper = new QueryWrapper<>();
    queryWrapper.like("user_name", "a")
        //and(Consumer<QueryWrapper<User>> consumer)是一个消费类型的函数式接口,这个i就是QueryWrapper条件构造器
        .and(i->i.gt("age",20).or().isNull("email"));
    User user = new User();
    user.setName("小红");
    user.setEmail("test@atguigu.com");
    int result = userMapper.update(user, queryWrapper);
    System.out.println("result:"+result);
}

执行结果如下:

MyBatis-Plus学习笔记 - 图42

补充:

QueryWrapper.and(xxx)方法的参数是Consumer<QueryWrapper<User>>Consumer<QueryWrapper<User>> 是一个函数式接口类型的参数,并且它是一个消费类型的函数式接口,这个接口的的泛型参数是一个QueryWrapper条件构造器,如下图所示

MyBatis-Plus学习笔记 - 图43

5.2.6. 组装select子句

在src/test/java目录下的com.atguigu.mybatisplus包的MyBatisPlusWrapperTest测试类中添加如下方法

@Test
public void test06(){
    //查询用户的用户名、年龄、邮箱信息
    //SELECT user_name,age,email FROM t_user WHERE is_deleted=0
    QueryWrapper<User> queryWrapper = new QueryWrapper<>();
    queryWrapper.select("user_name", "age", "email");
    List<Map<String, Object>> maps = userMapper.selectMaps(queryWrapper);
    maps.forEach(System.out::println);
}

执行结果如下:

==>  Preparing: SELECT user_name,age,email FROM t_user WHERE is_deleted=0
==> Parameters: 
<==    Columns: user_name, age, email
<==        Row: 小明, 21, test@atguigu.com
<==        Row: Billie, 24, test5@baomidou.com
<==        Row: 张三, 23, zhangsan@atguigu.com
<==        Row: 张三, 23, zhangsan@atguigu.com
<==        Row: 张三, 23, zhangsan@atguigu.com
<==        Row: 张三, 23, zhangsan@atguigu.com
<==      Total: 6
Closing non transactional SqlSession [org.apache.ibatis.session.defaults.DefaultSqlSession@47af099e]
User(id=null, name=null, age=21, email=test@atguigu.com, isDeleted=null)
User(id=null, name=null, age=24, email=test5@baomidou.com, isDeleted=null)
User(id=null, name=null, age=23, email=zhangsan@atguigu.com, isDeleted=null)
User(id=null, name=null, age=23, email=zhangsan@atguigu.com, isDeleted=null)
User(id=null, name=null, age=23, email=zhangsan@atguigu.com, isDeleted=null)
User(id=null, name=null, age=23, email=zhangsan@atguigu.com, isDeleted=null)

5.2.7. 实现子查询

在src/test/java目录下的com.atguigu.mybatisplus包的MyBatisPlusWrapperTest测试类中添加如下方法

@Test
public void test07(){
    //查询id小于等于100的用户信息
    //SELECT uid AS id,user_name AS name,age,email,is_deleted FROM t_user WHERE is_deleted=0 AND (uid IN (select uid from t_user where uid <= 100))
    QueryWrapper<User> queryWrapper = new QueryWrapper<>();
    queryWrapper.inSql("uid", "select uid from t_user where uid <= 100");
    List<User> list = userMapper.selectList(queryWrapper);
    list.forEach(System.out::println);
}

执行结果如下:

==>  Preparing: SELECT uid AS id,user_name AS name,age,email,is_deleted FROM t_user WHERE is_deleted=0 AND (uid IN (select uid from t_user where uid < 100))
==> Parameters: 
<==    Columns: id, name, age, email, is_deleted
<==        Row: 4, 小明, 21, test@atguigu.com, 0
<==        Row: 5, Billie, 24, test5@baomidou.com, 0
<==      Total: 2
Closing non transactional SqlSession [org.apache.ibatis.session.defaults.DefaultSqlSession@150ede8b]
User(id=4, name=小明, age=21, email=test@atguigu.com, isDeleted=0)
User(id=5, name=Billie, age=24, email=test5@baomidou.com, isDeleted=0)

5.3. UpdateWrapper

在src/test/java目录下的com.atguigu.mybatisplus包的MyBatisPlusWrapperTest测试类中添加如下方法

@Test
public void test08(){
    //将用户名中包含有a并且(年龄大于20或邮箱为null)的用户信息修改
    UpdateWrapper<User> updateWrapper = new UpdateWrapper<>();
    //这里的i是UpdateWrapper条件构造器,因为and(Consumer<UpdateWrapper<User>> consumer)
    updateWrapper.like("user_name", "a")
        //这里的i就是条件构造器UpdateWrapper
        .and(i -> i.gt("age", 20).or().isNull("email"));
    updateWrapper.set("user_name", "小黑").set("email","abc@atguigu.com");
    int result = userMapper.update(null, updateWrapper);
    System.out.println("result:"+result);
}

执行结果如下:

MyBatis-Plus学习笔记 - 图44

补充:

UpdateWrapper.and(xxx)方法的参数是Consumer<UpdateWrapper<User>>Consumer<UpdateWrapper<User>> 是一个函数式接口类型的参数,并且它是一个消费类型的函数式接口,这个接口的的泛型参数是一个UpdateWrapper条件构造器,如下图所示

MyBatis-Plus学习笔记 - 图45

5.4. condition

在真正开发的过程中,组装条件是常见的功能,而这些条件数据来源于用户输入,是可选的,因此我们在组装这些条件时,必须先判断用户是否选择了这些条件,若选择则需要组装该条件,若没有选择则一定不能组装,以免影响SQL执行的结果

5.4.1. 思路一

在src/test/java目录下的com.atguigu.mybatisplus包的MyBatisPlusWrapperTest测试类中添加如下方法

@Test
public void test09(){
    //SELECT uid AS id,user_name AS name,age,email,is_deleted FROM t_user WHERE is_deleted=0 AND (user_name LIKE ? AND age <= ?)
    String username = "a";
    Integer ageBegin = null;
    Integer ageEnd = 30;
    QueryWrapper<User> queryWrapper = new QueryWrapper<>();
    //StringUtils选择com.baomidou.mybatisplus.core.toolkit包下的
    if(StringUtils.isNotBlank(username)){
        //isNotBlank判断某个字符创是否不为空字符串、不为null、不为空白符
        queryWrapper.like("user_name", username);
    }
    if(ageBegin != null){
        queryWrapper.ge("age", ageBegin);
    }
    if(ageEnd != null){
        queryWrapper.le("age", ageEnd);
    }
    List<User> list = userMapper.selectList(queryWrapper);
    list.forEach(System.out::println);
}

注意:StringUtils工具类选择com.baomidou.mybatisplus.core.toolkit包下的

执行结果如下:

MyBatis-Plus学习笔记 - 图46

5.4.2. 思路二

在src/test/java目录下的com.atguigu.mybatisplus包的MyBatisPlusWrapperTest测试类中添加如下方法

@Test
public void test10(){
    String username = "a";
    Integer ageBegin = null;
    Integer ageEnd = 30;
    QueryWrapper<User> queryWrapper = new QueryWrapper<>();
    queryWrapper.like(StringUtils.isNotBlank(username), "user_name", username)
        .ge(ageBegin != null, "age", ageBegin)
        .le(ageEnd != null, "age", ageEnd);
    List<User> list = userMapper.selectList(queryWrapper);
    list.forEach(System.out::println);
}

执行结果的SQL语句和思路一的一致

MyBatis-Plus学习笔记 - 图47

5.5. LambdaQueryWrapper

在src/test/java目录下的com.atguigu.mybatisplus包的MyBatisPlusWrapperTest测试类中添加如下方法

@Test
public void test11(){
    //SELECT uid AS id,user_name AS name,age,email,is_deleted FROM t_user WHERE is_deleted=0 AND (user_name LIKE ? AND age <= ?)
    String username = "a";
    Integer ageBegin = null;
    Integer ageEnd = 30;
    LambdaQueryWrapper<User> queryWrapper = new LambdaQueryWrapper<>();
    queryWrapper.like(StringUtils.isNotBlank(username), User::getName, username)
        .ge(ageBegin != null, User::getAge, ageBegin)
        .le(ageEnd != null, User::getAge, ageEnd);
    List<User> list = userMapper.selectList(queryWrapper);
    list.forEach(System.out::println);
}

通过函数式接口的方法引用的方式来获取字段名可以避免字段名输入错误

执行结果如下:

==>  Preparing: SELECT uid AS id,user_name AS name,age,email,is_deleted FROM t_user WHERE is_deleted=0 AND (user_name LIKE ? AND age <= ?)
==> Parameters: %a%(String), 30(Integer)
<==      Total: 0

补充:

LambdaQueryWrapper的方法中都是通过函数式接口SFunction来获取字段名的,这里的SFunction是一个函数型的接口,所以上面的代码可以通过方法引用来获取字段名,例如:User::getName

MyBatis-Plus学习笔记 - 图48

函数型接口 Function R apply(T t):对类型为T的对象应用操作,并返回结果。结果是R类型的对象。包含方法:R apply(T t)

5.6. LambdaUpdateWrapper

在src/test/java目录下的com.atguigu.mybatisplus包的MyBatisPlusWrapperTest测试类中添加如下方法

@Test
public void test12(){
    //将用户名中包含有a并且(年龄大于20或邮箱为null)的用户信息修改
    LambdaUpdateWrapper<User> updateWrapper = new LambdaUpdateWrapper<>();
    updateWrapper.like(User::getName, "a")
        //这里的i就是LambdaUpdateWrapper条件构造器
        .and(i -> i.gt(User::getAge, 20).or().isNull(User::getEmail));
    updateWrapper.set(User::getName, "小黑").set(User::getEmail,"abc@atguigu.com");
    int result = userMapper.update(null, updateWrapper);
    System.out.println("result:"+result);
}

通过函数式接口的方法引用的方式来获取字段名可以避免字段名输入错误

执行结果如下:

MyBatis-Plus学习笔记 - 图49

补充:

LambdaUpdateWrapper的方法中都是通过函数式接口SFunction来获取字段名的,这里的SFunction是一个函数型的接口,所以上面的代码可以通过方法引用来获取字段名,例如:User::getName

MyBatis-Plus学习笔记 - 图50

LambdaUpdateWrapper.and(xxx)方法的参数是Consumer<LambdaUpdateWrapper<User>>Consumer<LambdaUpdateWrapper<User>> 是一个函数式接口类型的参数,并且它是一个消费类型的函数式接口,这个接口的的泛型参数是一个LambdaUpdateWrapper条件构造器,如下图所示

MyBatis-Plus学习笔记 - 图51

6. 插件

6.1. 分页插件

MyBatis Plus自带分页插件,只要简单的配置即可实现分页功能

6.1.1. 添加配置类

在com.atguigu.mybatisplus.config包下面创建一个配置类

@Configuration
//扫描mapper接口所在的包
@MapperScan("com.atguigu.mybatisplus.mapper")
public class MyBatisPlusConfig {

    @Bean
    public MybatisPlusInterceptor mybatisPlusInterceptor(){
        MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
        //添加分页插件
        interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL));
        return interceptor;
    }

}

6.1.2. 测试

在src/test/java/目录的com.atguigu.mybatisplus包下面创建测试类MyBatisPlusPluginsTest

@SpringBootTest
public class MyBatisPlusPluginsTest {

    @Autowired
    private UserMapper userMapper;
    @Autowired
    private ProductMapper productMapper;

    @Test
    public void testPage(){
        //要导入com.baomidou.mybatisplus.extension.plugins.pagination.Page
        //设置分页参数
        Page<User> page = new Page<>(2, 3);
        //查询数据
        userMapper.selectPage(page,null);
        //获取分页数据
        List<User> userList = page.getRecords();
        userList.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());
    }

}

执行结果如下:

==>  Preparing: SELECT COUNT(*) AS total FROM t_user WHERE is_deleted = 0
==> Parameters: 
<==    Columns: total
<==        Row: 6
<==      Total: 1
==>  Preparing: SELECT uid AS id,user_name AS name,age,email,is_deleted FROM t_user WHERE is_deleted=0 LIMIT ?,?
==> Parameters: 3(Long), 3(Long)
<==    Columns: id, name, age, email, is_deleted
<==        Row: 1514261985414475778, 张三, 23, zhangsan@atguigu.com, 0
<==        Row: 1514261985414475779, 张三, 23, zhangsan@atguigu.com, 0
<==        Row: 1514261985414475790, 张三, 23, zhangsan@atguigu.com, 0
<==      Total: 3
Closing non transactional SqlSession [org.apache.ibatis.session.defaults.DefaultSqlSession@3ee69ad8]
User(id=1514261985414475778, name=张三, age=23, email=zhangsan@atguigu.com, isDeleted=0)
User(id=1514261985414475779, name=张三, age=23, email=zhangsan@atguigu.com, isDeleted=0)
User(id=1514261985414475790, name=张三, age=23, email=zhangsan@atguigu.com, isDeleted=0)
当前页:2
每页显示的条数:3
总记录数:6
总页数:2
是否有上一页:true
是否有下一页:false

6.2. xml自定义分页

6.2.1. UserMapper中定义接口方法

在UserMapper接口中添加添加如下方法:

/**
 * 通过年龄查询用户信息并分页
 * @param page MyBatis-Plus所提供的分页对象,必须位于第一个参数的位置
 * @param age
 * @return
 */
Page<User> selectPageVo(@Param("page") Page<User> page, @Param("age") Integer age);

如果想在自定义的方法中使用MyBatisPlus的分页功能,那么自定义方法的第一个参数必须是Page类型的对象,并且返回值也必须是Page类型的对象

6.2.2. UserMapper.xml中编写SQL

首先在application.yml配置文件中配置类型别名

mybatis-plus:
  # 配置类型别名所对应的包
  type-aliases-package: com.atguigu.mybatisplus.pojo

作了类型别名所在包的配置之后,就可以在mapper配置文件中,这个包下面所有的类都可以使用它所对应的默认的别名(默认别名就是类名,并且不区分大小写)

在UserMapper.xml文件中:

<!--Page<User> selectPageVo(@Param("page") Page<User> page, @Param("age") Integer age);-->
<select id="selectPageVo" resultType="User">
    <!-- 写法一:无须给字段取别名,因为我们已经在实体类通过注解的方式解决了字段名和属性名不一致的问题 -->
    select uid,user_name,age,email from t_user where age > #{age}
    <!-- 写法二:给字段取了别名也不会报错 -->
    <!-- select uid id, user_name name, email from t_user where age > #{age} -->
</select>

总结:当我们的resultType=”xxx”的xxx实体类中已经使用MyBatisPlus的注解解决字段名和属性名不一致的问题后,那么我们写的sql语句就可以不用给需要查询的字段取别名了。

6.2.3. 测试

在src/test/java/目录的com.atguigu.mybatisplus包下的MyBatisPlusPluginsTest类中添加如下测试方法

@Test
public void testPageVo(){
    //设置分页参数
    Page<User> page = new Page<>(1, 3);
    userMapper.selectPageVo(page, 20);
    //获取分页数据
    System.out.println(page.getRecords());
    System.out.println(page.getPages());
    System.out.println(page.getTotal());
    System.out.println(page.hasNext());
    System.out.println(page.hasPrevious());
}

执行结果如下:

==>  Preparing: SELECT COUNT(*) AS total FROM t_user WHERE age > ?
==> Parameters: 20(Integer)
<==    Columns: total
<==        Row: 16
<==      Total: 1
==>  Preparing: select uid, user_name, age, email from t_user where age > ? LIMIT ?
==> Parameters: 20(Integer), 3(Long)
<==    Columns: uid, user_name, age, email
<==        Row: 3, Tom, 28, test3@baomidou.com
<==        Row: 4, 小明, 21, test@atguigu.com
<==        Row: 5, Billie, 24, test5@baomidou.com
<==      Total: 3
Closing non transactional SqlSession [org.apache.ibatis.session.defaults.DefaultSqlSession@18acfe88]
User(id=null, name=null, age=28, email=test3@baomidou.com, isDeleted=null)
User(id=null, name=null, age=21, email=test@atguigu.com, isDeleted=null)
User(id=null, name=null, age=24, email=test5@baomidou.com, isDeleted=null)
当前页:1
每页显示的条数:3
总记录数:16
总页数:6
是否有上一页:false
是否有下一页:true

6.3. 乐观锁

6.3.1. 场景

一件商品,成本价是80元,售价是100元。老板先是通知小李,说你去把商品价格增加50元。小李正在玩游戏,耽搁了一个小时。正好一个小时后,老板觉得商品价格增加到150元,价格太高,可能会影响销量。又通知小王,你把商品价格降低30元。

此时,小李和小王同时操作商品后台系统。小李操作的时候,系统先取出商品价格100元;小王也在操作,取出的商品价格也是100元。小李将价格加了50元,并将100+50=150元存入了数据 库;小王将商品减了30元,并将100-30=70元存入了数据库。是的,如果没有锁,小李的操作就完全被小王的覆盖了。

现在商品价格是70元,比成本价低10元。几分钟后,这个商品很快出售了1千多件商品,老板亏1万多。

6.3.2. 乐观锁与悲观锁

上面的故事,如果是乐观锁,小王保存价格前,会检查下价格是否被人修改过了。如果被修改过 了,则重新取出的被修改后的价格,150元,这样他会将120元存入数据库。

如果是悲观锁,小李取出数据后,小王只能等小李操作完之后,才能对价格进行操作,也会保证最终的价格是120元。

6.3.3. 模拟修改冲突

a> 数据库中增加商品表

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

b> 添加数据

INSERT INTO t_product (id, NAME, price) VALUES (1, '外星人笔记本', 100);

c> 添加实体

在com.atguigu.mybatisplus包下面创建Product实体类

@Data
public class Product {
    private Long id;
    private String name;
    private Integer price;
    private Integer version;
}

d> 添加mapper

在com.atguigu.mybatisplus包下面创建ProductMapper接口

public interface ProductMapper extends BaseMapper<Product> {

}

e> 测试

在src/test/java/目录的com.atguigu.mybatisplus包下的MyBatisPlusPluginsTest类中添加如下测试方法

@Test
public void testProduct01(){
    //小李查询商品价格
    Product productLi = productMapper.selectById(1L);
    System.out.println("小李查询的商品价格:"+productLi.getPrice());
    //小王查询商品价格
    Product productWang = productMapper.selectById(1L);
    System.out.println("小王查询的商品价格:"+productWang.getPrice());
    //小李将商品价格+50
    productLi.setPrice(productLi.getPrice()+50);
    productMapper.updateById(productLi);
    //小王将商品价格-30
    productWang.setPrice(productWang.getPrice()-30);
    productMapper.updateById(productWang);
    //老板查询商品价格
    Product productLaoban = productMapper.selectById(1L);
    System.out.println("老板查询的商品价格:"+productLaoban.getPrice());
}

最终执行结果如下:

MyBatis-Plus学习笔记 - 图52

6.3.4. 乐观锁实现流程

数据库中添加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

6.3.5. Mybatis-Plus实现乐观锁

a> 修改实体类

在实体类中的version属性上添加@Version注解

MyBatis-Plus学习笔记 - 图53

b> 添加乐观锁插件配置

在MyBatisPlusConfig配置类中添加乐观锁插件

MyBatis-Plus学习笔记 - 图54

c> 测试修改冲突

把数据库商品的价格修改回100元,然后再次执行MyBatisPlusPluginsTest测试类的testProduct01()方法,执行流程如下:

==>  Preparing: SELECT id,name,price,version FROM t_product WHERE id=?
==> Parameters: 1(Long)
<==    Columns: id, name, price, version
<==        Row: 1, 外星人笔记本, 100, 0
<==      Total: 1
Closing non transactional SqlSession [org.apache.ibatis.session.defaults.DefaultSqlSession@19962194]
小李查询的商品价格:100

==>  Preparing: SELECT id,name,price,version FROM t_product WHERE id=?
==> Parameters: 1(Long)
<==    Columns: id, name, price, version
<==        Row: 1, 外星人笔记本, 100, 0
<==      Total: 1
Closing non transactional SqlSession [org.apache.ibatis.session.defaults.DefaultSqlSession@52f57666]
小王查询的商品价格:100

小李修改商品价格后,自动将version+1,所以修改后的商品的版本号是1 
==>  Preparing: UPDATE t_product SET name=?, price=?, version=? WHERE id=? AND version=?
==> Parameters: 外星人笔记本(String), 150(Integer), 1(Integer), 1(Long), 0(Integer)
<==    Updates: 1

小王修改商品价格,但是由于小李修改过商品价格,所以此时数据库中的version是1,但是小王之前查询商品的version是0,所以此时条件不成立,修改商品价格失败。
==>  Preparing: UPDATE t_product SET name=?, price=?, version=? WHERE id=? AND version=?
==> Parameters: 外星人笔记本(String), 70(Integer), 1(Integer), 1(Long), 0(Integer)
<==    Updates: 0

小王修改商品价格失败,所以老板查询商品最终价格是:150
==>  Preparing: SELECT id,name,price,version FROM t_product WHERE id=?
==> Parameters: 1(Long)
<==    Columns: id, name, price, version
<==        Row: 1, 外星人笔记本, 150, 1
<==      Total: 1
Closing non transactional SqlSession [org.apache.ibatis.session.defaults.DefaultSqlSession@d277579]
老板查询的商品价格是:150

d> 优化流程

@Test
public void testProduct01(){
    //小李查询商品价格
    Product productLi = productMapper.selectById(1);
    System.out.println("小李查询的商品价格:"+productLi.getPrice());
    //小王查询商品价格
    Product productWang = productMapper.selectById(1);
    System.out.println("小王查询的商品价格:"+productWang.getPrice());
    //小李将商品价格+50
    productLi.setPrice(productLi.getPrice()+50);
    productMapper.updateById(productLi);
    //小王将商品价格-30
    productWang.setPrice(productWang.getPrice()-30);
    int result = productMapper.updateById(productWang);
    if(result == 0){
        //操作失败,重试,重新获取version并更新
        Product productNew = productMapper.selectById(1);
        productNew.setPrice(productNew.getPrice()-30);
        productMapper.updateById(productNew);
    }
    //老板查询商品价格
    Product productLaoban = productMapper.selectById(1);
    System.out.println("老板查询的商品价格:"+productLaoban.getPrice());
}

执行结果如下:

==>  Preparing: SELECT id,name,price,version FROM t_product WHERE id=?
==> Parameters: 1(Long)
<==    Columns: id, name, price, version
<==        Row: 1, 外星人笔记本, 100, 0
<==      Total: 1
Closing non transactional SqlSession [org.apache.ibatis.session.defaults.DefaultSqlSession@3cbf1ba4]
小李查询的商品价格:100

==>  Preparing: SELECT id,name,price,version FROM t_product WHERE id=?
==> Parameters: 1(Long)
<==    Columns: id, name, price, version
<==        Row: 1, 外星人笔记本, 100, 0
<==      Total: 1
Closing non transactional SqlSession [org.apache.ibatis.session.defaults.DefaultSqlSession@3aa41da1]
小王查询的商品价格:100

==>  Preparing: UPDATE t_product SET name=?, price=?, version=? WHERE id=? AND version=?
==> Parameters: 外星人笔记本(String), 150(Integer), 1(Integer), 1(Long), 0(Integer)
<==    Updates: 1
小李修改商品价格成功,自动将version+1,所以修改后的商品的版本号是1

==>  Preparing: UPDATE t_product SET name=?, price=?, version=? WHERE id=? AND version=?
==> Parameters: 外星人笔记本(String), 70(Integer), 1(Integer), 1(Long), 0(Integer)
<==    Updates: 0
版本号被修改过,小王修改商品价格失败

==>  Preparing: SELECT id,name,price,version FROM t_product WHERE id=?
==> Parameters: 1(Long)
<==    Columns: id, name, price, version
<==        Row: 1, 外星人笔记本, 150, 1
<==      Total: 1
小王再次查询数据库中的记录的版本号

==>  Preparing: UPDATE t_product SET name=?, price=?, version=? WHERE id=? AND version=?
==> Parameters: 外星人笔记本(String), 120(Integer), 2(Integer), 1(Long), 1(Integer)
<==    Updates: 1
小王再次修改商品价格成功

==>  Preparing: SELECT id,name,price,version FROM t_product WHERE id=?
==> Parameters: 1(Long)
<==    Columns: id, name, price, version
<==        Row: 1, 外星人笔记本, 120, 2
<==      Total: 1
Closing non transactional SqlSession [org.apache.ibatis.session.defaults.DefaultSqlSession@2d64160c]
老板查询的商品价格是:120

7. 通用枚举

表中的有些字段值是固定的,例如性别(男或女),此时我们可以使用MyBatis-Plus的通用枚举来实现

7.1. 数据库表添加字段sex

MyBatis-Plus学习笔记 - 图55

7.2. 创建通用枚举类型

在com.atguigu.mybatisplus.enums包下创建枚举类SexEnum

@Getter
public enum SexEnum {
    MALE(1, "男"),
    FEMALE(2, "女");

    //将注解所标识的属性的值存储到数据库中
    @EnumValue 
    private Integer sex;

    private String sexName;

    SexEnum(Integer sex, String sexName) {
        this.sex = sex;
        this.sexName = sexName;
    }
}

然后在User实体类中添加SexEnum属性

MyBatis-Plus学习笔记 - 图56

7.3. 配置扫描通用枚举

在application.yml配置文件中作如下配置:

mybatis-plus:
  # 配置扫描通用枚举
  type-enums-package: com.atguigu.mybatisplus.enums

7.4. 测试

在src/test/java/目录的com.atguigu.mybatisplus包下面创建测试类MyBatisPlusEnumTest

@SpringBootTest
public class MyBatisPlusEnumTest {

    @Autowired
    private UserMapper userMapper;

    @Test
    public void test(){
        User user = new User();
        user.setName("admin");
        user.setAge(33);
        user.setSex(SexEnum.MALE);
        int result = userMapper.insert(user);
        System.out.println("result:"+result);
    }

}

执行结果如下:

==>  Preparing: INSERT INTO t_user ( user_name, age, sex ) VALUES ( ?, ?, ? )
==> Parameters: admin(String), 33(Integer), 1(Integer)
<==    Updates: 1
Closing non transactional SqlSession [org.apache.ibatis.session.defaults.DefaultSqlSession@718dbd79]
result:1

8. 代码生成器

8.1. 引入依赖

<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>

8.2. 快速生成

在src/test/java/目录的com.atguigu.mybatisplus包下面创建测试类FastAutoGeneratorTest来生成代码

public class FastAutoGeneratorTest {

    public static void main(String[] args) {
        FastAutoGenerator.create("jdbc:mysql://127.0.0.1:3306/mybatis_plus?characterEncoding=utf-8&userSSL=false", "root", "123456")
            .globalConfig(builder -> {
                builder.author("atguigu") // 设置作者
                    //.enableSwagger() // 开启 swagger 模式
                    .fileOverride() // 覆盖已生成文件
                    .outputDir("D://mybatis_plus"); // 指定输出目录
            })
            .packageConfig(builder -> {
                builder.parent("com.atguigu") // 设置父包名
                    .moduleName("mybatisplus") // 设置父包模块名
                    .pathInfo(Collections.singletonMap(OutputFile.mapperXml, "D://mybatis_plus")); // 设置mapperXml生成路径
            })
            .strategyConfig(builder -> {
                builder.addInclude("t_user") // 设置需要生成的表名
                    .addTablePrefix("t_", "c_"); // 设置过滤表前缀
            })
            .templateEngine(new FreemarkerTemplateEngine()) // 使用Freemarker引擎模板,默认的是Velocity引擎模板
            .execute();
    }

}

9. 多数据源

适用于多种场景:纯粹多库、 读写分离、 一主多从、 混合模式等

目前我们就来模拟一个纯粹多库的一个场景,其他场景类似

场景说明:

我们创建两个库,分别为:mybatis_plus(以前的库不动)与mybatis_plus_1(新建),将mybatis_plus库的product表移动到mybatis_plus_1库,这样每个库一张表,通过一个测试用例分别获取用户数据与商品数据,如果获取到说明多库模拟成功

9.1. 创建数据库及表

创建数据库mybatis_plus_1和表product

CREATE DATABASE `mybatis_plus_1` /*!40100 DEFAULT CHARACTER SET utf8mb4 */;
use `mybatis_plus_1`;
CREATE TABLE 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 product (id, NAME, price) VALUES (1, '外星人笔记本', 100);

删除mybatis_plus库product表

use mybatis_plus;
DROP TABLE IF EXISTS product;

9.2. 引入依赖

在idea中创建一个新的SpringBoot工程,工程名叫mybatis_plus_datasource,工程中的包结构还是com.atguigu.mybatisplus

把之前创建的mybatisplus工程的依赖复制粘贴到当前工程的pom文件中,然后再引入如下的依赖

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

9.3. 配置多数据源

在当前工程的src/main/resources目录下创建application.yml配置文件

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

9.4. 创建用户service

在com.atguigu.mybatisplus.pojo包下面创建User实体类

@Data
@TableName("t_user")
public class User {

    @TableId
    private Integer uid;

    private String userName;

    private Integer age;

    private Integer sex;

    private String email;

    private Integer isDeleted;

}

在com.atguigu.mybatisplus.pojo包下面创建Product实体类

@Data
public class Product {

    private Integer id;

    private String name;

    private Integer price;

    private Integer version;

}

在com.atguigu.mybatisplus.mapper包下面创建UserMapper接口

@Repository
public interface UserMapper extends BaseMapper<User> {

}

在com.atguigu.mybatisplus.mapper包下面创建ProductMapper接口

@Repository
public interface ProductMapper extends BaseMapper<Product> {

}

在com.atguigu.mybatisplus包下面创建SpringBoot的启动类MybatisPlusDatasourceApplication

@SpringBootApplication
@MapperScan("com.atguigu.mybatisplus.mapper")
public class MybatisPlusDatasourceApplication {

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

}

在com.atguigu.mybatisplus.service包下面创建UserService接口

public interface UserService extends IService<User> {

}

在com.atguigu.mybatisplus.service.impl包下面创建UserService接口的实现类UserServiceImpl

@Service
@DS("master")
public class UserServiceImpl extends ServiceImpl<UserMapper, User> implements UserService {

}

9.5. 创建商品service

在com.atguigu.mybatisplus.service包下面创建ProductService接口

public interface ProductService extends IService<Product> {

}

在com.atguigu.mybatisplus.service.impl包下面创建ProductService接口的实现类ProductServiceImpl

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

}

9.6. 测试

在src/test/java目录的com.atguigu.mybatisplus包下面创建测试类

@SpringBootTest
class MybatisPlusDatasourceApplicationTests {

    @Test
    void contextLoads() {
    }

    @Autowired
    private UserService userService;
    @Autowired
    private ProductService productService;

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

}

执行结果如下:

Creating a new SqlSession
SqlSession [org.apache.ibatis.session.defaults.DefaultSqlSession@29149030] was not registered for synchronization because synchronization is not active
JDBC Connection [HikariProxyConnection@641011362 wrapping com.mysql.cj.jdbc.ConnectionImpl@1e9469b8] will not be managed by Spring
==>  Preparing: SELECT uid,user_name,age,email,sex,is_deleted FROM t_user WHERE uid=?
==> Parameters: 1(Long)
<==    Columns: uid, user_name, age, email, sex, is_deleted
<==        Row: 1, Jone, 18, test1@baomidou.com, null, 1
<==      Total: 1
Closing non transactional SqlSession [org.apache.ibatis.session.defaults.DefaultSqlSession@29149030]
User(uid=1, userName=Jone, age=18, email=test1@baomidou.com, sex=null, isDeleted=1)
Creating a new SqlSession
SqlSession [org.apache.ibatis.session.defaults.DefaultSqlSession@7a360554] was not registered for synchronization because synchronization is not active
JDBC Connection [HikariProxyConnection@1112400678 wrapping com.mysql.cj.jdbc.ConnectionImpl@4bc33720] will not be managed by Spring
==>  Preparing: SELECT id,name,price,version FROM product WHERE id=?
==> Parameters: 1(Long)
<==    Columns: id, name, price, version
<==        Row: 1, 外星人笔记本, 100, 0
<==      Total: 1
Closing non transactional SqlSession [org.apache.ibatis.session.defaults.DefaultSqlSession@7a360554]
Product(id=1, name=外星人笔记本, price=100, version=0)

注意:@DS 可以注解在方法上或类上,同时存在就近原则 方法上注解 优先于 类上注解

10. MyBatisX插件

MyBatis-Plus为我们提供了强大的mapper和service模板,能够大大的提高开发效率

但是在真正开发过程中,MyBatis-Plus并不能为我们解决所有问题,例如一些复杂的SQL,多表联查,我们就需要自己去编写代码和SQL语句,我们该如何快速的解决这个问题呢,这个时候可 以使用MyBatisX插件

MyBatisX一款基于 IDEA 的快速开发插件,为效率而生。

MyBatisX插件用法:https://baomidou.com/pages/ba5b24/

MybatisX 是一款基于 IDEA 的快速开发插件,为效率而生。

10.1. 安装MyBatisX插件

安装方法:打开 IDEA,进入 File -> Settings -> Plugins -> Browse Repositories,输入 mybatisx 搜索并安装。

MyBatis-Plus学习笔记 - 图57

安装成功后重启idea即可

10.2. 功能

在mybatis_plus_datasource工程的src/main/resources/mapper目录下创建mapper配置文件

UserMapper.xml

<?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.atguigu.mybatisplus.mapper.UserMapper">


</mapper>

10.2.1. mapper接口定位到mapper配置文件

点击图片中的小鸟按钮就可以直接跳转到mapper配置文件对应的mapper接口

MyBatis-Plus学习笔记 - 图58

10.2.2. mapper配置文件定位到mapper接口

点击图片中的小鸟按钮就可以直接跳转到mapper接口对应的mapper配置文件

MyBatis-Plus学习笔记 - 图59

10.2.3. 快速生成代码

第1步:在idea中创建一个新的SpringBoot工程,工程名叫mybatisx_demo,工程中的包结构是com.atguigu.mybatisx

第2步:引入依赖

<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>

    <!-- mybatis-plus启动器 -->
    <dependency>
        <groupId>com.baomidou</groupId>
        <artifactId>mybatis-plus-boot-starter</artifactId>
        <version>3.5.1</version>
    </dependency>

    <!-- lombok用于简化实体类的开发 -->
    <dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
        <optional>true</optional>
    </dependency>

    <!-- mysql驱动 -->
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <scope>runtime</scope>
    </dependency>
</dependencies>

第3步:创建application.yml配置文件

spring:
  # 配置数据源信息
  datasource:
    # 配置数据源类型
    type: com.zaxxer.hikari.HikariDataSource
    # 配置连接数据库信息
    driver-class-name: com.mysql.cj.jdbc.Driver
    url: jdbc:mysql://localhost:3306/mybatis_plus?characterEncoding=utf-8&useSSL=false
    username: root
    password: 123456

第4步:在idea右侧的Database配置数据源

MyBatis-Plus学习笔记 - 图60

第5步:填写信息,然后点击Test Connection

MyBatis-Plus学习笔记 - 图61

第6步:点击Test Connection后发现如下的错误

MyBatis-Plus学习笔记 - 图62

第7步:解决第6步的错误,选择这个版本比较低的驱动

MyBatis-Plus学习笔记 - 图63

第8步:最后点击Test Connection,测试成功的结果如下,然后点击apply

MyBatis-Plus学习笔记 - 图64

第9步:在t_user上右键选择MybatisX-Generator

MyBatis-Plus学习笔记 - 图65

第10步:

MyBatis-Plus学习笔记 - 图66

第11步:

MyBatis-Plus学习笔记 - 图67

第12步:生成的代码如下

MyBatis-Plus学习笔记 - 图68

10.3. 在Mapper接口中实现自定义的功能

10.3.1. 自定义添加功能

输入一个insert就会出现MyBatisX提供给添加功能的代码模板的提示

MyBatis-Plus学习笔记 - 图69

alter + enter选择第二个选项[MybatisX] Generate Mybatis Sql

MyBatis-Plus学习笔记 - 图70

通过上面的操作即会帮助我们补全Mapper接口中的方法,又会在Mapper配置文件中生成相对应的sql

生成的代码如下:点击方法左边的小鸟按钮就可以跳转到对应的mapper配置文件的sql上

MyBatis-Plus学习笔记 - 图71

10.3.2. 自定义删除功能

输入一个delete就会出现MyBatisX提供给删除功能的代码模板的提示

MyBatis-Plus学习笔记 - 图72

alter + enter选择第二个选项[MybatisX] Generate Mybatis Sql

MyBatis-Plus学习笔记 - 图73

生成的代码如下:

int deleteByUidAndUserName(@Param("uid") Long uid, @Param("userName") String userName);

10.3.3. 自定义修改功能

输入一个update就会出现MyBatisX提供给修改功能的代码模板的提示

MyBatis-Plus学习笔记 - 图74

alter + enter选择第二个选项[MybatisX] Generate Mybatis Sql

MyBatis-Plus学习笔记 - 图75

生成的代码如下:

int updateAgeAndSexByUid(@Param("age") Integer age, @Param("sex") Integer sex, @Param("uid") Long uid);

10.3.4. 自定义查询功能

输入一个select就会出现MyBatisX提供给查询功能的代码模板的提示

MyBatis-Plus学习笔记 - 图76

alter + enter选择第二个选项[MybatisX] Generate Mybatis Sql

MyBatis-Plus学习笔记 - 图77

生成的代码如下:

List<User> selectAgeAndSexByAgeBetween(@Param("beginAge") Integer beginAge, @Param("endAge") Integer endAge);

10.3.4. 排序

输入一个select,然后以orderby结尾就会出现MyBatisX提供给排序功能的代码模板的提示

MyBatis-Plus学习笔记 - 图78

alter + enter选择第二个选项[MybatisX] Generate Mybatis Sql

MyBatis-Plus学习笔记 - 图79

生成的代码如下:

List<User> selectAllOrderByAgeDesc();