（硅谷课堂项目）Java开发笔记1：MyBatis-Plus使用

（硅谷课堂项目）Java开发笔记1：MyBatis-Plus使用

1.简介

先来点八股简单介绍下。

1.1 概述

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

1.2 特性

• 无侵入：只做增强不做改变，引入它不会对现有工程产生影响，如丝般顺滑
• 损耗小：启动即会自动注入基本 CURD，性能基本无损耗，直接面向对象操作
• 强大的 CRUD 操作：内置通用 Mapper、通用 Service，仅仅通过少量配置即可实现单表大部分 CRUD 操作，更有强大的条件构造器，满足各类使用需求
• 支持 Lambda 形式调用：通过 Lambda 表达式，方便的编写各类查询条件，无需再担心字段写错
• 支持多种数据库：支持 MySQL、MariaDB、Oracle、DB2、H2、HSQL、SQLite、Postgre、SQLServer2005、SQLServer 等多种数据库
• 支持主键自动生成：支持多达 4 种主键策略（内含分布式唯一 ID 生成器 - Sequence），可自由配置，完美解决主键问题
• 支持 XML 热加载：Mapper 对应的 XML 支持热加载，对于简单的 CRUD 操作，甚至可以无 XML 启动
• 支持 ActiveRecord 模式：支持 ActiveRecord 形式调用，实体类只需继承 Model 类即可进行强大的 CRUD 操作
• 支持自定义全局通用操作：支持全局通用方法注入（ Write once, use anywhere ）
• 支持关键词自动转义：支持数据库关键词（order、key…）自动转义，还可自定义关键词
• 内置代码生成器：采用代码或者 Maven 插件可快速生成 Mapper 、 Model 、 Service 、 Controller 层代码，支持模板引擎，更有超多自定义配置等您来使用
• 内置分页插件：基于 MyBatis 物理分页，开发者无需关心具体操作，配置好插件之后，写分页等同于普通 List 查询
• 内置性能分析插件：可输出 Sql 语句以及其执行时间，建议开发测试时启用该功能，能快速揪出慢查询
• 内置全局拦截插件：提供全表 delete 、 update 操作智能分析阻断，也可自定义拦截规则，预防误操作
• 内置 Sql 注入剥离器：支持 Sql 注入剥离，有效预防 Sql 注入攻击

2.使用

2.1创建工程

话不多说，直接上手使用。

先创建下工程：

点击下一步：

完成创建：

2.2引入依赖

先修改下spring-boot的版本。

下面引入相关依赖：

<dependencies>
        <dependency>
            <groupId>org.springframework.bootgroupId>
            <artifactId>spring-boot-starterartifactId>
        dependency>

        <dependency>
            <groupId>org.springframework.bootgroupId>
            <artifactId>spring-boot-starter-testartifactId>
            <scope>testscope>
        dependency>

        
        <dependency>
            <groupId>com.baomidougroupId>
            <artifactId>mybatis-plus-boot-starterartifactId>
            <version>3.3.1version>
        dependency>

        
        <dependency>
            <groupId>mysqlgroupId>
            <artifactId>mysql-connector-javaartifactId>
        dependency>

        
        <dependency>
            <groupId>org.projectlombokgroupId>
            <artifactId>lombokartifactId>
        dependency>
dependencies>
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31

除了引入lombok依赖，还得在IDEA中安装lombok插件，解决解决user.setxx getxx方法爆红的问题。

2.3创建相关包和类

工程的结构如下：

2.4创建测试数据库和表

mybatis_plus

其表结构如下：

创建数据库语句如下：

CREATE DATABASE mybatisplusdemo;
USE mybatisplusdemo;
1
2

其对应的建表语句如下：

CREATE TABLE USER
(
    id BIGINT(20) NOT NULL COMMENT '主键ID',
    NAME VARCHAR(30) NULL DEFAULT NULL COMMENT '姓名',
    age INT(11) NULL DEFAULT NULL COMMENT '年龄',
    email VARCHAR(50) NULL DEFAULT NULL COMMENT '邮箱',
    PRIMARY KEY (id)
);
1
2
3
4
5
6
7
8

其对应的数据库 Data 脚本如下：

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');
1
2
3
4
5
6

2.5创建配置文件

application.properties:

我这里的mysql版本为8。

#mysql数据库连接
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.url=jdbc:mysql://localhost:3307/mybatisplusdemo?serverTimezone=GMT%2B8
spring.datasource.username=root
spring.datasource.password=root


#mybatis日志
mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl

# mp默认 0 没有删除  1已结删除
#mybatis-plus.global-config.db-config.logic-delete-value=1
#mybatis-plus.global-config.db-config.logic-not-delete-value=0
1
2
3
4
5
6
7
8
9
10
11
12
13

如果为mysql5，相关的配置文件不一样：

mysql5

#mysql数据库连接
spring.datasource.driver-class-name=com.mysql.jdbc.Driver
spring.datasource.url=jdbc:mysql://localhost:3306/mybatis_plus
spring.datasource.username=root
spring.datasource.password=123456
1
2
3
4
5

mysql8以上（spring boot 2.1）注意：driver和url的变化

spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.url=jdbc:mysql://localhost:3306/mybatis_plus?serverTimezone=GMT%2B8
spring.datasource.username=root
spring.datasource.password=root
1
2
3
4

注意：

1、这里的 url 使用了 ?serverTimezone=GMT%2B8 后缀，因为Spring Boot 2.1 集成了 8.0版本的jdbc驱动，这个版本的 jdbc 驱动需要添加这个后缀，否则运行测试用例报告如下错误：

java.sql.SQLException: The server time zone value ‘Öйú±ê׼ʱ¼ä’ is unrecognized or represents more

2、这里的 driver-class-name 使用了 com.mysql.cj.jdbc.Driver ，在 jdbc 8 中 建议使用这个驱动，之前的 com.mysql.jdbc.Driver 已经被废弃，否则运行测试用例的时候会有 WARN 信息

2.6编写代码

（1）创建启动类

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

MpdemoApplication.java:

package com.gerrard.mpdemo;

import org.mybatis.spring.annotation.MapperScan;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
@MapperScan("com.gerrard.mpdemo.mapper")
public class MpdemoApplication {

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

}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

（2）创建实体类

User.java：

package com.gerrard.mpdemo.entity;


import lombok.Data;

@Data
public class User {

    private Long id;

    private String name;

    private Integer age;

    private String email;

//    //逻辑删除标志
//    @TableLogic
//    private Integer deleted;

}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

（3）创建Mapper

UserMapper.java:

package com.gerrard.mpdemo.mapper;

import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.gerrard.mpdemo.entity.User;
import org.springframework.stereotype.Repository;

@Repository
public interface UserMapper extends BaseMapper<User> {

}
1
2
3
4
5
6
7
8
9
10

注意：

IDEA在 userMapper 处报错，因为找不到注入的对象，因为类是动态创建的，但是程序可以正确的执行。

为了避免报错，可以在 dao 层 的接口上添加 @Repository 注解

（4）功能测试-查询所有记录

MpdemoApplicationTests.java:

package com.gerrard.mpdemo;

import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
import com.gerrard.mpdemo.entity.User;
import com.gerrard.mpdemo.mapper.UserMapper;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;

import java.util.Arrays;
import java.util.List;

@SpringBootTest
class MpdemoApplicationTests {

    //注入mapper
    @Autowired
    private UserMapper userMapper;

    //1 查询表所有数据
    @Test
    public void findAll() {
        List<User> userList = userMapper.selectList(null);
        for (User user:userList) {
            System.out.println(user);
        }
    }

}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

测试findAll方法：

疑问：Mp是怎么知道要查询哪张数据表的，实体类没有绑定数据表的注解的话，盲猜该实体类的名称要和数据表名称一致，为了验证改猜想，我将User实体类名称改为Admin，再测试findAll()方法。

果然报错，猜想得到证实。

3.MyBatisPlus实现CRUD操作

3.1 插入操作

MpdemoApplicationTests.java:

	//2 添加操作
    @Test
    public void addUser() {
        User user = new User();
        user.setName("gerrard");
        user.setAge(10);
        user.setEmail("fifa.com");
        int rows = userMapper.insert(user);
        System.out.println("rows:"+rows);//影响的行数
        //添加成功之后，把添加之后生成id值，回填到user对象里面
        System.out.println(user);//id自动回填
    }
1
2
3
4
5
6
7
8
9
10
11
12

查看数据库：

为啥自动生成的id值这么奇怪呢？你先别急，急也没用，这就得研究MP的主键生成策略了。

3.2 主键策略

（1）ID_WORKER

MyBatis-Plus默认的主键策略是：ID_WORKER 全局唯一ID

（2）自增策略

• 要想主键自增需要配置如下主键策略

• • 需要在创建数据表的时候设置主键自增
  • 实体字段中配置 @TableId(type = IdType.AUTO)

@TableId(type = IdType.AUTO)
private Long id;
1
2

其它主键策略：分析 IdType 源码可知

public enum IdType {
     /**
     * 数据库ID自增
     */
    AUTO(0),
    
    /**
     * 该类型为未设置主键类型
     */
    NONE(1),
    
    /**
     * 用户输入ID
     * 该类型可以通过自己注册自动填充插件进行填充
     */    
    INPUT(2),
    
    /**
     * 全局唯一ID
     */    
    ASSIGN_ID(3),
    
    /**
     * 全局唯一ID (UUID)
     */
    ASSIGN_UUID(4),
    
    /** @deprecated */
    @Deprecated
    ID_WORKER(3),
    /** @deprecated */
    @Deprecated
    ID_WORKER_STR(3),
    /** @deprecated */
    @Deprecated
    UUID(4);
    private final int key;
    private IdType(int key) {
        this.key = key;
    }
    public int getKey() {
        return this.key;
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44

采用主键自增策略测试一下：

数据表也要将id设为自增：

测试结果：

这时再把“@TableId(type = IdType.AUTO)”注解注掉，再次测试，结果见下，又随机生成了。可见MP设为主键自增策略，则数据表也同样要做设置，如果设为主键随机生成，则不用管数据表设置的主键相关信息。

3.3 根据Id更新操作

**注意：**update时生成的sql自动是动态sql：UPDATE user SET age=? WHERE id=?

MpdemoApplicationTests.java:

//3 修改操作
    @Test
    public void updateUser() {
        //根据id查询
        User user = userMapper.selectById(1560161515489755138L);
        //设置修改值
        user.setName("haihaihai");
        //调用方法实现修改
        int rows = userMapper.updateById(user);
        System.out.println(rows);
    }
1
2
3
4
5
6
7
8
9
10
11

3.4 分页查询

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

（1）创建配置类

MpConfig.java:

package com.gerrard.mpdemo.config;

import com.baomidou.mybatisplus.extension.plugins.PaginationInterceptor;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class MpConfig {
    //分页插件
    @Bean
    public PaginationInterceptor paginationInterceptor() {
        return new PaginationInterceptor();
    }

}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

（2）测试selectPage分页

**测试：**最终通过page对象获取相关数据

MpdemoApplicationTests.java:

	//4 分页查询
    @Test
    public void findPage() {
        //创建Page对象，传递两个参数：当前页    每页显示记录数
        Page<User> page = new Page<>(1,3);
        //调用mp方法实现分页
        userMapper.selectPage(page,null);
        //IPage pageModel = userMapper.selectPage(page,null);
        List<User> list = page.getRecords();
        System.out.println(list);
        System.out.println(page.getCurrent());
        System.out.println(page.getPages());
        System.out.println(page.getSize());
        System.out.println(page.getTotal());
        System.out.println(page.hasNext());
        System.out.println(page.hasPrevious());
    }
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

控制台sql语句打印：SELECT id,name,age,email,create_time,update_time FROM user LIMIT 0,3

3.5 根据id删除记录

MpdemoApplicationTests.java:

 	//5 id删除
    @Test
    public void deleteId() {
        int rows = userMapper.deleteById(1553737739952766978L);
        System.out.println(rows);
    }
1
2
3
4
5
6

3.6 批量删除

MpdemoApplicationTests.java:

  //6 批量删除
    @Test
    public void deleteBatch() {
        int rows = userMapper.deleteBatchIds(Arrays.asList(1, 2));
        System.out.println(rows);
    }
1
2
3
4
5
6

3.7 逻辑删除

• 物理删除：真实删除，将对应数据从数据库中删除，之后查询不到此条被删除数据
• 逻辑删除：假删除，将对应数据中代表是否被删除字段状态修改为“被删除状态”，之后在数据库中仍旧能看到此条数据记录

（1）数据库中添加 deleted字段

ALTER TABLE `user` ADD COLUMN `deleted` boolean
1

（2）实体类添加deleted字段

并加上 @TableLogic 注解

User.java:

@TableLogic
private Integer deleted;
1
2

（3）application.properties 加入配置

此为默认值，如果你的默认值和mp默认的一样,该配置可无

mybatis-plus.global-config.db-config.logic-delete-value=1
mybatis-plus.global-config.db-config.logic-not-delete-value=0
1
2

（5）测试逻辑删除

• 测试后发现，数据并没有被删除，deleted字段的值由0变成了1
• 测试后分析打印的sql语句，是一条update
• **注意：**被删除数据的deleted 字段的值必须是 0，才能被选取出来执行逻辑删除的操作

/**
 * 测试 逻辑删除
 */
	//5 id删除
    @Test
    public void deleteId() {
        int rows = userMapper.deleteById(1553737739952766978L);
        System.out.println(rows);
    }
1
2
3
4
5
6
7
8
9

（6）测试逻辑删除后的查询

MyBatis Plus中查询操作也会自动添加逻辑删除字段的判断

/**
 * 测试 逻辑删除后的查询：
 * 不包括被逻辑删除的记录
 */
@Test
public void testLogicDeleteSelect() {
    User user = new User();
    List<User> users = userMapper.selectList(null);
    users.forEach(System.out::println);
}
1
2
3
4
5
6
7
8
9
10

测试后分析打印的sql语句，包含 WHERE deleted=0

SELECT id,name,age,email,create_time,update_time,deleted FROM user WHERE deleted=0

4.MyBatisPlus条件构造器

Wrapper ： 条件构造抽象类，最顶端父类

AbstractWrapper ： 用于查询条件封装，生成 sql 的 where 条件

QueryWrapper ： Entity 对象封装操作类，不是用lambda语法

UpdateWrapper ： Update 条件封装，用于Entity对象更新操作

AbstractLambdaWrapper ： Lambda 语法使用 Wrapper统一处理解析 lambda 获取 column。

LambdaQueryWrapper ：看名称也能明白就是用于Lambda语法使用的查询Wrapper

LambdaUpdateWrapper ： Lambda 更新封装Wrapper

注意：以下条件构造器的方法入参中的 column 均表示数据库字段

4.1 QueryWrapper 使用

（1）ge、gt、le、lt

QueryTestsDemo1.java:

package com.gerrard.mpdemo;

import com.baomidou.mybatisplus.core.conditions.query.LambdaQueryWrapper;
import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
import com.gerrard.mpdemo.entity.User;
import com.gerrard.mpdemo.mapper.UserMapper;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;

import java.util.List;

@SpringBootTest
class QueryTestsDemo1 {

    //注入mapper
    @Autowired
    private UserMapper userMapper;
    
    //1 queryWrapper
    //ge、gt、le、lt
    @Test
    public void query1() {
        //创建条件构造对象
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        //ge、gt、le、lt
        //ge为例有两个参数：第一个参数表字段名称，第二个参数值
        wrapper.ge("age",20);
        //调用方法实现条件查询
        List<User> userList = userMapper.selectList(wrapper);
        System.out.println(userList);
    }

}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35

（2）eq、ne

**注意：**seletOne返回的是一条实体记录，当出现多条时会报错

QueryTestsDemo1.java:

//2 queryWrapper
    //eq ne
    @Test
    public void query2() {
        //创建条件构造对象
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        //eq ne
        //eq为例有两个参数：第一个参数表字段名称，第二个参数值
        wrapper.eq("name","gerrard");
        //调用方法实现条件查询
        List<User> userList = userMapper.selectList(wrapper);
        System.out.println(userList);
    }
1
2
3
4
5
6
7
8
9
10
11
12
13

SELECT id,name,age,email,create_time,update_time,deleted,version FROM user WHERE deleted=0 AND name = ?

（3）like、likeLeft、likeRight

selectMaps返回Map集合列表

QueryTestsDemo1.java:

 //3 queryWrapper
    //like、likeLeft、likeRight
    @Test
    public void query3() {
        //创建条件构造对象
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        //like、likeLeft、likeRight
        wrapper.likeLeft("name","ger");
        //调用方法实现条件查询
        List<User> userList = userMapper.selectList(wrapper);
        System.out.println(userList);
    }
1
2
3
4
5
6
7
8
9
10
11
12

SELECT id,name,age,email,create_time,update_time,deleted,version

FROM user WHERE deleted=0 AND name LIKE ? AND email LIKE ?

（4）orderByDesc、orderByAsc

QueryTestsDemo1.java:

//4 queryWrapper
    //orderByDesc、orderByAsc
    @Test
    public void query4() {
        //创建条件构造对象
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        wrapper.orderByDesc("id");
        //调用方法实现条件查询
        List<User> userList = userMapper.selectList(wrapper);
        System.out.println(userList);
    }
1
2
3
4
5
6
7
8
9
10
11

SELECT id,name,age,email,create_time,update_time,deleted,version

FROM user WHERE deleted=0 ORDER BY id DESC

4.2 LambdaQueryWrapper 使用

QueryTestsDemo1.java:

//5 LambdaQueryWrapper
    @Test
    public void testLambdaQuery1() {
        //创建条件构造对象
        LambdaQueryWrapper<User> wrapper = new LambdaQueryWrapper();
        wrapper.eq(User::getName,"gerrard");
        //调用方法查询
        List<User> userList = userMapper.selectList(wrapper);
        System.out.println(userList);
    }

//6 LambdaQueryWrapper
    @Test
    public void testLambdaQuery2() {
        //创建条件构造对象
        LambdaQueryWrapper<User> wrapper = new LambdaQueryWrapper();
        wrapper.like(User::getName,"ger");
        //调用方法查询
        List<User> userList = userMapper.selectList(wrapper);
        System.out.println(userList);
    }
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

SELECT id,name,age,email,create_time,update_time,deleted,version

FROM user WHERE deleted=0 AND age = ? AND name LIKE ?

5.MyBatisPlus封装Service层

5.1 创建service

UserService.java:

package com.gerrard.mpdemo.service;

import com.baomidou.mybatisplus.extension.service.IService;
import com.gerrard.mpdemo.entity.User;

public interface UserService extends IService<User> {
}

1
2
3
4
5
6
7
8

5.2 创建service实现类

UserServiceImpl.java:

package com.gerrard.mpdemo.service.impl;

import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
import com.gerrard.mpdemo.entity.User;
import com.gerrard.mpdemo.mapper.UserMapper;
import com.gerrard.mpdemo.service.UserService;
import org.springframework.stereotype.Service;

@Service
public class UserServiceImpl extends ServiceImpl<UserMapper, User> implements UserService {

//        //注入mapper
//    @Autowired
//    private UserMapper userMapper;
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

底层封装了注入Mapper过程

5.3 方法调用测试

ServiceTestsDemo.java:

package com.gerrard.mpdemo;

import com.gerrard.mpdemo.entity.User;
import com.gerrard.mpdemo.service.UserService;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;

import java.util.List;

@SpringBootTest
 class ServiceTestsDemo {

    //注入service
    @Autowired
    private UserService userService;

    @Test
    public void testQuery2() {
        List<User> list = userService.list();
        System.out.println(list);

    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24