MyBatisPlus笔记

2021-04-21 本文已影响0人 Raral

MyBatisPlus概述

需要的基础：把我的MyBatis,Spring, SpringMVC就可以学习这个了！简化我们的CRUD操作

愿景

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

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

特性

无侵入：只做增强不做改变，引入它不会对现有工程产生影响，如丝般顺滑
损耗小：启动即会自动注入基本 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#%E5%88%9D%E5%A7%8B%E5%8C%96%E5%B7%A5%E7%A8%8B

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

步骤

创建数据库 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)
);   
--真实开发中，version(乐观锁)，deleted(逻辑删除)，crt_time,crt_by,upd_time,upd_by--
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');

编写项目

a. 导入依赖

  <!--mybatis-plus-->
            <dependency>
                <groupId>com.baomidou</groupId>
                <artifactId>mybatis-plus-boot-starter</artifactId>
                <version>${mybatis-plus.version}</version>
            </dependency>
            <dependency>
                <groupId>com.baomidou</groupId>
                <artifactId>mybatis-plus-extension</artifactId>
                <version>${mybatis-plus.version}</version>
            </dependency

b. 配置

spring:
    datasource:
        type: com.alibaba.druid.pool.DruidDataSource
        driverClassName: com.mysql.cj.jdbc.Driver
        druid:
            # 主库数据源
            master:
                url: jdbc:mysql://127.0.0.1:3306/ry-vue?useUnicode=true&characterEncoding=utf8&zeroDateTimeBehavior=convertToNull&useSSL=true&serverTimezone=GMT%2B8&autoReconnect=true
                username: root
                password: root
            # 从库数据源
            slave:
                # 从数据源开关/默认关闭
                enabled: false
                url: 
                username: 
                password:

c. 传统方式pojo-dao(连接mybatis,配置mapper.xml)-service-controller

c. 使用mybatis-plus之后

pojo
mapper
使用

mybatisPlus相关

基于BaseMapper: 自动有 CRUD的操作方法，

userMapper.insert(user),

updateById(user),
主键生成策略：https://www.cnblogs.com/haoxinyue/p/5208136.html
- snowflake是Twitter开源的分布式ID生成算法，结果是一个long型的ID。其核心思想是：使用41bit作为毫秒数，10bit作为机器的ID（5个bit是数据中心，5个bit的机器ID），12bit作为毫秒内的流水号（意味着每个节点在每毫秒可以产生 4096 个 ID），最后还有一个符号位，永远是0。具体实现的代码可以参看https://github.com/twitter/snowflake。

自动填充(插入和更新)

创建时间，修改时间，创建人，更新人，我们不需要手动更新！
所有的数据库中表：gmt_create,gmt_modified几乎所有表都要配置上，而且自动化！

方式一：数据库级别(工作中不允许这样操作)

在表中新增字段，create_time, update_time

[图片上传失败...(image-a5703d-1618998579177)]

再次测试插入方法，我们需要先把实体类同步！

   @TableId//默认是雪花算法
    private Long id;
    private String name;
    private Integer age;
    private String email;
    private Date createTime;
    private Date updateTime;

方式二：代码级别(推荐使用)

 a. 删除数据库默认值

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

  @TableId//默认是雪花算法
    private Long id;
    private String name;
    private Integer age;
    private String email;

    @TableField(fill = FieldFill.INSERT)//插入自动填充
    private Date createTime;
    @TableField(fill = FieldFill.UPDATE)//更新自动填充
    private Date updateTime;

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

public class CreateAndUpdateMetaObjectHandler implements MetaObjectHandler {
 @Override
 public void insertFill(MetaObject metaObject) {
     //region 处理创建人信息
     Object createBy = this.getFieldValByName("createBy", metaObject);
     Object createTime = this.getFieldValByName("createTime", metaObject);
     if (createBy == null) {
         createBy = SecurityUtils.getUsername();
         this.setFieldValByName("createBy", createBy, metaObject);
     }
     if (createTime == null) {
         createTime = new Date();
         this.setFieldValByName("createTime", createTime, metaObject);
     }
     //endregion
     //region 处理修改人信息
     Object updateBy = this.getFieldValByName("updateBy", metaObject);
     Object updateTime = this.getFieldValByName("updateTime", metaObject);
     if (updateBy == null) {
         updateBy = createBy;
         this.setFieldValByName("updateBy", updateBy, metaObject);
     }
     if (updateTime == null) {
         updateTime = createTime;
         this.setFieldValByName("updateTime", updateTime, metaObject);
     }
     //endregion
 }

 @Override
 public void updateFill(MetaObject metaObject) {
     //region 处理修改人信息
     Object updateBy = this.getFieldValByName("updateBy", metaObject);
     Object updateTime = this.getFieldValByName("updateTime", metaObject);
     if (updateBy == null) {
         updateBy = SecurityUtils.getUsername();
         this.setFieldValByName("updateBy", updateBy, metaObject);
     }
     if (updateTime == null) {
         updateTime = new Date();
         this.setFieldValByName("updateTime", updateTime, metaObject);
     }
     //endregion
 }

 @Override
 public boolean openInsertFill() {
     return true;
 }

 @Override
 public boolean openUpdateFill() {
     return true;
 }
}

乐观锁

a. 在对应表里面加入version字段

b. 实体类添加注解

  @TableId//默认是雪花算法
    private Long id;
    private String name;
    private Integer age;
    private String email;

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

    @TableField(fill = FieldFill.INSERT)//插入自动填充
    @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
    private Date createTime;

    @TableField(fill = FieldFill.UPDATE)//更新自动填充
    @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
    private Date updateTime;

c. 注册组件/配置拦截器

 /**
  * 乐观锁插件
  * https://baomidou.com/guide/interceptor-optimistic-locker.html
  */
 public OptimisticLockerInnerInterceptor optimisticLockerInnerInterceptor() {
     return new OptimisticLockerInnerInterceptor();
 }

查询操作

selectById(1)：根据一个id查询

selectBatchIds(Arrays.asList(1,2,3)): 根据查询多个id

        //1.查询所有
//        return testUserMapper.selectList(null);
        //2. 根据多个id查询
//        return testUserMapper.selectBatchIds(Arrays.asList(1L,2L));
        //3. 条件查询 ；这些查询全等
        HashMap<String, Object> map = new HashMap<>();
        //自定义查询
        map.put("name", "张三");
        List<TestUser> testUsers = testUserMapper.selectByMap(map);

分页查询

原始的limit
pageHelper第三方插件（若依框架）
MP其实内置了分页插件

MP内置如何使用？

配置拦截器

/**
  * 分页插件，自动识别数据库类型
  * https://baomidou.com/guide/interceptor-pagination.html
  */
 public PaginationInnerInterceptor paginationInnerInterceptor() {
     PaginationInnerInterceptor paginationInnerInterceptor = new PaginationInnerInterceptor();
     // 设置数据库类型为mysql
     paginationInnerInterceptor.setDbType(DbType.MYSQL);
     // 设置最大单页限制数量，默认 500 条，-1 不受限制
     paginationInnerInterceptor.setMaxLimit(-1L);
     return paginationInnerInterceptor;
 }

2. 使用

   ```java
    //4. 分页查询
           Page<TestUser> page = new Page<>(1, 2);
           Page<TestUser> userPage = testUserMapper.selectPage(page, null);
           userPage.getRecords().forEach(System.out::println);
           userPage.getTotal();
   ```

删除操作

//根据id删除
        testUserMapper.deleteById(id);
        //根据ids删除
        testUserMapper.deleteBatchIds(Arrays.asList(3,4));
        //通过条件添加删除
        HashMap<String, Object> map = new HashMap<>();
        map.put("name", "xxx");
        testUserMapper.deleteByMap(map);

逻辑删除（本质是更新操作）

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

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

再表中添加逻辑字段 deleted 默认值0

更新实体类和注解

  @TableId//默认是雪花算法
    private Long id;
    private String name;
    private Integer age;
    private String email;

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

    @TableField(fill = FieldFill.INSERT)//插入自动填充
    @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
    private Date createTime;

    @TableField(fill = FieldFill.UPDATE)//更新自动填充
    @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
    private Date updateTime;

    @TableLogic//逻辑删除
    private Integer deleted;

添加配置

  /**
   * sql注入器配置/逻辑删除注解
   * https://baomidou.com/guide/sql-injector.html
   */
  @Bean
  public ISqlInjector sqlInjector() {
      return new DefaultSqlInjector();
  }

   # 逻辑已删除值
      logicDeleteValue: 2
      # 逻辑未删除值
      logicNotDeleteValue: 0

测试逻辑删除；删除成功后，查询操作会自动过滤deleted=0

条件构造器

十分重要：Wrapper

我们写一些复杂sql，针对查询的；但是如果是多表查询还是喜欢写mapper.xml文件

MyBatisPlus笔记

MyBatisPlus概述

特性

快速入门

步骤

mybatisPlus相关

条件构造器

猜你喜欢

热点阅读