一文搞懂MyBatisPlus的使用

简介

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

官网：https://baomidou.com/

特性

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

支持数据库

• mysql 、 mariadb 、 oracle 、 db2 、 h2 、 hsql 、 sqlite 、 postgresql 、 sqlserver 、 presto
• 达梦数据库 、 虚谷数据库 、 人大金仓数据库

框架结构

快速开始

创建数据库表

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

INSERT INTO user (id, name, age, email) VALUES
(1, 'Jone', 18, '[email protected]'),
(2, 'Jack', 20, '[email protected]'),
(3, 'Tom', 28, '[email protected]'),
(4, 'Sandy', 21, '[email protected]'),
(5, 'Billie', 24, '[email protected]');

创建SpringBoot项目，添加依赖

<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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0modelVersion>
    <parent>
        <groupId>org.springframework.bootgroupId>
        <artifactId>spring-boot-starter-parentartifactId>
        <version>2.3.3.RELEASEversion>
        <relativePath/> 
    parent>
    <groupId>cn.yanghuisengroupId>
    <artifactId>mp-demoartifactId>
    <version>0.0.1-SNAPSHOTversion>
    <name>mp-demoname>
    <description>Demo project for MyBatis-Plusdescription>

    <properties>
        <java.version>1.8java.version>
    properties>

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

        <dependency>
            <groupId>mysqlgroupId>
            <artifactId>mysql-connector-javaartifactId>
            <scope>runtimescope>
        dependency>
        <dependency>
            <groupId>org.projectlombokgroupId>
            <artifactId>lombokartifactId>
            <optional>trueoptional>
        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.2version>
        dependency>
    dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.bootgroupId>
                <artifactId>spring-boot-maven-pluginartifactId>
            plugin>
        plugins>
    build>

project>

注：如果引入了MyBatis-Plus就不要在引入MyBtais，两者选一

配置数据库账号密码

修改application.yml文件

spring:
  datasource:
    driver-class-name: com.mysql.cj.jdbc.Driver
    username: root
    password: 123456
    url: jdbc:mysql://localhost:3306/mpdemo?useUnicode=true&characterEncoding=utf8&serverTimezone=GMT%2B8

编码

创建实体类

使用Lombok减少代码

package cn.yanghuisen.mpdemo.entity;

import lombok.Data;

/**
 * @author Y
 * @date 2020/8/15 20:41
 * @desc 用户实体类
 */
@Data
public class User {
     
    
    private Long id;
    
    private String name;
    
    private Integer age;
    
    private String email;
}

mapper接口

package cn.yanghuisen.mpdemo.mapper;

import cn.yanghuisen.mpdemo.entity.User;
import com.baomidou.mybatisplus.core.mapper.BaseMapper;

/**
 * @author Y
 * @date 2020/8/15 20:39
 * @desc 用户Mapper接口
 */
public interface UserMapper extends BaseMapper<User> {
     
}

UserMapper接口继承BaseMapper，泛型参数为实体类对象

配置扫描注解

package cn.yanghuisen.mpdemo;

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

/**
 * @author Y
 * @date 2020/8/15 20:38
 * @desc 启动类
 */
@SpringBootApplication
@MapperScan("cn.yanghuisen.mpdemo.mapper")
public class MpDemoApplication {
     

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

}

使用@MapperScan指定扫描的mapper接口路径

开始使用

查询所有的数据

package cn.yanghuisen.mpdemo;

import cn.yanghuisen.mpdemo.entity.User;
import cn.yanghuisen.mpdemo.mapper.UserMapper;
import lombok.extern.slf4j.Slf4j;
import org.junit.jupiter.api.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringRunner;

import java.util.List;

@SpringBootTest // 测试注解
@RunWith(SpringRunner.class)    // 使用Spring环境
@Slf4j  // 日志打印
class MpDemoApplicationTests {
     

    @Autowired
    private UserMapper userMapper;

    @Test
    void selectListTest() {
     
        log.info("*****查询User列表*****");
        List<User> userList = userMapper.selectList(null);
        log.info("*****打印userList*****");
        userList.forEach(System.out::println);
    }

}

User(id=1, name=Jone, age=18, [email protected])
User(id=2, name=Jack, age=20, [email protected])
User(id=3, name=Tom, age=28, [email protected])
User(id=4, name=Sandy, age=21, [email protected])
User(id=5, name=Billie, age=24, [email protected])

到此就可以体会到MyBatis-Plus的强大魅力，只需要简单的配置就可以实现基本的CRUD操作。

日志配置

开始日志，查看具体SQL命令

application.yml

mybatis-plus:
  configuration:
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl

注解

@TableName

表名注解

属性	类型	必须指定	默认值	描述
value	String	否	“”	表名
schema	String	否	“”	schema
keepGlobalPrefix	boolean	否	false	是否保持使用全局的 tablePrefix 的值(如果设置了全局 tablePrefix 且自行设置了 value 的值)
resultMap	String	否	“”	xml 中 resultMap 的 id
autoResultMap	boolean	否	false	是否自动构建 resultMap 并使用(如果设置 resultMap 则不会进行 resultMap 的自动构建并注入)

@TableId

主键注解

属性	类型	必须指定	默认值	描述
value	String	否	“”	主键字段名
type	Enum	否	IdType.NONE	主键类型

IdType

主键生成方式

值	描述
AUTO	数据库ID自增
NONE	无状态,该类型为未设置主键类型(注解里等于跟随全局,全局里约等于 INPUT)
INPUT	insert前自行set主键值
ASSIGN_ID	分配ID(主键类型为Number(Long和Integer)或String)(since 3.3.0),使用接口IdentifierGenerator的方法nextId(默认实现类为DefaultIdentifierGenerator雪花算法)
ASSIGN_UUID	分配UUID,主键类型为String(since 3.3.0),使用接口IdentifierGenerator的方法nextUUID(默认default方法)
ID_WORKER	分布式全局唯一ID 长整型类型(please use ASSIGN_ID)
UUID	32位UUID字符串(please use ASSIGN_UUID)
ID_WORKER_STR	分布式全局唯一ID 字符串类型(please use ASSIGN_ID)

@TableField

字段注解(非主键)

属性	类型	必须指定	默认值	描述
value	String	否	“”	数据库字段名
el	String	否	“”	映射为原生 #{ ... } 逻辑,相当于写在 xml 里的 #{ ... } 部分
exist	boolean	否	true	是否为数据库表字段
condition	String	否	“”	字段 where 实体查询比较条件,有值设置则按设置的值为准,没有则为默认全局的 %s=#{%s},参考
update	String	否	“”	字段 update set 部分注入, 例如：update="%s+1"：表示更新时会set version=version+1(该属性优先级高于 el 属性)
insertStrategy	Enum	N	DEFAULT	举例：NOT_NULL: insert into table_a(column) values (#{columnProperty})
updateStrategy	Enum	N	DEFAULT	举例：IGNORED: update table_a set column=#{columnProperty}
whereStrategy	Enum	N	DEFAULT	举例：NOT_EMPTY: where column=#{columnProperty}
fill	Enum	否	FieldFill.DEFAULT	字段自动填充策略
select	boolean	否	true	是否进行 select 查询
keepGlobalFormat	boolean	否	false	是否保持使用全局的 format 进行处理
jdbcType	JdbcType	否	JdbcType.UNDEFINED	JDBC类型 (该默认值不代表会按照该值生效)
typeHandler	Class	否	UnknownTypeHandler.class	类型处理器 (该默认值不代表会按照该值生效)
numericScale	String	否	“”	指定小数点后保留的位数

FieldStrategy

值	描述
IGNORED	忽略判断
NOT_NULL	非NULL判断
NOT_EMPTY	非空判断(只对字符串类型字段,其他类型字段依然为非NULL判断)
DEFAULT	追随全局配置

FieldFill

字段填充策略

值	描述
DEFAULT	默认不处理
INSERT	插入时填充字段
UPDATE	更新时填充字段
INSERT_UPDATE	插入和更新时填充字段

@TableLogic

表字段逻辑处理注解（逻辑删除）

属性	类型	必须指定	默认值	描述
value	String	否	“”	逻辑未删除值
delval	String	否	“”	逻辑删除值

CRUD接口

MapperCRUD接口

这里只是一部分查询接口，完整的查询接口请查看官方文档。

insert-插入数据

@Test
void insertTest(){
     
    User user = new User();
    user.setName("Ahh");
    user.setAge(20);
    user.setEmail("[email protected]");
    userMapper.insert(user);
    log.info(user.toString());
    selectListTest();
}

调用insert方法进行数据插入，传入一个user对象。插入成功后会把生成的ID，回填到user对象中。

注：默认使用的是雪花算法生成对应的ID，如果要修改ID生成算法可以在实体类上添加注解@TableId

public class User {
     
    
    @TableId(type = IdType.AUTO)
    private Long id;
    
    private String name;
    
    private Integer age;
    
    private String email;
}

注：如果要使用auto自增主键的话，需要开启数据库的主键ID自增。

update-更新数据

@Test
void updateTest(){
     
    User user = new User();
    user.setId(6L);
    user.setName("啊哈哈");
    user.setAge(20);
    user.setEmail("[email protected]");
    int i = userMapper.updateById(user);
    log.info(i+"");
    selectListTest();
}

注：updateById传入的是user对象，不是具体的ID。

select-查询数据

批量查询

@Test
void selectUserByBatchId(){
     
    List<User> userList = userMapper.selectBatchIds(Arrays.asList(1,2,3,4,5));
    userList.forEach(System.out::println);
}

Map条件查询

@Test
void selectUserByMap(){
     
    Map<String,Object> map = new HashMap<>();
    map.put("id",1);
    map.put("name","Jone");
    List<User> userList = userMapper.selectByMap(map);
    userList.forEach(System.out::println);
}

delete-删除数据

@Test
void deleteUserById(){
     
    userMapper.deleteById(1302239794451763202L);
    selectListTest();
}

删除同样有批量删除和map删除，使用方式和查询的一样

条件构造器

细心的就会发现，上面的CRUD都是一些简单的操作，如果是复杂的就没办法了，所以这时就要用到了条件构造器。

条件构造器有很多，具体的还请查看官方网文档，这里只会列举几个使用方法。

isNotNull-不为空

查询name不为空的用户，并且邮箱部位空的用户

@Test
public void isNotNullTest(){
     
// 查询name不为空的用户，并且邮箱部位空的用户
QueryWrapper<User> wrapper = new QueryWrapper<>();
// name不为null
wrapper.isNotNull("name");
// email部位null
wrapper.isNotNull("email");
userMapper.selectList(wrapper).forEach(System.out::println);
}

ge-大于等于

查询age大于等于22的用户

@Test
public void geTest(){
     
    // 查询age大于等于22的用户
    QueryWrapper<User> wrapper = new QueryWrapper<>();
    wrapper.ge("age",22);
    userMapper.selectList(wrapper).forEach(System.out::println);
}

eq-等于

查询name等于Jone的用户

@Test
public void eqTest(){
     
    // 查询name等于Jone的用户
    QueryWrapper<User> wrapper = new QueryWrapper<>();
    wrapper.eq("name","Jone");
    System.out.println(userMapper.selectOne(wrapper));
}

selectOne：只查询一条数据

between-X与N之间的值

查询年龄在20到25之间的用户的数量

@Test
public void betweenTest(){
     
    // 查询年龄在20到25之间的用户的数量
    QueryWrapper<User> wrapper = new QueryWrapper<>();
    wrapper.between("age",20,25);
    Integer count = userMapper.selectCount(wrapper);
    System.out.println(count);
}

selectCount：查询数量

like-模糊查询

@Test
public void likeTest(){
     
    // 查询name中包含a的用户
    QueryWrapper<User> wrapper = new QueryWrapper<>();
    wrapper.like("name","a");
    List<Map<String,Object>> maps = userMapper.selectMaps(wrapper);
    maps.forEach(System.out::println);
}

selectMaps：返回List形式的数据

notLike-模糊查询

查询name中不包含a的用户

@Test
public void notLikeTest(){
     
    // 查询name中不包含a的用户
    QueryWrapper<User> wrapper = new QueryWrapper<>();
    wrapper.notLike("name","a");
    List<Map<String,Object>> maps = userMapper.selectMaps(wrapper);
    maps.forEach(System.out::println);
}

likeLeft-左模糊查询

查询name中以e结尾的用户

@Test
public void likeLeftTest(){
     
    // 查询name中以e结尾的用户
    QueryWrapper<User> wrapper = new QueryWrapper<>();
    wrapper.likeLeft("name","e");
    List<Map<String,Object>> maps = userMapper.selectMaps(wrapper);
    maps.forEach(System.out::println);
}

likeRight-左模糊查询

查询name中以j开头的用户

@Test
public void likeRightTest(){
     
    // 查询name中以j结开头的用户
    QueryWrapper<User> wrapper = new QueryWrapper<>();
    wrapper.likeRight("name","j");
    List<Map<String,Object>> maps = userMapper.selectMaps(wrapper);
    maps.forEach(System.out::println);
}

inSql

id 在子查询中查询出来

@Test
public void inSqlTest(){
     
    // id 在子查询中查询出来
    QueryWrapper<User> wrapper = new QueryWrapper<>();
    wrapper.inSql("id","select id from user where id < 5");
    List<Object> objects = userMapper.selectObjs(wrapper);
    objects.forEach(System.out::println);
}

selectObjs：返回List