SSM系列之MyBatisPlus

您所在的位置:网站首页 mybatisplus映射枚举类tostring方法的作用 SSM系列之MyBatisPlus

SSM系列之MyBatisPlus

2023-06-24 10:26| 来源: 网络整理| 查看: 265

MyBatisPlus

目标

基于MyBatisPlus完成标准Dao的增删改查功能

掌握MyBatisPlus中的分页及条件查询构建

掌握主键ID的生成策略

了解MyBatisPlus的代码生成器

1、MyBatisPlus入门案例与简介

这一节我们来学习下MyBatisPlus的入门案例与简介,这个和其他课程都不太一样,其他的课程都是先介绍概念,然后再写入门案例。而对于MyBatisPlus的学习,我们将顺序做了调整,主要的原因MyBatisPlus主要是对MyBatis的简化,所有我们先体会下它简化在哪,然后再学习它是什么,以及它帮我们都做哪些事。

1.1 入门案例

MybatisPlus(简称MP)是基于MyBatis框架基础上开发的增强型工具,旨在简化开发、提供效率。

开发方式

基于MyBatis使用MyBatisPlus 基于Spring使用MyBatisPlus 基于SpringBoot使用MyBatisPlus

SpringBoot刚刚我们学习完成,它能快速构建Spring开发环境用以整合其他技术,使用起来是非常简单,对于MP的学习,我们也基于SpringBoot来构建学习。

学习之前,我们先来回顾下,SpringBoot整合Mybatis的开发过程:

创建SpringBoot工程

1630997819698.png

勾选配置使用的技术,能够实现自动添加起步依赖包

1630997860020.png

设置dataSource相关属性(JDBC参数)

1630997901479.png

定义数据层接口映射配置

1630997929891.png

我们可以参考着上面的这个实现步骤把SpringBoot整合MyBatisPlus来快速实现下,具体的实现步骤为:

步骤1:创建数据库及表 create database if not exists mybatisplus_db character set utf8; use mybatisplus_db; CREATE TABLE user ( id bigint(20) primary key auto_increment, name varchar(32) not null, password varchar(32) not null, age int(3) not null , tel varchar(32) not null ); insert into user values(1,'Tom','tom',3,'18866668888'); insert into user values(2,'Jerry','jerry',4,'16688886666'); insert into user values(3,'Jock','123456',41,'18812345678'); 步骤2:创建SpringBoot工程

1630998241426.png

步骤3:勾选配置使用技术

1630998321660.png

说明:

由于MP并未被收录到idea的系统内置配置,无法直接选择加入,需要手动在pom.xml中配置添加 步骤4:pom.xml补全依赖 com.baomidou mybatis-plus-boot-starter 3.4.1 com.alibaba druid 1.1.16

说明:

druid数据源可以加也可以不加,SpringBoot有内置的数据源,可以配置成使用Druid数据源

从MP的依赖关系可以看出,通过依赖传递已经将MyBatis与MyBatis整合Spring的jar包导入,我们不需要额外在添加MyBatis的相关jar包

1631206757758.png

步骤5:添加MP的相关配置信息

resources默认生成的是properties配置文件,可以将其替换成yml文件,并在文件中配置数据库连接的相关信息:application.yml

spring: datasource: type: com.alibaba.druid.pool.DruidDataSource driver-class-name: com.mysql.cj.jdbc.Driver url: jdbc:mysql://localhost:3306/mybatisplus_db?serverTimezone=UTC username: root password: root

说明: serverTimezone是用来设置时区,UTC是标准时区,和咱们的时间差8小时,所以可以将其修改为Asia/Shanghai

步骤6:根据数据库表创建实体类 public class User { private Long id; private String name; private String password; private Integer age; private String tel; //setter...getter...toString方法略 } 步骤7:创建Dao接口 @Mapper public interface UserDao extends BaseMapper{ } 步骤8:编写引导类 @SpringBootApplication //@MapperScan("com.itheima.dao") public class Mybatisplus01QuickstartApplication { public static void main(String[] args) { SpringApplication.run(Mybatisplus01QuickstartApplication.class, args); } }

说明: Dao接口要想被容器扫描到,有两种解决方案:

方案一:在Dao接口上添加@Mapper注解,并且确保Dao处在引导类所在包或其子包中 该方案的缺点是需要在每一Dao接口中添加注解 方案二:在引导类上添加@MapperScan注解,其属性为所要扫描的Dao所在包 该方案的好处是只需要写一次,则指定包下的所有Dao接口都能被扫描到,@Mapper就可以不写。 步骤9:编写测试类 @SpringBootTest class MpDemoApplicationTests { @Autowired private UserDao userDao; @Test public void testGetAll() { List userList = userDao.selectList(null); System.out.println(userList); } }

说明:

userDao注入的时候下面有红线提示的原因是什么?

UserDao是一个接口,不能实例化对象

只有在服务器启动IOC容器初始化后,由框架创建DAO接口的代理对象来注入

现在服务器并未启动,所以代理对象也未创建,IDEA查找不到对应的对象注入,所以提示报红

一旦服务启动,就能注入其代理对象,所以该错误提示不影响正常运行。

查看运行结果:

1630999646096.png

跟之前整合MyBatis相比,你会发现我们不需要在DAO接口中编写方法和SQL语句了,只需要继承BaseMapper接口即可。整体来说简化很多。

1.2 MybatisPlus简介

MyBatisPlus(简称MP)是基于MyBatis框架基础上开发的增强型工具,旨在简化开发、提高效率

通过刚才的案例,相信大家能够体会简化开发和提高效率这两个方面的优点。

MyBatisPlus的官网为:https://mp.baomidou.com/

说明:

1631011942323.png

现在的页面中,这一行已经被删除,现在再去访问https://mybatis.plus会发现访问不到,这个就有很多可能性供我们猜想了,所以大家使用baomidou的网址进行访问即可。

官方文档中有一张很多小伙伴比较熟悉的图片:

1631012174092.png

从这张图中我们可以看出MP旨在成为MyBatis的最好搭档,而不是替换MyBatis,所以可以理解为MP是MyBatis的一套增强工具,它是在MyBatis的基础上进行开发的,我们虽然使用MP但是底层依然是MyBatis的东西,也就是说我们也可以在MP中写MyBatis的内容。

对于MP的学习,大家可以参考着官方文档来进行学习,里面都有详细的代码案例。

MP的特性:

无侵入:只做增强不做改变,不会对现有工程产生影响 强大的 CRUD 操作:内置通用 Mapper,少量配置即可实现单表CRUD 操作 支持 Lambda:编写查询条件无需担心字段写错 支持主键自动生成 内置分页插件 …… 2、标准数据层开发

在这一节中我们重点学习的是数据层标准的CRUD(增删改查)的实现与分页功能。代码比较多,我们一个个来学习。

2.1 标准CRUD使用

对于标准的CRUD功能都有哪些以及MP都提供了哪些方法可以使用呢?

我们先来看张图:

1631018877517.png

对于这张图的方法,我们挨个来演示下:

首先说下,案例中的环境就是咱们入门案例的内容,第一个先来完成新增功能

2.2 新增

在进行新增之前,我们可以分析下新增的方法:

int insert (T t)

T:泛型,新增用来保存新增数据

int:返回值,新增成功后返回1,没有新增成功返回的是0

在测试类中进行新增操作:

@SpringBootTest class Mybatisplus01QuickstartApplicationTests { @Autowired private UserDao userDao; @Test void testSave() { User user = new User(); user.setName("itheima"); user.setPassword("itheima"); user.setAge(12); user.setTel("4006184000"); userDao.insert(user); } }

执行测试后,数据库表中就会添加一条数据。

但是数据中的主键ID,有点长,那这个主键ID是如何来的?我们更想要的是主键自增,应该是5才对,这个是我们后面要学习的主键ID生成策略,这块的这个问题,我们暂时先放放。

2.3 删除

在进行删除之前,我们可以分析下删除的方法:

int deleteById (Serializable id)

Serializable:参数类型

思考:参数类型为什么是一个序列化类?

1631013655771.png

从这张图可以看出,

String和Number是Serializable的子类, Number又是Float,Double,Integer等类的父类, 能作为主键的数据类型都已经是Serializable的子类, MP使用Serializable作为参数类型,就好比我们可以用Object接收任何数据类型一样。

int:返回值类型,数据删除成功返回1,未删除数据返回0。

在测试类中进行新增操作:

@SpringBootTest class Mybatisplus01QuickstartApplicationTests { @Autowired private UserDao userDao; @Test void testDelete() { userDao.deleteById(1401856123725713409L); } } 2.4 修改

在进行修改之前,我们可以分析下修改的方法:

int updateById(T t);

T:泛型,需要修改的数据内容,注意因为是根据ID进行修改,所以传入的对象中需要有ID属性值

int:返回值,修改成功后返回1,未修改数据返回0

在测试类中进行新增操作:

@SpringBootTest class Mybatisplus01QuickstartApplicationTests { @Autowired private UserDao userDao; @Test void testUpdate() { User user = new User(); user.setId(1L); user.setName("Tom888"); user.setPassword("tom888"); userDao.updateById(user); } }

说明: 修改的时候,只修改实体对象中有值的字段。

2.5 根据ID查询

在进行根据ID查询之前,我们可以分析下根据ID查询的方法:

T selectById (Serializable id) Serializable:参数类型,主键ID的值 T:根据ID查询只会返回一条数据

在测试类中进行新增操作:

@SpringBootTest class Mybatisplus01QuickstartApplicationTests { @Autowired private UserDao userDao; @Test void testGetById() { User user = userDao.selectById(2L); System.out.println(user); } } 2.6 查询所有

在进行查询所有之前,我们可以分析下查询所有的方法:

List selectList(Wrapper queryWrapper) Wrapper:用来构建条件查询的条件,目前我们没有可直接传为Null List:因为查询的是所有,所以返回的数据是一个集合

在测试类中进行新增操作:

@SpringBootTest class Mybatisplus01QuickstartApplicationTests { @Autowired private UserDao userDao; @Test void testGetAll() { List userList = userDao.selectList(null); System.out.println(userList); } }

我们所调用的方法都是来自于DAO接口继承的BaseMapper类中。里面的方法有很多,我们后面会慢慢去学习里面的内容。

2.7 Lombok

代码写到这,我们会发现DAO接口类的编写现在变成最简单的了,里面什么都不用写。反过来看看模型类的编写都需要哪些内容:

私有属性 setter...getter...方法 toString方法 构造函数

虽然这些内容不难,同时也都是通过IDEA工具生成的,但是过程还是必须得走一遍,那么对于模型类的编写有没有什么优化方法?就是我们接下来要学习的Lombok。

概念 Lombok,一个Java类库,提供了一组注解,简化POJO实体类开发。 使用步骤 步骤1:添加lombok依赖 org.projectlombok lombok

注意:版本可以不用写,因为SpringBoot中已经管理了lombok的版本。

步骤2:安装Lombok的插件

新版本IDEA已经内置了该插件,如果删除setter和getter方法程序有报红,则需要安装插件

1631016543648.png

如果在IDEA中找不到lombok插件,可以访问如下网站

https://plugins.jetbrains.com/plugin/6317-lombok/versions

根据自己IDEA的版本下载对应的lombok插件,下载成功后,在IDEA中采用离线安装的方式进行安装。

1631016876641.png

步骤3:模型类上添加注解

Lombok常见的注解有:

@Setter:为模型类的属性提供setter方法 @Getter:为模型类的属性提供getter方法 @ToString:为模型类的属性提供toString方法 @EqualsAndHashCode:为模型类的属性提供equals和hashcode方法 @Data:是个组合注解,包含上面的注解的功能 @NoArgsConstructor:提供一个无参构造函数 @AllArgsConstructor:提供一个包含所有参数的构造函数

Lombok的注解还有很多,上面标红的三个是比较常用的,其他的大家后期用到了,再去补充学习。

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

说明:

Lombok只是简化模型类的编写,我们之前的方法也能用,比如有人会问:我如果只想要有name和password的构造函数,该如何编写?

@Data @AllArgsConstructor @NoArgsConstructor public class User { private Long id; private String name; private String password; private Integer age; private String tel; public User(String name, String password) { this.name = name; this.password = password; } }

这种方式是被允许的。

2.8 分页功能

基础的增删改查就已经学习完了,刚才我们在分析基础开发的时候,有一个分页功能还没有实现,在MP中如何实现分页功能,就是咱们接下来要学习的内容。

分页查询使用的方法是:

IPage selectPage(IPage page, Wrapper queryWrapper) IPage:用来构建分页查询条件 Wrapper:用来构建条件查询的条件,目前我们没有可直接传为Null IPage:返回值,你会发现构建分页条件和方法的返回值都是IPage

IPage是一个接口,我们需要找到它的实现类来构建它,具体的实现类,可以进入到IPage类中按ctrl+h,会找到其有一个实现类为Page。

步骤1:调用方法传入参数获取返回值 @SpringBootTest class Mybatisplus01QuickstartApplicationTests { @Autowired private UserDao userDao; //分页查询 @Test void testSelectPage(){ //1 创建IPage分页对象,设置分页参数,1为当前页码,3为每页显示的记录数 IPage page=new Page(1,3); //2 执行分页查询 userDao.selectPage(page,null); //3 获取分页结果 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()); } } 步骤2:设置分页拦截器

这个拦截器MP已经为我们提供好了,我们只需要将其配置成Spring管理的bean对象即可。

@Configuration public class MybatisPlusConfig { @Bean public MybatisPlusInterceptor mybatisPlusInterceptor(){ //1 创建MybatisPlusInterceptor拦截器对象 MybatisPlusInterceptor mpInterceptor=new MybatisPlusInterceptor(); //2 添加分页拦截器 mpInterceptor.addInnerInterceptor(new PaginationInnerInterceptor()); return mpInterceptor; } }

说明: 上面的代码记不住咋办呢?

这些内容在MP的官方文档中有详细的说明,我们可以查看官方文档类配置

1631208030131.png

步骤3:运行测试程序

1631019660480.png

如果想查看MP执行的SQL语句,可以修改application.yml配置文件,

mybatis-plus: configuration: log-impl: org.apache.ibatis.logging.stdout.StdOutImpl #打印SQL日志到控制台

打开日志后,就可以在控制台打印出对应的SQL语句,开启日志功能性能就会受到影响,调试完后记得关闭。

3、DQL编程控制

增删改查四个操作中,查询是非常重要的也是非常复杂的操作,这块需要我们重点学习下,这节我们主要学习的内容有:

条件查询方式 查询投影 查询条件设定 字段映射与表名映射 3.1 条件查询 3.1.1 条件查询的类 MyBatisPlus将书写复杂的SQL查询条件进行了封装,使用编程的形式完成查询条件的组合。

这个我们在前面都有见过,比如查询所有和分页查询的时候,都有看到过一个Wrapper类,这个类就是用来构建查询条件的,如下图所示:

1631020283701.png

那么条件查询如何使用Wrapper来构建呢?

3.1.2 环境构建

在构建条件查询之前,我们先来准备下环境

创建一个SpringBoot项目

pom.xml中添加对应的依赖

4.0.0 org.springframework.boot spring-boot-starter-parent 2.5.0 com.itheima mybatisplus_02_dql 0.0.1-SNAPSHOT 1.8 com.baomidou mybatis-plus-boot-starter 3.4.1 org.springframework.boot spring-boot-starter com.alibaba druid 1.1.16 mysql mysql-connector-java runtime org.springframework.boot spring-boot-starter-test test org.projectlombok lombok org.springframework.boot spring-boot-maven-plugin

编写UserDao接口

@Mapper public interface UserDao extends BaseMapper { }

编写模型类

@Data public class User { private Long id; private String name; private String password; private Integer age; private String tel; }

编写引导类

@SpringBootApplication public class Mybatisplus02DqlApplication { public static void main(String[] args) { SpringApplication.run(Mybatisplus02DqlApplication.class, args); } }

编写配置文件

# dataSource spring: datasource: type: com.alibaba.druid.pool.DruidDataSource driver-class-name: com.mysql.cj.jdbc.Driver url: jdbc:mysql://localhost:3306/mybatisplus_db?serverTimezone=UTC username: root password: root # mp日志 mybatis-plus: configuration: log-impl: org.apache.ibatis.logging.stdout.StdOutImpl

编写测试类

@SpringBootTest class Mybatisplus02DqlApplicationTests { @Autowired private UserDao userDao; @Test void testGetAll(){ List userList = userDao.selectList(null); System.out.println(userList); } }

最终创建的项目结构为:

1631033477792.png

测试的时候,控制台打印的日志比较多,速度有点慢而且不利于查看运行结果,所以接下来我们把这个日志处理下:

取消初始化spring日志打印,resources目录下添加logback.xml,名称固定,内容如下:

说明: logback.xml的配置内容,不是我们学习的重点,如果有兴趣可以自行百度查询。

取消MybatisPlus启动banner图标

1631021315906.png

application.yml添加如下内容:

# mybatis-plus日志控制台输出 mybatis-plus: configuration: log-impl: org.apache.ibatis.logging.stdout.StdOutImpl global-config: banner: off # 关闭mybatisplus启动图标

取消SpringBoot的log打印

1631021269422.png

application.yml添加如下内容:

spring: main: banner-mode: off # 关闭SpringBoot启动图标(banner)

解决控制台打印日志过多的相关操作可以不用去做,一般会被用来方便我们查看程序运行的结果。

3.1.3 构建条件查询

在进行查询的时候,我们的入口是在Wrapper这个类上,因为它是一个接口,所以我们需要去找它对应的实现类,关于实现类也有很多,说明我们有多种构建查询条件对象的方式,

1631021942869.png

先来看第一种:QueryWrapper @SpringBootTest class Mybatisplus02DqlApplicationTests { @Autowired private UserDao userDao; @Test void testGetAll(){ QueryWrapper qw = new QueryWrapper(); qw.lt("age",18); List userList = userDao.selectList(qw); System.out.println(userList); } }

lt: 小于( 、 = 、between) 模糊匹配(like) 空判定(null) 包含性匹配(in) 分组(group) 排序(order) …… 3.3.1 等值查询

需求:根据用户名和密码查询用户信息

@SpringBootTest class Mybatisplus02DqlApplicationTests { @Autowired private UserDao userDao; @Test void testGetAll(){ LambdaQueryWrapper lqw = new LambdaQueryWrapper(); lqw.eq(User::getName, "Jerry").eq(User::getPassword, "jerry"); User loginUser = userDao.selectOne(lqw); System.out.println(loginUser); } }

eq(): 相当于 =,对应的sql语句为

SELECT id,name,password,age,tel FROM user WHERE (name = ? AND password = ?)

selectList:查询结果为多个或者单个

selectOne:查询结果为单个

3.3.2 范围查询

需求:对年龄进行范围查询,使用lt()、le()、gt()、ge()、between()进行范围查询

@SpringBootTest class Mybatisplus02DqlApplicationTests { @Autowired private UserDao userDao; @Test void testGetAll(){ LambdaQueryWrapper lqw = new LambdaQueryWrapper(); lqw.between(User::getAge, 10, 30); //SELECT id,name,password,age,tel FROM user WHERE (age BETWEEN ? AND ?) List userList = userDao.selectList(lqw); System.out.println(userList); } } gt():大于(>) ge():大于等于(>=) lt():小于(


【本文地址】


今日新闻


推荐新闻


CopyRight 2018-2019 办公设备维修网 版权所有 豫ICP备15022753号-3