提高生产力，最全 MyBatisPlus 讲解！

如果你每天还在重复写 CRUD 的 SQL，如果你对这些 SQL 已经不耐烦了，那么你何不花费一些时间来阅读这篇文章，然后对已有的老项目进行改造，必有收获！

一、MP 是什么

MP 全称 Mybatis-Plus ，套用官方的解释便是成为 MyBatis 最好的搭档,简称基友。它是在 MyBatis 的基础上只做增强不做改变，为简化开发、提高效率而生。

1. 三大特性

1）润物无声

只做增强不做改变，引入它不会对现有工程产生影响，如丝般顺滑。

2）效率至上

只需简单配置，即可快速进行单表 CRUD 操作，从而节省大量时间。

3）丰富功能

代码生成、物理分页、性能分析等功能一应俱全。

2. 支持数据库

• mysql 、mariadb 、oracle 、db2 、h2 、hsql 、sqlite 、postgresql 、sqlserver 、presto 、Gauss 、Firebird
• Phoenix 、clickhouse 、Sybase ASE 、 OceanBase 、达梦数据库 、虚谷数据库 、人大金仓数据库 、南大通用数据库

3. 框架结构

实话说，以上这些内容只要你打开官网也能看到，那么我们接下来就先来实际操作一番！

二、MP实战

1. 手摸手式项目练习

1）数据库及表准备

sql 语句：

use test;
CREATE TABLE `student`  (
  `id` int(0) NOT NULL AUTO_INCREMENT,
  `dept_id` int(0) NULL DEFAULT NULL,
  `name` varchar(16) CHARACTER SET utf8mb4 COLLATE utf8mb4_bin NULL DEFAULT NULL,
  `remark` varchar(32) CHARACTER SET utf8mb4 COLLATE utf8mb4_bin NULL DEFAULT NULL,
  PRIMARY KEY (`id`) USING BTREE
) ENGINE = InnoDB AUTO_INCREMENT = 7 CHARACTER SET = utf8mb4 COLLATE = utf8mb4_bin ROW_FORMAT = Dynamic;
-- ----------------------------
-- Records of student
-- ----------------------------
INSERT INTO `student` VALUES (1, 1, '小菜', '关注小菜不迷路！');
INSERT INTO `student` VALUES (2, 2, '小明', '好好学习，天天向上！');

2）pom 依赖

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

<dependency>
    <groupId>org.projectlombokgroupId>
    <artifactId>lombokartifactId>
    <version>1.16.16version>
dependency>

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

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

<dependency>
    <groupId>com.alibabagroupId>
    <artifactId>druidartifactId>
    <version>1.2.1version>
dependency>

<dependency>
    <groupId>junitgroupId>
    <artifactId>junitartifactId>
    <version>4.13.1version>
dependency>

3）配置文件

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/test
    username: root
    password: 123456
    driver-class-name: com.mysql.cj.jdbc.Driver

4）实体类

@Data
@Builder
@TableName("student")
public class User {

    @TableId(type = IdType.AUTO)
    private Integer id;

    private Integer deptId;

    private String name;

    private String remark;
}

5）Mapper

public interface UserMapper extends BaseMapper<User> {}

6）测试类

@RunWith(SpringRunner.class)
@SpringBootTest
public class MapperTest {

    @Autowired
    private UserMapper userMapper;

    @Test
    public void getAll() {
        List users = userMapper.selectList(null);
        users.forEach(System.out::println);
    }
}
/** OUTPUT:
User(id=1, deptId=1, name=小菜, remark=关注小菜不迷路！)
User(id=2, deptId=1, name=小明, remark=好好学习，天天向上！)
**/

小菜结：

在以上的结果，我们可以看到已经打印出了数据库中的全部数据（两条）。而并没有看到平时我们需要写的 mapper.xml 文件，只是用到了 usermapper 中的 selectList() 方法，而 UserMapper 继承了 BaseMapper 这个接口，这个接口便是 MybatisPlus 提供给我们的，我们再来看下这个接口给我们提供了哪些方法。

2.  CRUD 基操

1）insert

@Test
public void insert() {
    //这里使用了 lombok 中的建造者模式构建对象
    User user = User.builder().deptId(1).name("小华").remark("小华爱学习").build();
    int insertFlag = userMapper.insert(user);
    log.info("插入影响行数,{} | 小华的ID: {}", insertFlag, user.getId());
}
/** OUTPUT:
插入影响行数,1 | 小华的ID: 8
**/

可以看到我们不仅插入了数据，而且还获取到了插入数据的ID，但是值得注意的是这里的 ID 虽然是自增的，但并非是 MP 默认的 ID生成策略，而是我们在实体类中指定的：

在 MP 中支持的主键生成策略有以下几种：

我们既然已经看到了 @TableId 这个注解，那我们再来关注一个常用注解 @TableField

从注解名上我们就可以看出，@TableId 是用来标记主键 ID 的，而 @TableField 是用来标记其他字段的。

可以看得出来这个注解中存在的值还是比较多的，下面介绍几个常用的值：

• value

用于解决字段名不一致问题和驼峰命名，比如实体类中属性名为 remark，但是表中的字段名为 describe ，这个时候就可以使用 @TableField(value="describe") 来进行转换。驼峰转换如果在全局中有配置驼峰命名，这个地方可不写。

• exist

用于在数据表中不存在的字段，我们可以使用 @TableField(exist = false) 来进行标记

• condition

用在预处理 WHERE 实体条件自定义运算规则，比如我配置了 @TableField(condition = SqlCondition.LIKE)，输出 SQL 为：select 表 where name LIKE CONCAT('%',值,'%')，其中 SqlCondition 值如下：

• update

用在预处理 set 字段自定义注入，比如我配置了 @TableField(update = "%s+1")，其中 %s 会填充字段，输出 SQL 为：update 表名 set 字段 = 字段+1 where 条件

• select

用于是否查询时约束，如果我们有个字段 remark 是 text 类型的，查询的时候不想查询该字段，那么就可以使用 @TableField(select = false) 来约束查询的时候不查询该字段

2）update

MybatisPlus 的更新操作存在两种：

int updateById(Param("et") T entity);

int update(@Param("et") T entity, @Param("ew") Wrapper updateWrapper);

根据 ID 更新

@Test
public void update() {
    User user = User.builder().id(3).name("小华").remark("小华爱玩游戏").build();
    userMapper.updateById(user);
}
/** 更新结果:
User(id=3, deptId=1, name=小华, remark=小华爱玩游戏)
**/

根据条件更新

@Test
public void update() {
    UpdateWrapper updateWrapper = new UpdateWrapper<>();
    updateWrapper.eq("name","小华").set("remark","小华爱下棋");
    userMapper.update(null, updateWrapper);
}
/** 更新结果:
User(id=3, deptId=1, name=小华, remark=小华爱下棋)
**/

我们也可以将要更新的条件放进 user 对象 里面：

@Test
public void update() {
    UpdateWrapper updateWrapper = new UpdateWrapper<>();
    updateWrapper.eq("name","小华");
    User user = User.builder().remark("小华爱游泳").build();
    userMapper.update(user, updateWrapper);
}
/** 更新结果:
User(id=3, deptId=1, name=小华, remark=小华爱游泳)
**/

3）delete

在 MybatisPlus 中删除的方式相对于更新多，总共有四种：

int deleteById(Serializable id);

int deleteByMap(@Param("cm") Map columnMap);

int delete(@Param("ew") Wrapper wrapper);

int deleteBatchIds(@Param("coll") Collection idList);

根据 ID 删除

@Test
public void deleteById() {
    userMapper.deleteById(3);
}
/** SQL语句：
DELETE FROM student WHERE id = 3;
**/

根据 Map 删除

@Test
public void deleteByMap() {
    HashMap columnMap = new HashMap<>();
    columnMap.put("name","小华");
    columnMap.put("remark","小华爱游泳");
    userMapper.deleteByMap(columnMap);
}
/** SQL语句：
DELETE FROM student WHRE name = '小华' AND remark = '小华爱游泳';
**/

根据 Wrapper 删除

@Test
public void delete() {
    UpdateWrapper wrapper = new UpdateWrapper<>();
    wrapper.eq("remark","小华爱下棋");
    userMapper.delete(wrapper);
}
/** SQL语句：
DELETE FROM student WHRE remark = '小华爱下棋';
**/

根据 Wrapper 删除还有另外一种方式，直接将实体类放入 Wrapper 中包装：

@Test
public void delete() {
    User user = User.builder().remark("小华爱下棋").build();
    UpdateWrapper wrapper = new UpdateWrapper<>(user);
    userMapper.delete(wrapper);
}
/** SQL语句：
DELETE FROM student WHRE remark = '小华爱下棋';
**/

根据 ID 批量删除

@Test
public void deleteBatchIds() {
    List idList = new ArrayList<>();
    idList.add(4);
    idList.add(7);
    userMapper.deleteBatchIds(idList);
}
/** SQL语句：
DELETE FROM student WHERE id In (4,7)
**/

4）select

查询操作在我们开发中是最经常用到的，也是重中之重。MybatisPlus 中支持查询的方法也比较多，如下：

T selectById(Serializable id);

List selectBatchIds(@Param("coll") Collection idList);

List selectByMap(@Param("cm") Map columnMap);

T selectOne(@Param("ew") Wrapper queryWrapper);

Integer selectCount(@Param("ew") Wrapper queryWrapper);

List selectList(@Param("ew") Wrapper queryWrapper);

List> selectMaps(@Param("ew") Wrapper queryWrapper);

List