【Mybatis-Plus框架学习】专栏总集篇

基本概念：

图标：

---

简介：

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

---

愿景：

成为 MyBatis 最好的搭档，就像魂斗罗中的 1P、2P，基友搭配，效率翻倍

---

特性：

• 无侵入：只做增强不做改变，引入它不会对现有工程产生影响，如丝般顺滑
• 损耗小：启动即会自动注入基本 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 、Gauss 、Firebird
• Phoenix 、clickhouse 、Sybase ASE 、 OceanBase 、达梦数据库 、虚谷数据库 、人大金仓数据库 、南大通用数据库

---

框架 结构：

---

首先，当然是 导入Maven依赖：

依赖导入：

<!-- mybatis-plus -->
<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-boot-starter</artifactId>
    <version>3.4.0</version>
</dependency>

在这里，本人要说明一点：

由于 Mybatis-Plus框架 内置了 Mybatis框架，
因此，我们在使用 Mybatis-Plus框架 时，就不要手动导入 Mybatis框架 的 依赖 了

---

那么，讲了那么多，现在本人来给出一个案例，来展示下 基本使用方式：

基本使用 展示：

建库/表 Sql：

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

DELETE FROM user;

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

---

配置 数据库连接参数：

# mysql 连接参数
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.url=jdbc:mysql://localhost:3306/mybatis_plus?serverTimezone=Asia/Shanghai&useUnicode=true&characterEncoding=UTF-8&useSSL=false
spring.datasource.username=root
spring.datasource.password=123456

---

配置 数据库连接参数：

# mysql 连接参数
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.url=jdbc:mysql://localhost:3306/mybatis_plus?serverTimezone=Asia/Shanghai&useUnicode=true&characterEncoding=UTF-8&useSSL=false
spring.datasource.username=root
spring.datasource.password=123456

---

pojo层 搭建 —— User类：

package edu.youzg.pojo;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
    private Long id;
    private String name;
    private Integer age;
    private String email;
}

---

在使用 Mybatis-Plus 的过程中，最重要的就是 mapper层 的编写，
因为 Mybatis-Plus 主要就是简化 mapper层 而创建的：

mapper层 搭建 —— UserMapper接口：

package edu.youzg.mapper;


import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import edu.youzg.pojo.User;
import org.apache.ibatis.annotations.Mapper;
import org.springframework.stereotype.Repository;

// 让对应的mapper 继承 BaseMapper<目标pojo>
// 基本的CRUD就已经完成了
@Repository
@Mapper
public interface UserMapper extends BaseMapper<User> {
}

---

那么，现在本人就来给出一个 测试类，来测试下上面编写的代码的功能 是否 达到了我们的目的

本人就以 条件查询 为例：

测试类：

package edu.youzg;

import edu.youzg.mapper.UserMapper;
import edu.youzg.pojo.User;
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 MybatisPlusDemoApplicationTests {

    // 继承了BaseMapper，几乎所有基本的CRUD就已经完成了
    @Autowired
    private UserMapper mapper;

    @Test
    void contextLoads() {
        // 参数：查询条件
        List<User> users = mapper.selectList(null);
        for (User user : users) {
            System.out.println(user);
        }
    }

}

---

现在，本人来展示下 运行结果：

运行结果：

可以看到：条件查询功能 没有问题！

---

但是，在我们之前的学习过程中，对 sql日志 的 重要性 深有体会！
现在，本人就来讲解下 Mybatis-Plus 的 sql日志 如何配置：

日志 配置：

首先，本人就来讲解下 配置格式：

配置格式：

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

---

Mybatis-Plus 提供了 很多 日志实现类，
那么，本人就来展示下 这些 实现类：

日志 实现类：

(注意：log4j、log4j2、slf4j 均需要导入相应的 Maven依赖)

---

那么，本人就在这里 就不进行配置了，
直接使用 StdOutImpl ，在 控制台 显示 日志内容

还是运行上面的测试类：

运行结果：

---

那么，在了解了 基本使用 之后，
现在，本人就来细说下 CRUD操作 的知识点：

CRDU 扩展：

插入操作：

请关注本人博文 —— 《【Mybatis-Plus框架学习】插入操作 详解》

---

更新操作：

请关注本人博文 —— 《【Mybatis-Plus框架学习】更新操作 详解》

---

查询操作：

请关注本人博文 —— 《【Mybatis-Plus框架学习】查询操作 详解》

---

删除操作：

请关注本人博文 —— 《【Mybatis-Plus框架学习】删除操作 详解》

---

性能分析 插件：

作用：

用于 输出 每条sql语句 及 该语句的执行之间

本来我们是可以通过 配置 PerformanceInterceptor 对象，来实现 性能分析 的

但是，在3.4.0以上的版本中，已经 不再支持 该插件 了

所以我们还是用 Druid连接池 的 性能分析插件 来进行 分析吧

---

条件构造器（Wapper）:

警告：

不支持以及不赞成在 RPC 调用中把 Wrapper 进行传输

• wrapper 很重
• 传输 wrapper 可以类比为你的 controller 用 map 接收值(开发一时爽,维护火葬场)
• 正确的 RPC 调用姿势是写一个 DTO 进行传输,被调用方再根据 DTO 执行相应的操作
• 我们拒绝接受任何关于 RPC 传输 Wrapper 报错相关的 issue 甚至 pr

---

种类：

• allEq
• eq
• ne
• gt
• ge
• lt
• le
• between
• notBetween
• like
• notLike
• likeLeft
• likeRight
• isNull
• isNotNull
• in
• notIn
• inSql
• notInSql
• groupBy
• orderByAsc
• orderByDesc
• orderBy
• having
• func
• or
• and
• nested
• apply
• last
• exists
• notExists

---

使用展示：

@Test
void conditionalConstructorTest() {
    // 查询name不为空的用户，并且邮箱不为空的用户，年龄大于等于12
    QueryWrapper<User> wrapper = new QueryWrapper<>();
    wrapper
            .isNotNull("name")
            .isNotNull("email")
            .ge("age", 666);
    mapper.selectList(wrapper).forEach(System.out::println);
}

那么，本人来展示下 运行结果：

---

自定义 代码生成器：

基本概念：

AutoGenerator 是 MyBatis-Plus 的代码生成器，
通过 AutoGenerator 可以快速生成 Entity、Mapper、Mapper XML、Service、Controller 等各个模块的代码，
极大的提升了开发效率

用一句话来 概括：

dao、pojo、service、controller 层 的代码都根据 数据库 的 指定表 的内容，自动编写完成！

---

在我们使用 Mybatis-Plus框架 实现 代码生成器 之前，需要导入 相应的 Maven依赖：

依赖 导入：

<!-- mybatis-plus generator -->
<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-generator</artifactId>
    <version>3.4.0</version>
</dependency>
<dependency>
    <groupId>org.apache.velocity</groupId>
    <artifactId>velocity-engine-core</artifactId>
    <version>2.2</version>
</dependency>

---

那么，现在本人就来通过一个例子，展示下 自定义代码生成器 的 基本模板：

基本 模板：

基本模板

---

官方文档：

若同学们还对于Mybatis-Plus框架的基本知识点抱有疑问，请访问下面的官方文档链接：

官方文档 链接：
https://baomidou.com/guide/