创建游戏网站,网页制作课程,营销网站的功能,电影模板哪个网站好大家在日常开发中应该能发现#xff0c;单表的CRUD功能代码重复度很高#xff0c;也没有什么难度。而这部分代码量往往比较大#xff0c;开发起来比较费时。
因此#xff0c;目前企业中都会使用一些组件来简化或省略单表的CRUD开发工作。目前在国内使用较多的一个组件就是…大家在日常开发中应该能发现单表的CRUD功能代码重复度很高也没有什么难度。而这部分代码量往往比较大开发起来比较费时。
因此目前企业中都会使用一些组件来简化或省略单表的CRUD开发工作。目前在国内使用较多的一个组件就是MybatisPlus.
当然MybatisPlus不仅仅可以简化单表操作而且还对Mybatis的功能有很多的增强。可以让我们的开发更加的简单高效。
通过今天的学习我们要达成下面的目标 能利用MybatisPlus实现基本的CRUD 会使用条件构建造器构建查询和更新语句 会使用MybatisPlus中的常用注解 会使用MybatisPlus处理枚举、JSON类型字段 会使用MybatisPlus实现分页
1.快速入门
为了方便测试我们先创建一个新的项目并准备一些基础数据。
1.1.环境准备
复制课前资料提供好的一个项目到你的工作空间不要包含空格和特殊字符 然后用你的IDEA工具打开项目结构如下 注意配置一下项目的JDK版本为JDK11。首先点击项目结构设置 在弹窗中配置JDK 接下来要导入两张表在课前资料中已经提供了SQL文件 对应的数据库表结构如下 最后在application.yaml中修改jdbc参数为你自己的数据库参数
spring:datasource:url: jdbc:mysql://127.0.0.1:3306/mp?useUnicodetruecharacterEncodingUTF-8autoReconnecttrueserverTimezoneAsia/Shanghaidriver-class-name: com.mysql.cj.jdbc.Driverusername: rootpassword: MySQL123
logging:level:com.itheima: debugpattern:dateformat: HH:mm:ss
1.2.快速开始
比如我们要实现User表的CRUD只需要下面几步 引入MybatisPlus依赖 定义Mapper
1.2.1引入依赖
MybatisPlus提供了starter实现了自动Mybatis以及MybatisPlus的自动装配功能坐标如下
dependencygroupIdcom.baomidou/groupIdartifactIdmybatis-plus-boot-starter/artifactIdversion3.5.3.1/version
/dependency
由于这个starter包含对mybatis的自动装配因此完全可以替换掉Mybatis的starter。 最终项目的依赖如下
dependenciesdependencygroupIdcom.baomidou/groupIdartifactIdmybatis-plus-boot-starter/artifactIdversion3.5.3.1/version/dependencydependencygroupIdcom.mysql/groupIdartifactIdmysql-connector-j/artifactIdscoperuntime/scope/dependencydependencygroupIdorg.projectlombok/groupIdartifactIdlombok/artifactIdoptionaltrue/optional/dependencydependencygroupIdorg.springframework.boot/groupIdartifactIdspring-boot-starter-test/artifactIdscopetest/scope/dependency
/dependencies
1.2.2.定义Mapper
为了简化单表CRUDMybatisPlus提供了一个基础的BaseMapper接口其中已经实现了单表的CRUD 因此我们自定义的Mapper只要实现了这个BaseMapper就无需自己实现单表CRUD了。 修改mp-demo中的com.itheima.mp.mapper包下的UserMapper接口让其继承BaseMapper 代码如下
package com.itheima.mp.mapper;
import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.itheima.mp.domain.po.User;
public interface UserMapper extends BaseMapperUser {
}
1.2.3.测试
新建一个测试类编写几个单元测试测试基本的CRUD功能
package com.itheima.mp.mapper;
import com.itheima.mp.domain.po.User;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import java.time.LocalDateTime;
import java.util.List;
SpringBootTest
class UserMapperTest {
Autowiredprivate UserMapper userMapper;
Testvoid testInsert() {User user new User();user.setId(5L);user.setUsername(Lucy);user.setPassword(123);user.setPhone(18688990011);user.setBalance(200);user.setInfo({\age\: 24, \intro\: \英文老师\, \gender\: \female\});user.setCreateTime(LocalDateTime.now());user.setUpdateTime(LocalDateTime.now());userMapper.insert(user);}
Testvoid testSelectById() {User user userMapper.selectById(5L);System.out.println(user user);}
Testvoid testSelectByIds() {ListUser users userMapper.selectBatchIds(List.of(1L, 2L, 3L, 4L, 5L));users.forEach(System.out::println);}
Testvoid testUpdateById() {User user new User();user.setId(5L);user.setBalance(20000);userMapper.updateById(user);}
Testvoid testDelete() {userMapper.deleteById(5L);}
}
可以看到在运行过程中打印出的SQL日志非常标准
11:05:01 INFO 15524 --- [ main] com.zaxxer.hikari.HikariDataSource : HikariPool-1 - Starting...
11:05:02 INFO 15524 --- [ main] com.zaxxer.hikari.HikariDataSource : HikariPool-1 - Start completed.
11:05:02 DEBUG 15524 --- [ main] c.i.mp.mapper.UserMapper.selectById : Preparing: SELECT id,username,password,phone,info,status,balance,create_time,update_time FROM user WHERE id?
11:05:02 DEBUG 15524 --- [ main] c.i.mp.mapper.UserMapper.selectById : Parameters: 5(Long)
11:05:02 DEBUG 15524 --- [ main] c.i.mp.mapper.UserMapper.selectById : Total: 1
user User(id5, usernameLucy, password123, phone18688990011, info{age: 21}, status1, balance20000, createTimeFri Jun 30 11:02:30 CST 2023, updateTimeFri Jun 30 11:02:30 CST 2023)
只需要继承BaseMapper就能省去所有的单表CRUD是不是非常简单
1.3.常见注解
在刚刚的入门案例中我们仅仅引入了依赖继承了BaseMapper就能使用MybatisPlus非常简单。但是问题来了 MybatisPlus如何知道我们要查询的是哪张表表中有哪些字段呢
大家回忆一下UserMapper在继承BaseMapper的时候指定了一个泛型 泛型中的User就是与数据库对应的PO.
MybatisPlus就是根据PO实体的信息来推断出表的信息从而生成SQL的。默认情况下 MybatisPlus会把PO实体的类名驼峰转下划线作为表名 MybatisPlus会把PO实体的所有变量名驼峰转下划线作为表的字段名并根据变量类型推断字段类型 MybatisPlus会把名为id的字段作为主键
但很多情况下默认的实现与实际场景不符因此MybatisPlus提供了一些注解便于我们声明表信息。
1.3.1.TableName
说明 描述表名注解标识实体类对应的表 使用位置实体类
示例
TableName(user)
public class User {private Long id;private String name;
}
TableName注解除了指定表名以外还可以指定很多其它属性
属性类型必须指定默认值描述valueString否表名schemaString否schemakeepGlobalPrefixboolean否false是否保持使用全局的 tablePrefix 的值当全局 tablePrefix 生效时resultMapString否xml 中 resultMap 的 id用于满足特定类型的实体类对象绑定autoResultMapboolean否false是否自动构建 resultMap 并使用如果设置 resultMap 则不会进行 resultMap 的自动构建与注入excludePropertyString[]否{}需要排除的属性名 since 3.3.1
1.3.2.TableId
说明 描述主键注解标识实体类中的主键字段 使用位置实体类的主键字段
示例
TableName(user)
public class User {TableIdprivate Long id;private String name;
}
TableId注解支持两个属性
属性类型必须指定默认值描述valueString否表名typeEnum否IdType.NONE指定主键类型
IdType支持的类型有
值描述AUTO数据库 ID 自增NONE无状态该类型为未设置主键类型注解里等于跟随全局全局里约等于 INPUTINPUTinsert 前自行 set 主键值ASSIGN_ID分配 ID(主键类型为 Number(Long 和 Integer)或 String)(since 3.3.0),使用接口IdentifierGenerator的方法nextId(默认实现类为DefaultIdentifierGenerator雪花算法)ASSIGN_UUID分配 UUID,主键类型为 String(since 3.3.0),使用接口IdentifierGenerator的方法nextUUID(默认 default 方法)ID_WORKER分布式全局唯一 ID 长整型类型(please use ASSIGN_ID)UUID32 位 UUID 字符串(please use ASSIGN_UUID)ID_WORKER_STR分布式全局唯一 ID 字符串类型(please use ASSIGN_ID)
这里比较常见的有三种 AUTO利用数据库的id自增长 INPUT手动生成id ASSIGN_ID雪花算法生成Long类型的全局唯一id这是默认的ID策略
1.3.3.TableField
说明 描述普通字段注解 示例
TableName(user)
public class User {TableIdprivate Long id;private String name;private Integer age;TableField(isMarried)private Boolean isMarried;TableField(concat)private String concat;TableField(exist false)private String address;
}
一般情况下我们并不需要给字段添加TableField注解一些特殊情况除外 成员变量名与数据库字段名不一致 成员变量是以isXXX命名按照JavaBean的规范MybatisPlus识别字段时会把is去除这就导致与数据库不符。 成员变量名与数据库一致但是与数据库的关键字冲突。使用TableField注解给字段名添加转义字符。 成员变量不是数据库字段
支持的其它属性如下
属性类型必填默认值描述valueString否数据库字段名existboolean否true是否为数据库表字段conditionString否字段 where 实体查询比较条件有值设置则按设置的值为准没有则为默认全局的 %s#{%s}参考(opens new window)updateString否字段 update set 部分注入例如当在version字段上注解update%s1 表示更新时会 set versionversion1 该属性优先级高于 el 属性insertStrategyEnum否FieldStrategy.DEFAULT举例NOT_NULL insert into table_a(if testcolumnProperty ! nullcolumn/if) values (if testcolumnProperty ! null#{columnProperty}/if)updateStrategyEnum否FieldStrategy.DEFAULT举例IGNORED update table_a set column#{columnProperty}whereStrategyEnum否FieldStrategy.DEFAULT举例NOT_EMPTY where if testcolumnProperty ! null and columnProperty!column#{columnProperty}/iffillEnum否FieldFill.DEFAULT字段自动填充策略selectboolean否true是否进行 select 查询keepGlobalFormatboolean否false是否保持使用全局的 format 进行处理jdbcTypeJdbcType否JdbcType.UNDEFINEDJDBC 类型 (该默认值不代表会按照该值生效)typeHandlerTypeHander否类型处理器 (该默认值不代表会按照该值生效)numericScaleString否指定小数点后保留的位数
1.4.常见配置
MybatisPlus也支持基于yaml文件的自定义配置详见官方文档
https://www.baomidou.com/pages/56bac0/#%E5%9F%BA%E6%9C%AC%E9%85%8D%E7%BD%AE
大多数的配置都有默认值因此我们都无需配置。但还有一些是没有默认值的例如: 实体类的别名扫描包 全局id类型
mybatis-plus:type-aliases-package: com.itheima.mp.domain.poglobal-config:db-config:id-type: auto # 全局id类型为自增长
需要注意的是MyBatisPlus也支持手写SQL的而mapper文件的读取地址可以自己配置
mybatis-plus:mapper-locations: classpath*:/mapper/**/*.xml # Mapper.xml文件地址当前这个是默认值。
可以看到默认值是classpath*:/mapper/**/*.xml也就是说我们只要把mapper.xml文件放置这个目录下就一定会被加载。
例如我们新建一个UserMapper.xml文件 然后在其中定义一个方法
?xml version1.0 encodingUTF-8?
!DOCTYPE mapper PUBLIC -//mybatis.org//DTD Mapper 3.0//EN http://mybatis.org/dtd/mybatis-3-mapper.dtd
mapper namespacecom.itheima.mp.mapper.UserMapper
select idqueryById resultTypeUserSELECT * FROM user WHERE id #{id}/select
/mapper
然后在测试类UserMapperTest中测试该方法
Test
void testQuery() {User user userMapper.queryById(1L);System.out.println(user user);
}
