MyBatisPlus概述

2021-04-05

需要的基础：SSM就可以学习这个了！

为什么要学习它呢？MyBatisPlus 可以节省我们大量工作时间，所有的CRUD代码他都可以自动化完成！

JPA、tk-mapper、MyBatisPlus

偷懒的！

简介

是什么？MyBatis 本来就是简化 JDBC 而生

官网：为简化开发而生

特性

无侵入：只做增强不做改变，引入它不会对现有工程产生影响，如丝般顺滑
损耗小：启动即会自动注入基本 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 操作智能分析阻断，也可自定义拦截规则，预防误操作

快速入门

地址：https://mp.baomidou.com/guide/quick-start.html#初始化工程

使用第三方组件：

导入对应的依赖
研究依赖如何配置
代码如何编写
提高扩展技术能力！

步骤

创建数据库mybatis_plus

创建user表

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)
);
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');
-- 真实开发中，version（乐观锁）、deleted（逻辑删除）、gmt_create、gmt_modified

编写项目，初始化项目！使用 SpringBoot 初始化！

导入依赖

<!--数据库驱动-->
<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
</dependency>
<!--lombok-->
<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
</dependency>
<!--mybatis_plus 是自己开发，并非官方的！-->
<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-boot-starter</artifactId>
    <version>3.0.5</version>
</dependency>

说明：我们使用 mybatis-plus 可以节省我们大量的代码，尽量不要同时导入 mybatis 和 mybatis-plus！版本的差异！

连接数据库！这一步和 mybatis 相同

# mysql 8 驱动不同com.mysql.cj.jdbc.Driver需要增加时区的配置 serverTimeZone=Asia.Shanghai
spring.datasource.username=root
spring.datasource.password=123456
spring.datasource.url=jdbc:mysql://localhost:3306/mybatis?serverTimezone=Asia/Shanghai&useUnicode=true&characterEncoding=utf-8
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver

传统方式pojo-dao（连接mybatis，配置mapper.xml）-service-controller

使用了mybatis-plus 之后

pojo

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

mapper接口

// 在对应的Mapper上面继承基本的类 BaseMapper
@Repository //代表持久层
public interface Usermapper extends BaseMapper {
    //所有的CRUD操作都已经编写完成了
    //你不需要像以前的配置一大堆文件了！
}

注意点，我们需要在主启动类上去扫描我们的mapper包下的所有接口@MapperScan("com.kuang.mapper")
测试类中测试

配置日志

我们所有的 sql 现在是不可见的，我们希望知道它是怎么执行的，所以我们必须要看日志！

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

配置完毕日志之后，后面的学习就需要注意这个自动生成的SQL，你们就会喜欢上 Mybatis-Plus！

CRUD扩展

插入操作

//测试插入
@Test
public void testInsert(){
    User user = new User();
    user.setName("狂神说Java");
    user.setAge(3);
    user.setEmail("27917232@qq.com");

    int result = userMapper.insert(user);//帮我们自动生成id
    System.out.println(result);//受影响的行数
    System.out.println(user);//发现，id会自动回填
}

数据库插入的id默认值为：全局的唯一id

主键生成策略

1
2
3

@TableId(IdType.NONE)默认
     * 用户输入ID
     * 该类型可以通过自己注册自动填充插件进行填充

分布式系统唯一id生成

雪花算法：

snowflake是Twitter开源的分布式ID生成算法，结果是一个long型的ID。其核心思想是：使用41bit作为毫秒数，10bit作为机器的ID（5个bit是数据中心，5个bit的机器ID），12bit作为毫秒内的流水号（意味着每个节点在每毫秒可以产生 4096 个 ID），最后还有一个符号位，永远是0。

可以查看表单的ID生成

/**
 * 数据库ID自增
 */
AUTO(0),
/**
 * 该类型为未设置主键类型
 */
NONE(1),
/**
 * 用户输入ID
 * 该类型可以通过自己注册自动填充插件进行填充
 */
INPUT(2),

/* 以下3种类型、只有当插入对象ID 为空，才自动填充。 */
/**
 * 全局唯一ID (idWorker)
 */
ID_WORKER(3),
/**
 * 全局唯一ID (UUID)
 */
UUID(4),
/**
 * 字符串全局唯一ID (idWorker 的字符串表示)
 */
ID_WORKER_STR(5);

主键自增

我们需要配置主键自增

实体类字段上@TableId(type=IdType.AUTO)
数据库字段一定要是自增的！
再次测试插入即可！

更新操作

//测试更新
@Test
public void  testUpdate(){
    User user = new User();
    //通过条件自动拼接动态sql
    user.setId(6L);
    user.setName("关注公众号：狂神说");
    user.setAge(18);

    //注意：updateById 但是参数是一个对象！
    int i = userMapper.updateById(user);
    System.out.println(i);
}

所有的 sql 都是自动帮你动态配置的！

自动填充

创建时间、修改时间！这些个操作一般都是自动化完成的，我们不希望手动更新！

阿里巴巴开发手册：所有的数据库表：gmt_create、gmt_modified几乎所有的表都要配置上！并且需要自动化！

方式一：数据库级别（工作中不允许修改数据库的）

在表中新增字段create_time，update_time，默认为CURRENT_TIMESTAMP
再次测试插入方法，我们需要先把实体类同步！
1
2
private Date createTime;
private Date updateTime;

方式二：代码级别

删除数据库中的默认值、更新操作！

实体类字段属性上需要增加注解

//字段添加填充内容
@TableField(fill = FieldFill.INSERT)
private Date createTime;
@TableField(fill = FieldFill.INSERT_UPDATE)
private Date updateTime;

编写处理器来处理这个注解即可！

@Slf4j
@Component
public class MyMetaObjectHandler implements MetaObjectHandler {
    //插入时的填充策略
    @Override
    public void insertFill(MetaObject metaObject) {
        log.info("start insert fill.....");
        this.setFieldValByName("createTime",new Date(),metaObject);
        this.setFieldValByName("updateTime",new Date(),metaObject);
    }

    //更新时的填充策略
    @Override
    public void updateFill(MetaObject metaObject) {
        log.info("start insert fill.....");
        this.setFieldValByName("updateTime",new Date(),metaObject);
    }
}

测试插入
测试更新，观察时间即可！

乐观锁

在面试过程中，我们经常参观会被问道乐观锁，悲观锁！这个其实非常简单！

乐观锁：故名思意十分乐观，它总是认为不会出现问题，无论干什么不去上锁！如果出现问题，再次更新值测试

乐观锁：故名思意十分悲观，它总是认为总是出现问题，无论干什么都会上锁！再去操作

我们这里主要讲解乐观锁机制！

取出记录时，获取当前version
更新时，带上这个version
执行更新时， set version = newVersion where version = oldVersion
如果version不对，就更新失败

给数据库增加version字段；

我们实体类加对应的字段

1 2	@Version //乐观锁Version注解 private Integer version;

注册组件

//扫描我们的mapper文件
@MapperScan("com.kuang.mapper")
@EnableTransactionManagement
@Configuration  //配置类
public class MyBatisPlusConfig {
    //注册乐观锁插件
    @Bean
    public OptimisticLockerInterceptor optimisticLockerInterceptor(){
        return new OptimisticLockerInterceptor();
    }
}

测试

查询操作

//测试查询
@Test
public void testSelectById(){
    User user = userMapper.selectById(1L);
    System.out.println(user);
}
//测试批量查询
@Test
public void testSelectBatchIds(){
    List<User> users = userMapper.selectBatchIds(Arrays.asList(1, 2, 3));
    users.forEach(System.out::println);
}

//按条件查询之一 使用map操作
@Test
public void testSelectByMap(){
    HashMap<String, Object> map = new HashMap<>();
    //自定义查询
    map.put("name","狂神说Java");
    map.put("age",3);

    List<User> users = userMapper.selectByMap(map);
    users.forEach(System.out::println);
}

分页查询

分页在网页使用的十分之多！

原始的 limit 进行分页
pageHelper 第三方插件
MP 其实也内置了分页插件！

如何使用

配置拦截器组件即可！

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

直接使用Page对象即可！

@Test
public void testPage(){
    //参数一：当前页
    //参数二：页面大小
    //使用了分页插件之后，所有的分页操作也变得简单了！
    Page<User> page = new Page<>(1, 5);
    userMapper.selectPage(page,null);

    page.getRecords().forEach(System.out::println);
}

删除操作

基本的删除操作

//测试删除
@Test
public void testDeleteById(){
    userMapper.deleteById(1378534644579885060L);
}

//通过id批量删除
@Test
public void test(){
    userMapper.deleteBatchIds(Arrays.asList(1378534644579885058L,1378534644579885059L));
}

//通过map删除
@Test
public void testDeleteMap(){
    HashMap<String, Object> map = new HashMap<>();
    map.put("name","狂神说Java");
    userMapper.deleteByMap(map);
}

我们在工作中回遇到一些问题，逻辑删除！

逻辑删除

物理删除：从数据库中直接移除

逻辑删除：在数据库中没有被移除，而是通过一个变量来让它生效！delete = 0 =>delete = 1

管理员可以查看被删除的记录！防止数据的丢失，类似于回收站

测试一下：

在数据表中增加一个 deleted 字段

实体类中增加属性

//逻辑删除组件!
@Bean
public ISqlInjector sqlInjector(){
    return new LogicSqlInjector();
}

配置！

1
2
3

# 配置逻辑删除
mybatis-plus.global-config.db-config.logic-delete-value=1
mybatis-plus.global-config.db-config.logic-not-delete-value=0

测试删除数据

走的是更新操作，并不是删除操作
查询的时候会自动过滤被逻辑删除的字段

以上的所有CRUD操作及其扩展操作，我们都必须精通掌握！会大大提高工作和写项目的效率！

性能分析插件

我们在平时的开发中，会遇到一些慢 sql。测试！druid…

作用：性能分析拦截器，用于输出每条SQL语句及其执行时间

MP也提供性能分析插件，如果超过这个时间就停止运行！

导入插件

/*
* sql执行效率插件
*/
@Bean
@Profile({"dev","test"})//设置 dev test 环境启动，保证我们的效率
    public PerformanceInterceptor performanceInterceptor(){
    PerformanceInterceptor performanceInterceptor = new PerformanceInterceptor();
    performanceInterceptor.setMaxTime(100);//ms 设置sql执行的最大时间，如果超过了则会报错
    performanceInterceptor.setFormat(true);//是否格式化代码
    return performanceInterceptor;
}

记住，要在SpringBoot中配置环境为dev或者test环境！

测试使用！只要超过规定的时间就会抛出异常

@Test
void contextLoads() {
    //参数是一个Wrapper  条件构造器，这里我们先不用 null
    //查询全部用户
    List<User> users = userMapper.selectList(null);
    users.forEach(System.out::println);
}

使用性能分析插件，可以帮助我们提高效率！

条件构造器

十分重要：Wrapper

我们写一些复杂的 sql 就可以使用它来代替！

测试一

@Test
void contextLoads() {
    //查询name不为空的用户，并且邮箱不为空的用户，年龄大于等于12
    QueryWrapper<User> wrapper = new QueryWrapper<>();
    wrapper
        .isNotNull("name")
        .isNotNull("email")
        .ge("age",12);
    userMapper.selectList(wrapper).forEach(System.out::println);//和我们刚才学习的map对比一下！
}

测试二

@Test
public void test2(){
    //查询名字狂神说
    QueryWrapper<User> wrapper = new QueryWrapper<>();
    wrapper.eq("name","狂神说");
    User user = userMapper.selectOne(wrapper);//查询一个数据，出现多个结果使用List 或者 Map
    System.out.println(user);
}

测试三

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

测试四，记住查看输出的SQL进行分析

@Test
public void test4(){
    //查询年龄在20-30之间的用户
    QueryWrapper<User> wrapper = new QueryWrapper<>();
    //左和右   %e%
    wrapper.notLike("name","e")
        .likeRight("email","t");
    List<Map<String, Object>> maps = userMapper.selectMaps(wrapper);//查询结果数
    maps.forEach(System.out::println);
}

测试五

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

测试六

@Test
public void test6(){
    QueryWrapper<User> wrapper = new QueryWrapper<>();
    //通过id进行排序
    wrapper.orderByDesc("id");

    List<User> users = userMapper.selectList(wrapper);//查询结果数
    users.forEach(System.out::println);
}

其余的测试，可以自己下去多练习！

代码自动生成器

dao、pojo、service、controller都给我自己去编写完成！

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