【博学谷学习记录】超强总结,用心分享|Java使用SpringBoot整合MybatisPlus

112 阅读8分钟
  1. 创建新模块,选择Spring初始化,并配置模块相关基础信息

  1. 选择当前模块需要使用的技术集(仅保留JDBC)

  1. 手动添加mp起步依赖
<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-boot-starter</artifactId>
    <version>3.5.2</version>
</dependency>
  1. 设置jdbc参数(application.yml)
spring:
  datasource:
    driver-class-name: com.mysql.cj.jdbc.Driver
    url: jdbc:mysql:///ssm_db?useSSL=false
    username: root
    password: ****
    type: com.alibaba.druid.pool.DruidDataSource
  1. 制作实体类与表结构(类名与表名对应,属性名与字段名对应)
CREATE TABLE `user` (
  `id`        bigint(20) NOT NULL AUTO_INCREMENT COMMENT '编号' ,
  `name`      varchar(32) CHARACTER SET utf8 COLLATE utf8_general_ci NOT NULL COMMENT '用户名' ,
  `password`  varchar(32) CHARACTER SET utf8 COLLATE utf8_general_ci NOT NULL COMMENT '密码' ,
  `age`       int(3) NOT NULL COMMENT '龄年' ,
  `tel`       varchar(32) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL COMMENT '电话' ,
  PRIMARY KEY (`id`)
)
public class User {
    private Long id;
    private String name;
    private String password;
    private Integer age;
    private String tel;
}
  1. 定义数据接口,继承BaseMapper
@Mapper
public interface UserDao extends BaseMapper<User> {
}
  1. 测试功能

MP概述

  • MyBatisPlus(简称MP)是基于MyBatis框架基础上开发的增强型工具,旨在简化开发,提高效率
  • 官网mp.baomidou.com/

MP特性

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

标准数据层CRUD开发

lombok

  • Lombok,一个java类库,提供了一组注解,简化POJO实体类开发
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.18.12</version>
<scope>provided</scope>
</dependency>

常用注解:@Data

作用:为当前实体类在编译器设置对应的get/set方法,构造方法,toString,

hashCode方法,equals方法

MP分页查询功能

  1. 设置分页拦截器作为Spring管理的bean
@Configuration
public class MpCongfig {
    @Bean
    public MybatisPlusInterceptor pageInterceptor(){
        MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
        interceptor.addInnerInterceptor(new PaginationInnerInterceptor());
        return interceptor;
    }
}
  1. 执行分页查询
IPage page = new Page(2,3);
userDao.selectPage(page, null);
System.out.println("当前页码:"+page.getCurrent());
System.out.println("每页数据总量:"+page.getSize());
System.out.println("总页数:"+page.getPages());
System.out.println("数据总量:"+page.getTotal());
System.out.println("当前页数据:"+page.getRecords());

开启日志

mybatis-plus:
  configuration:
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl

DQL编程控制

  • MyBatisPlus将书写复杂的SQL查询条件进行了封装,使用编程的形式完成查询条件的组合

条件查询--设置查询条件

格式一:常规格式

QueryWrapper<User> qw = new QueryWrapper<User>();
//查询年龄大于等于18岁,小于65岁的用户
qw.lt("age",65);
qw.ge("age",18);
List<User> userList = userDao.selectList(qw);
System.out.println(userList);

格式二:链式编程格式

QueryWrapper<User> qw = new QueryWrapper<User>();
//查询年龄大于等于18岁,小于65岁的用户
qw.lt("age",65).ge("age",18);
List<User> userList = userDao.selectList(qw);
System.out.println(userList);

格式三:lambda格式(推荐)

QueryWrapper<User> qw = new QueryWrapper<User>();
//查询年龄大于等于18岁,小于65岁的用户
qw.lambda().lt(User::getAge,65).ge(User::getAge,18);
List<User> userList = userDao.selectList(qw);
System.out.println(userList);

格式四:lambada格式(推荐)

LambdaQueryWrapper<User> lqw = new LambdaQueryWrapper<User>();
//查询年龄大于等于18岁,小于65岁的用户
lqw.lt(User::getAge,65).ge(User::getAge,18);
List<User> userList = userDao.selectList(lqw);
System.out.println(userList);

条件查询--组合查询条件

  • 并且(and)
LambdaQueryWrapper<User> lqw = new LambdaQueryWrapper<User>();
//查询年龄大于等于18岁,小于65岁的用户
lqw.lt(User::getAge,65).ge(User::getAge,18);
List<User> userList = userDao.selectList(lqw);
System.out.println(userList);
  • 或者
LambdaQueryWrapper<User> lqw = new LambdaQueryWrapper<User>();
//查询年龄大于等于18岁,小于65岁的用户
lqw.lt(User::getAge,65).or().ge(User::getAge,18);
List<User> userList = userDao.selectList(lqw);
System.out.println(userList);

条件查询--null值处理

  • if语句控制条件追加
LambdaQueryWrapper<User> lqw = new LambdaQueryWrapper<User>();
if(null != userQuery.getAge()){
    lqw.ge(User::getAge, userQuery.getAge());
}
if(null != userQuery.getAge2()){
    lqw.lt(User::getAge, userQuery.getAge2());
}
List<User> userList = userDao.selectList(lqw);
System.out.println(userList);
  • 条件参数控制
LambdaQueryWrapper<User> lqw = new LambdaQueryWrapper<User>();
lqw.ge(null != userQuery.getAge(),User::getAge,userQuery.getAge());
lqw.lt(null != userQuery.getAge2(),User::getAge, userQuery.getAge2());
List<User> userList = userDao.selectList(lqw);
System.out.println(userList);
  • 条件参数控制(链式编程)
LambdaQueryWrapper<User> lqw = new LambdaQueryWrapper<User>();
lqw.ge(null != userQuery.getAge(),User::getAge,userQuery.getAge())
   .lt(null != userQuery.getAge2(),User::getAge, userQuery.getAge2());
List<User> userList = userDao.selectList(lqw);
System.out.println(userList);

查询投影

  • 查询结果包含模型类中部分属性
LambdaQueryWrapper<User> lqw = new LambdaQueryWrapper<User>();
lqw.select(User::getId,User::getName,User::getAge);
List<User> userList = userDao.selectList(lqw);
System.out.println(userList);
  • 查询结果包含模型类中为定义的属性
QueryWrapper<User> qm = new QueryWrapper<User>();
qm.select("count(*) as nums,gender");
qm.groupBy("gender");
List<Map<String, Object>> maps = userDao.selectMaps(qm);
System.out.println(maps);

查询语句

baomidou.com/pages/10c80…

字段映射与表名映射

问题一:表字段与编码属性设计不同步

使用

名称:@TableField

类型:属性注解

位置:模型类属性定义上方

作用:设置当前属性对应的数据库表中的字段关系

范例:

public class User {
    @TableField(value="pwd")
    private String password;
}

相关属性:

value(默认):设置数据库表字段名称

问题二:编码中添加了数据库中未定义的属性

使用

名称:@TableField

类型:属性注解

位置:模型类属性定义上方

作用:设置当前属性对应的数据库表中的字段关系

范例:

public class User {
    @TableField(exist = false)
    private Integer online;
}

相关属性:

value:设置数据表字段名称

exist:设置属性在数据库表字段中是否存在,默认为true。此属性无法与value合并使用

问题三:采用默认查询开放了更多字段查看权限

使用

名称:@TableField

类型:属性注解

位置:模型类属性定义上方

作用:设置当前属性对应的数据库表中的字段关系

范例:

public class User {
    @TableField(value="pwd",select = false)
    private String password;
}

相关属性:

value:设置数据表字段名称

exist:设置属性在数据库表字段中是否存在,默认为true。此属性无法与value合并使用

select:设置属性是否参与查询,此属性与select()映射配置不冲突

问题四:表名与编码开发设计不同步

使用

名称:@TableName

类型:类注解

位置:模型类定义上方

作用:设置当前类对应与数据库表关系

范例:

@TableName("tbl_user")
public class User {
    private Long id;
}

相关属性

value:设置数据库表名称

id生成策略控制

名称:@TableId

类型:属性注解

位置:模型类中用于表示主键的属性定义上方

范例:

public class User {
    @TableId(type = IdType.AUTO)
    private Long id;
}

相关属性

value:设置数据库主键名称

type:设置主键属性的生成策略,值参照IdType枚举值

  • AUTO(0):使用数据库id自增策略控制id生成
  • NONE(1):不设置id生成策略
  • INPUT(2):用户手工输入id
  • ASSIGN_ID(3):雪花算法生成id(可兼容数值型与字符串型)
  • ASSIGN_UUID(4):以UUID生成算法作为id生成策略

全局配置

mybatis-plus:
    global-config:
        db-config:
            id-type: auto
            table-prefix: tbl_

多记录操作

  • 按照主键删除多条记录
List<Long> ids= Arrays.asList(new Long[]{2,3});
userDao.deleteBatchIds(ids);
  • 根据主键查询多条记录
List<Long> ids= Arrays.asList(new Long[]{2,3});
List<User> userList = userDao.selectBatchIds(ids);

逻辑删除

  • 删除操作业务问题:业务数据从数据库中丢弃
  • 逻辑删除:为数据设置是否可用状态字段,删除时设置状态字段为不可用状态,数据保留在数据库中

步骤:

  1. 数据库表中添加逻辑删除标记字段

  1. 实体类中添加对应字段,并设置当前字段为逻辑删除标记字段
public class User {
    private Long id;
    @TableLogic
    private Integer deleted;    
}
  1. 配置逻辑删除字面值
mybatis-plus:
 global-config:
  db-config:
   logic-delete-field: deleted
      logic-not-delete-value: 0 
      logic-delete-value: 1

执行SQL语句:UPDATE tbl_user SET deleted=1 WHERE id=? AND deleted=0

执行结果

乐观锁

  1. 数据库表中添加锁标记字段

  1. 实体类中添加对应字段,并设置当前字段为逻辑删除标记字段
public class User {
    private Long id;
    @Version
    private Integer version;
}
  1. 配置乐观锁拦截器实现锁机制对应的动态SQL语句拼装
@Configuration
public class MpConfig {
    @Bean
    public MybatisPlusInterceptor mpInterceptor() {
        MybatisPlusInterceptor mpInterceptor = new MybatisPlusInterceptor();
        mpInterceptor.addInnerInterceptor(new OptimisticLockerInnerInterceptor());
        return mpInterceptor;
    }
}
  1. 使用乐观锁机制在修改前必须先获得到对应数据的version方可正常进行
@Test
void testUpdate(){
    //先查询数据,获取到version数据
    User user =  userDao.selectById(1L);
    //执行数据修改操作
    user.setName("Tom and Jerry");
    userDao.updateById(user);
}

执行修改前先执行查询语句:

SELECT id,name,age,tel,deleted,version FROM tbl_user WHERE id=?

执行修改时使用version字段作为乐观锁检查依据

UPDATE tbl_user SET name=?, age=?, tel=?, version=? WHERE id=? AND version=?