MyBatis-Plus快速上手

MyBatis-Plus（简称 MP）是一个 MyBatis 的增强工具，在 MyBatis 的基础上只做增强不做改变，为简化开发、提高效率而生。官网文档、官网samples、参考文章1、参考文章2。

MP logo

MyBatis-Plus系列推荐阅读顺序:

• MyBatis-Plus快速上手
• MyBatis-Plus 条件构造器（Wrapper）
• Mybatis-Plus 常用操作

一、本文目标

• 官方文档考虑的是全面完整的介绍Mybatis Plus， 本文角度是：“最佳实践，快速上手”。
• 世界上很多东西都符合2/8原则，本文档的目的：最重要最常用的那20%帮你提炼出来、快速上手应用，入门~~~！。另外的那80%都是不常用的，有空自己再去学习提高！

官网文档地址：https://mybatis.plus/guide/

二、快速开始

我们将通过一个简单的 Demo 来阐述 MyBatis-Plus 的功能。

2.1 User表

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

DROP TABLE IF EXISTS user;

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

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

DELETE FROM user;

INSERT INTO user (id, name, age, email) VALUES
(1, 'Guo ', 18, '[email protected]'),
(2, 'xiu', 20, '[email protected]'),
(3, 'zhi', 28, '[email protected]'),
(4, 'Oliver', 21, '[email protected]'),
(5, 'Messi', 24, '[email protected]');

2.2 新建Sring boot Module

创建一个空的 Spring Boot 工程/Module。
引入spring-boot-starter-test、mybatis-plus-boot-starter、lombok、mysql 依赖：

    4.0.0
    com.erbadagang.mybatis.plus
    mybatis-plus
    0.0.1-SNAPSHOT
    mybatis-plus-starter
    Mybatis-Plus project for Spring Boot

    
        1.8
        UTF-8
        UTF-8
        2.3.0.RELEASE
        3.3.2
    

    
        
            org.springframework.boot
            spring-boot-starter-data-jdbc
        
        
            org.springframework.boot
            spring-boot-starter-web
        

        
            mysql
            mysql-connector-java
            runtime
        
        
            org.projectlombok
            lombok
            true
        
        
        
            com.baomidou
            mybatis-plus-boot-starter
            ${mp.version}
        
        
            org.springframework.boot
            spring-boot-starter-test
            test
            
                
                    org.junit.vintage
                    junit-vintage-engine
                
            
        
    

    
        
            
                org.springframework.boot
                spring-boot-dependencies
                ${spring-boot.version}
                pom
                import
            
        
    

    
        
            
                org.apache.maven.plugins
                maven-compiler-plugin
                
                    1.8
                    1.8
                    UTF-8
                
            
            
                org.springframework.boot
                spring-boot-maven-plugin
            
        
    

2.3 配置文件application.properties

spring.application.name=mybatis-plus
# 应用服务 WEB 访问端口
server.port=8080
####数据库连接池###
spring.datasource.url=jdbc:mysql://101.133.227.13:3306/orders_1?useSSL=false&useUnicode=true&characterEncoding=UTF-8
spring.datasource.username=guo
spring.datasource.password=205010guo
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver

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

2.3 添加@MapperScan注解

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

package com.erbadagang.mybatis.plus.mybatisplus;

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

/**
 * @description 启动类
 * @ClassName: MybatisPlusApplication
 * @author: 郭秀志 [email protected]
 * @date: 2020/7/9 10:43
 * @Copyright:
 */
@SpringBootApplication
@MapperScan("com.erbadagang.mybatis.plus.*.mapper")
public class MybatisPlusApplication {

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

}

2.4 业务编码

编写实体类 User.java（此处使用了 Lombok 简化代码）

package com.erbadagang.mybatis.plus.mybatisplus.entity;

import lombok.Data;

/**
 * @description User表实体类
 * @ClassName: User
 * @author: 郭秀志 [email protected]
 * @date: 2020/7/9 14:47
 * @Copyright:
 */
@Data
public class User {
    private Long id;
    private String name;
    private Integer age;
    private String email;
}

编写Mapper类 UserMapper.java

package com.erbadagang.mybatis.plus.mybatisplus.mapper;

import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.erbadagang.mybatis.plus.mybatisplus.entity.User;

/**
 * @description mapper接口，可以进行简单的CRUD。
 * @ClassName: UserMapper
 * @author: 郭秀志 [email protected]
 * @date: 2020/7/9 14:48
 * @Copyright:
 */
public interface UserMapper extends BaseMapper {

}

三、开始使用

添加测试类，进行功能测试：

package com.erbadagang.mybatis.plus.mybatisplus;

import com.erbadagang.mybatis.plus.mybatisplus.entity.User;
import com.erbadagang.mybatis.plus.mybatisplus.mapper.UserMapper;
import org.junit.Assert;
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;

/**
 * @description MP简单测试。
 * @ClassName: MPTest
 * @author: 郭秀志 [email protected]
 * @date: 2020/7/9 14:53
 * @Copyright:
 */
@RunWith(SpringRunner.class)
@SpringBootTest
public class MPTest {

    @Autowired
    private UserMapper userMapper;

    @Test
    public void testSelect() {
        System.out.println(("----- selectAll method test ------"));
        List userList = userMapper.selectList(null);
        Assert.assertEquals(5, userList.size());
        userList.forEach(System.out::println);

        System.out.println(("----- select via ids test ------"));
        userList = userMapper.selectBatchIds(Arrays.asList(1, 5));
        userList.forEach(System.out::println);
    }

}

UserMapper 中的selectList()方法的参数为 MP 内置的条件封装器 Wrapper，所以不填写就是无任何条件。

控制台输出：

----- selectAll method test ------
User(id=1, name=Guo , age=18, [email protected])
User(id=2, name=xiu, age=20, [email protected])
User(id=3, name=zhi, age=28, [email protected])
User(id=4, name=Oliver, age=21, [email protected])
User(id=5, name=Messi, age=24, [email protected])
----- select via ids test ------
User(id=1, name=Guo , age=18, [email protected])
User(id=5, name=Messi, age=24, [email protected])

介绍一下 BaseMapper 接口中的常用方法：

【添加数据：（增）】

    int insert(T entity);              // 插入一条记录
注：
    T         表示任意实体类型
    entity    表示实体对象

【删除数据：（删）】

    int deleteById(Serializable id);    // 根据主键 ID 删除
    int deleteByMap(@Param(Constants.COLUMN_MAP) Map columnMap);  // 根据 map 定义字段的条件删除
    int delete(@Param(Constants.WRAPPER) Wrapper wrapper); // 根据实体类定义的 条件删除对象
    int deleteBatchIds(@Param(Constants.COLLECTION) Collection idList); // 进行批量删除
注：
    id        表示 主键 ID
    columnMap 表示表字段的 map 对象
    wrapper   表示实体对象封装操作类，可以为 null。
    idList    表示 主键 ID 集合（列表、数组），不能为 null 或 empty

【修改数据：（改）】

    int updateById(@Param(Constants.ENTITY) T entity); // 根据 ID 修改实体对象。
    int update(@Param(Constants.ENTITY) T entity, @Param(Constants.WRAPPER) Wrapper updateWrapper); // 根据 updateWrapper 条件修改实体对象
注：
    update 中的 entity 为 set 条件，可以为 null。
    updateWrapper 表示实体对象封装操作类（可以为 null,里面的 entity 用于生成 where 语句）

【查询数据：（查）】

    T selectById(Serializable id); // 根据 主键 ID 查询数据
    List selectBatchIds(@Param(Constants.COLLECTION) Collection idList); // 进行批量查询
    List selectByMap(@Param(Constants.COLUMN_MAP) Map columnMap); // 根据表字段条件查询
    T selectOne(@Param(Constants.WRAPPER) Wrapper queryWrapper); // 根据实体类封装对象 查询一条记录
    Integer selectCount(@Param(Constants.WRAPPER) Wrapper queryWrapper); // 查询记录的总条数
    List selectList(@Param(Constants.WRAPPER) Wrapper queryWrapper); // 查询所有记录（返回 entity 集合）
    List> selectMaps(@Param(Constants.WRAPPER) Wrapper queryWrapper); // 查询所有记录（返回 map 集合）
    List