前面我们学习过的ORM[Object Relational Mapping(对象关系映射)]持久层框架MyBatis,它可以帮助我们完成单表、多表、动态SQL的业务逻辑处理,与之平级的还有Hibernate,和这节我们要学习的MyBatisPlus了。
1.快速入门
1.1 入门案例
首先我们根据提供的资料导入一下工程案例,一起看下实现下列功能的代码逻辑:
● 新增用户功能
● 根据id查询用户
● 根据id批量查询用户
● 根据id更新用户
● 根据id删除用户
代码执行流程如下:
当我们打开:UserMapper_20231023_150307.xml 文件后,可以看到熟悉的代码
但是我们不禁要思考一个问题,简单的单表的增删改查,他的SQL语句基本固定,这种是否可以优化呢?当然是可以的,这就是这一小节MP要做的事情。而要引入MP框架并应用起来,遵循下面的步骤即可。
1-引入MybatisPlus的起步依赖
MyBatisPlus官方提供了starter,其中集成了Mybatis和MybatisPlus的所有功能,并且实现了自动装配效果。因此我们可以用MybatisPlus的starter代替Mybatis的starter:
● 原来的mybatis依赖可以删除掉
com.baomidou
mybatis-plus-boot-starter
3.5.3.1
2-继承BaseMapper
然后我们在自己的mapper接口中继承BaseMapper,并声明泛型对应的实体类就可以有常见的CRUD代码了。
接下来我们就用MP依次替代上述增删改查的原始代码
● 新增用户功能
● 根据id查询用户
● 根据id批量查询用户
● 根据id更新用户
● 根据id删除用户
整体改造完之后,我们就可以把之前:UserMapper_20231023_150307.xml 中的代码都删掉了,是不是很简洁
1.2 常见注解
通过上面的案例我们可以发现mp的使用很便捷,用户基本是无感知的,那他是如何做到表跟属性值的映射的呢?MyBatisPlus通过扫描实体类,并基于反射获取实体类信息作为数据库表信息。
但是上述的都是正常情况,如果存在一些异常:如表名跟实体类不一样、实体类部分字段表中没有等,就可以通过一些常见注解来完成映射了,MybatisPlus中比较常用的几个注解如下:
● @TableName:用来指定表名
● @TableId:用来指定表中的主键字段信息
● @TableField:用来指定表中的普通字段信息
假设表结构如下
则对应的实体类可以映射如下
其中
IdType枚举:
● AUTO:数据库自增长
● INPUT:通过set方法自行输入
● ASSIGN_ID:分配 ID,接口IdentifierGenerator的方法nextId来生成id,默认实现类为DefaultIdentifierGenerator
雪花算法使用@TableField的常见场景:
● 成员变量名与数据库字段名不一致
● 成员变量名以is开头,且是布尔值
● 成员变量名与数据库关键字冲突
● 成员变量不是数据库字段
1.3 常见配置
MyBatisPlus的配置项继承了MyBatis原生配置和一些自己特有的配置。例如:
mybatis-plus:
type-aliases-package: com.itheima.mp.domain.po # 别名扫描包
mapper-locations: "classpath:/mapper/**/.xml" # Mapper.xml文件地址,默认值
configuration:
map-underscore-to-camel-case: true # 是否开启下划线和驼峰的映射
cache-enabled: false # 是否开启二级缓存
global-config:
db-config:
id-type: assign_id # id为雪花算法生成
update-strategy: not_null # 更新策略:只更新非空字段
具体可参考官方文档:使用配置 | MyBatis-Plus (baomidou.com)
2.核心功能
2.1 条件构造器
理论分析
MyBatisPlus支持各种复杂的where条件,可以满足日常开发的所有需求。当我们继承BaseMapper之后,就具备了一些常见的接口方法
这里的Wrapper就是各种条件构造器,他的子类继承体系如下
在这个体系中,AbstractWrapper定义了各种查询的条件,如:eq、in、between、like、gt、lt等。也就是说借助于他可以完成单表各种场景的查询条件组装。那为什么他又有QueryWrapper、UpdateWrapper呢?这是因为我们一个完整的查询语句是:SELECT 字段 FROM 表名 WHERE 条件
QueryWrapper可以帮助我们声明要查询的具体字段,避免查询全部字段,导致IO开销过大,从而影响SQL性能的问题。同理UpdateWrapper一样,可以帮我们更新指定字段。
案例实操
接下来我们就通过几个案例,来实际体验一下吧
● 查询出名字中带o的,存款大于等于1000元的人的id、username、info、balance字段
上述案例的SQL大概如下
SELECT id, username, info, balance
FROM user
WHERE
username like '%o%'
AND balance >= 1000
分析:因为是查询,且查询指定字段,所以这里考虑QueryWrapper
@Test
void testQueryWrapper() {
QueryWrapper queryWrapper = new QueryWrapper();
queryWrapper
.select("id", "username", "info", "balance")
.like("username", "o")
.ge("balance", "1000");
List users = userMapper.selectList(queryWrapper);
users.forEach(System.out::println);
}
● 更新用户名为jack的用户的余额为2000
上述案例的SQL大概如下
UPDATE user
SET balance = 2000
WHERE username = "jack"
分析:因为更新的where条件中带查询,所以可以用QueryWrapper
@Test
void testQueryWrapper2() {
// 1-数据
User user = new User();
user.setBalance(2000);
// 2-条件
QueryWrapper wrapper = new QueryWrapper().eq("username", "jack");
// 3-更新
userMapper.update(user, wrapper);
}
● 更新id为1,2,4的用户的余额,扣200
上述案例的SQL大概如下
UPDATE user
SET balance = balance - 200
WHERE id in (1, 2, 4)
分析:这个SQL更新条件不需要做额外的查询,所以UpdateWrapper可以直接搞定,并且这里是账户余额扣减200不是直接设置成两百,所以我们的更新参数第一个user给null就好
@Test
void testUpdateWrapper() {
UpdateWrapper updateWrapper = new UpdateWrapper()
.setSql("balance = balance - 200")
.in("id", Arrays.asList(1L, 2L, 3L));
userMapper.update(null, updateWrapper);
}
如果这里同时需要设置用户姓名拼接:*,就可以初始化一个User对象,然后做拼接,最后传递进去就可以
2.2 自定义SQL
这个我们在项目二会使用到
我们可以利用MyBatisPlus的Wrapper来构建复杂的Where条件,然后自己定义SQL语句中剩下的部分。
需求:将id在指定范围的用户(例如1、2、4 )的余额扣减指定值
正常我们的SQL语句如下