Mybatis-Plus学习

简介

简单的介绍

• 官网：http://mp.baomidou.com/
• MyBatis-Plus（简称 MP）是一个 MyBatis 的增强工具，在 MyBatis 的基础上只做增强不做改变，为简化开发、提高效率而生。

特性

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

入门案例

• 在数据库建表：

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

搭建环境

1. 创建一个SpringBoot工程
2. 在pom.xml中加入依赖

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

        <!--mysql-->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
        </dependency>

        <!--lombok用来简化实体类-->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>
    </dependencies>

3. 安装lombok

   • 点击setting
     

   • 选择plugin并且下载lombok
     

   • 重启就能使用

4. 在application.propertiesp配置数据库

#mysql数据库连接 mysql5以下或者springboot2.1以下的配置
spring.datasource.driver-class-name=com.mysql.jdbc.Driver
spring.datasource.url=jdbc:mysql://localhost:3306/mybatisplus?serverTimezone=GMT%2B8
spring.datasource.username=root
spring.datasource.password=123456

#mysql数据库连接 mysql8以上或者springboot2.1以上的配置
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.url=jdbc:mysql://localhost:3306/mybatisplus?serverTimezone=GMT%2B8
spring.datasource.username=root
spring.datasource.password=123456

5. 配置查看sql输出日志

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

• 注意：
  • 这里的 url 使用了 ?serverTimezone=GMT%2B8 后缀，因为Spring Boot 2.1 集成了 8.0版本的jdbc驱动，这个版本的 jdbc 驱动需要添加这个后缀，否则运行测试用例报告如下错误：java.sql.SQLException: The server time zone value 'Öйú±ê׼ʱ¼ä' is unrecognized or represents more
  • 这里的 driver-class-name 使用了 com.mysql.cj.jdbc.Driver ，在 jdbc 8 中 建议使用这个驱动，之前的 com.mysql.jdbc.Driver 已经被废弃，否则运行测试用例的时候会有 WARN 信息

简单案例

1. 在 Spring Boot 启动类中添加 @MapperScan 注解，扫描 Mapper 文件夹
2. 创建一个实体类

import lombok.Data;

@Data//lombok的简化代码
public class User {

    private Long id;
    private String name;
    private Integer age;
    private String email;

}

3. 创建一个mapper接口

import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.lwb.mybatisplus.entity.User;
import org.springframework.stereotype.Repository;

@Repository
public interface UserMapper extends BaseMapper<User> {
}

4. 在test中测试
   • 注意：IDEA在 userMapper 处报错，因为找不到注入的对象，因为类是动态创建的，但是程序可以正确的执行。为了避免报错，可以在 dao 层 的接口上添加 @Repository 注

@SpringBootTest
class MybatisplusApplicationTests {

    @Autowired
    private UserMapper userMapper;

    @Test
    void findAll() {
        List<User> users = userMapper.selectList(null);
        users.forEach(System.out::println);
    }

}

5. 结果：
   

CRUD操作

insert

1. 简单的insert操作

    @Test
    void insert() {
        User user = new User();
        user.setName("zjf");
        user.setAge(22);
        user.setEmail("3172494600@qq.com");

        int insert = userMapper.insert(user);
        System.out.println(insert);
    }

• 结果：
  
• 注意：
  • id是myabtisplus自动生成19位的值，不需要设置
  • 返回值是插入多少条数据

2. 主键生成策略
   • 不需要策略：
     • 在实体类上的主键上添加注解@TableId(type = IdType.NONE)
   • 数据库自动增长： AUTO INCREMENT
     • 缺点：如果采取的是分表的话，想要创建一个新的表就需要获取上一张表最后的id，再创建表。
     • 在实体类上的主键上添加注解@TableId(type = IdType.AUTO)
   • UUID：每次都会生成一个唯一的，随机的值
     • 缺点：排序不方便
     • 在实体类上的主键上添加注解@TableId(type = IdType.UUID)
   • redis生成ID
   • MybatisPlus自带策略：雪花算法生成的ID
     • 在实体类上的主键上添加注解@TableId(type = IdType.ID_WORKER)，如果id类型是数字类型就使用这个
     • 在实体类上的主键上添加注解@TableId(type = IdType.ID_WORKER_STR)，如果id类型是字符串类型就使用这个

update

1. 简单的update操作：

    @Test
    void update() {
        User user = new User();
        user.setId(1L);
        user.setAge(22);
        int update = userMapper.updateById(user);
        System.out.println(update);
    }

• 结果：
  

自动填充

• 项目中经常会遇到一些数据，每次都使用相同的方式填充，例如记录的创建时间，更新时间等。我们可以使用MyBatis Plus的自动填充功能，完成这些字段的赋值工作：

1. 第一步在User表中添加datetime类型的新的字段 create_time、update_time
2. 第二步实体上添加注解

@Data
public class User {
    @TableField(fill = FieldFill.INSERT)
    private Date createTime;
    //@TableField(fill = FieldFill.UPDATE)
    @TableField(fill = FieldFill.INSERT_UPDATE)
    private Date updateTime;
}

3. 第三步实现元对象处理器接口

@Component
public class MyMetaObjectHandler implements MetaObjectHandler {
    private static final Logger LOGGER = LoggerFactory.getLogger(MyMetaObjectHandler.class);
    @Override
    public void insertFill(MetaObject metaObject) {
        LOGGER.info("start insert fill ....");
        this.setFieldValByName("createTime", new Date(), metaObject);
        this.setFieldValByName("updateTime", new Date(), metaObject);
    }
    @Override
    public void updateFill(MetaObject metaObject) {
        LOGGER.info("start update fill ....");
        this.setFieldValByName("updateTime", new Date(), metaObject);
    }
}

乐观锁

• 主要解决丢失更新问题，也就是当要更新一条记录的时候，希望这条记录没有被别人更新，也就是说实现线程安全的数据更新。
• 乐观锁的实现方式：
  • 取出记录时，获取当前version
  • 更新时，带上这个version
  • 执行更新时， set version = newVersion where version = oldVersion
  • 如果version不对，就更新失败
• 实现乐观锁：

  • 第一步在表中添加版本号字段

  • 第二步在实体类上添加字段并添加 @Version 注解
    

  • 第三步在元对象处理器接口添加version的insert默认值
    

  • 第四步在创建一直配置类，并且在 MybatisPlusConfig 中注册 Bean
    

deleted

1. 根据ID删除

@Test
public void testDeleteById(){
    int result = userMapper.deleteById(8L);
    System.out.println(result);
}

2. 批量删除

    @Test
    public void testDeleteBatchIds() {
        int result = userMapper.deleteBatchIds(Arrays.asList(8, 9, 10));
        System.out.println(result);
    }

3. 简单的条件删除

@Test
public void testDeleteByMap() {
    HashMap<String, Object> map = new HashMap<>();
    map.put("name", "Helen");
    map.put("age", 18);
    int result = userMapper.deleteByMap(map);
    System.out.println(result);
}

逻辑删除

• 逻辑删除：假删除，将对应数据中代表是否被删除字段状态修改为“被删除状态”，之后在数据库中仍旧能看到此条数据记录
• 物理删除：真实删除，将对应数据从数据库中删除，之后查询不到此条被删除数据
• 逻辑删除的实现：

1. 第一步数据库中添加 deleted字段
2. 第二步实体类添加deleted 字段
   • 并加上 @TableLogic 注解 和 @TableField(fill = FieldFill.INSERT) 注解

4. 第三步元对象处理器接口添加deleted的insert默认值
   

5. 第四步application.properties 加入配置：此为默认值，如果你的默认值和mp默认的一样,该配置可无
   

6. 第五步在 MybatisPlusConfig 中注册 Bean
   

7. 第六步测试

   • 测试后发现，数据并没有被删除，deleted字段的值由0变成了1
   • 测试后分析打印的sql语句，是一条update
   • 注意：被删除数据的deleted 字段的值必须是 0，才能被选取出来执行逻辑删除的操作

select

1. 简单查询根据ID查询

    @Test
    void findById() {
        User user = userMapper.selectById(1L);
        System.out.println(user.toString());
    }

2. 通过多个id批量查询

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

3. 简单的条件查询

    @Test
    void findByMap() {
        HashMap<String, Object> map = new HashMap<>();
        map.put("name", "Helen");
        map.put("age", 18);
        List<User> users = userMapper.selectByMap(map);
        users.forEach(System.out::println);
    }

分页

• MyBatis Plus自带分页插件，只要简单的配置即可实现分页功能

1. 创建配置类：此时可以删除主类中的 @MapperScan 扫描注解
2. 添加分页插件

@Configuration
@MapperScan("com.lwb.mybatisplus.mapper")
public class MybatisPlusConfig {

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

3. 测试：new一个Page对象，并且传入当前页和每页显示的记录数两个参数

    @Test
    void findForPage() {
        //1.创建一个Page对象，并且传入两个参数（当前页，每页的记录数）
        Page page = new Page(1,10);
        //2.调用mp的分页方法
        userMapper.selectPage(page,null);
        //3.获取page对象的数据，每页的list集合
        page.getRecords().forEach(System.out::println);

        //获取当前页
        System.out.println(page.getCurrent());
        //获取每页的显示记录数
        System.out.println(page.getSize());
        //获取总记录数
        System.out.println(page.getTotal());
        //获取总页数
        System.out.println(page.getPages());

        //是否有下一页
        System.out.println(page.hasNext());
        //是否有上一页
        System.out.println(page.hasPrevious());

    }

• 结果：

性能分析

• 性能分析拦截器，用于输出每条 SQL 语句及其执行时间，SQL 性能执行分析,开发环境使用，超过指定时间，停止运行。有助于发现问题
• 使用性能分析的步骤：

1. 在配置类中配置：
   • 参数：maxTime： SQL 执行最大时长，超过自动停止运行，有助于发现问题。
   • 参数：format： SQL是否格式化，默认false。

/**
 * SQL 执行性能分析插件
 * 开发环境使用，线上不推荐。 maxTime 指的是 sql 最大执行时长
 */
    @Bean
    @Profile({"dev","test"})// 设置 dev test 环境开启
    public PerformanceInterceptor performanceInterceptor() {
        PerformanceInterceptor performanceInterceptor = new PerformanceInterceptor();
        performanceInterceptor.setMaxTime(100);//ms，超过此处设置的ms则sql不执行
        performanceInterceptor.setFormat(true);
        return performanceInterceptor;
    }

2. Spring Boot 中设置dev环境

#环境设置：dev、test、prod
spring.profiles.active=dev

3. 测试结果：
   

条件构造器Wrapper

• 下面演示：

ge、gt、le、lt、isNull、isNotNull

• sql语句：UPDATE user SET deleted=1 WHERE deleted=0 AND name IS NULL AND age >= ? AND email IS NOT NULL

eq、ne

• sql语句：SELECT id,name,age,email,create_time,update_time,deleted,version FROM user WHERE deleted=0 AND name = ?

between、notBetween

• sql语句：SELECT COUNT(1) FROM user WHERE deleted=0 AND age BETWEEN ? AND ?

allEq

• sql语句：SELECT id,name,age,email,create_time,update_time,deleted,version FROM user WHERE deleted=0 AND name = ? AND id = ? AND age = ?

like、notLike、likeLeft、likeRight

• sql语句：SELECT id,name,age,email,create_time,update_time,deleted,version FROM user WHERE deleted=0 AND name NOT LIKE ? AND email LIKE ?

in、notIn、inSql、notinSql、exists、notExists

• sql语句：SELECT id,name,age,email,create_time,update_time,deleted,version FROM user WHERE deleted=0 AND id IN (select id from user where id < 3)

or、and

• 注意：这里使用的是 UpdateWrapper ，不调用or则默认为使用 and 连
  
• sql语句：UPDATE user SET name=?, age=?, update_time=? WHERE deleted=0 AND name LIKE ? OR age BETWEEN ? AND ?

嵌套or、嵌套and

• sql语句：UPDATE user SET name=?, age=?, update_time=? WHERE deleted=0 AND name LIKE ? OR ( name = ? AND age <> ? )

orderBy、orderByDesc、orderByAsc

• sql语句：SELECT id,name,age,email,create_time,update_time,deleted,version FROM user WHERE deleted=0 ORDER BY id DESC

last

• sql语句：SELECT id,name,age,email,create_time,update_time,deleted,version FROM user WHERE deleted=0 limit 1

set、setSql

• sql语句：UPDATE user SET age=?, update_time=?, name=?, email = '123@qq.com' WHERE deleted=0 AND name LIKE ?