系列文章目录
MyBatis缓存原理
Mybatis plugin 的使用及原理
MyBatis+Springboot 启动到SQL执行全流程
数据库操作不再困难,MyBatis动态Sql标签解析
Mybatis的CachingExecutor与二级缓存
MyBatis四大组件Executor、StatementHandler、ParameterHandler、ResultSetHandler 详解
使用MybatisPlus还是MyBaits ,开发者应该如何选择?
前面我们说了不少关于Mybatis的一些信息。而对于使用myBtais的开发者,或多或少知道它还有一个伙伴 —— MybatisPlus。顾名思义,MybatisPlus带个plus,也就是Mybatis的增强工具,它在Mybatis的基础上提供了更多便捷的功能和拓展,旨在简化开发工作。对于没有接触过 MybatisPlus 的伙伴,我们本次就看看两者的差异,以及开发者该如何二选一?
📕作者简介:战斧,从事金融IT行业,有着多年一线开发、架构经验;爱好广泛,乐于分享,致力于创作更多高质量内容
📗本文收录于 MyBatis专栏 专栏,有需要者,可直接订阅专栏实时获取更新
📘高质量专栏 云原生、RabbitMQ、Spring全家桶 等仍在更新,欢迎指导
📙Zookeeper Redis kafka docker netty等诸多框架,以及架构与分布式专题即将上线,敬请期待
一、MybatisPlus(简称MP)是什么?
相信本文的读者应该都对 Mybatis 比较熟悉,或有使用经验。而 MybatisPlus(简称MP)则是一个基于MyBatis的快速开发框架,它提供了许多便捷的功能,能够大大简化开发过程。我们在它的官网(https://baomidou.com/) 中可以看见它对自己的定义——是一个 MyBatis 的增强工具
而所谓增强,其实就是提供了更丰富的功能和更简洁的代码编写方式,使得开发人员能够更快速地完成数据库操作。我们将在下面详细介绍。
二、为什么要用 MybatisPlus ?
我们姑且当作各位读者使用过MyBatis, 那么应该清楚 MyBaits 的功能是十分强大的,而且我们在前面说了MyBaits 的核心特质—— 动态SQL(数据库操作不再困难,MyBatis动态Sql标签解析)。比如下面这中样式:
<select id="getUserInfoByCondition" resultType="com.example.UserInfo">
SELECT * FROM UserInfo
<where>
<if test="name != null">
AND name = #{name}
</if>
<if test="age != null">
AND age = #{age}
</if>
</where>
</select>
但是很多时候我们仍觉得有些麻烦,居然还需要我们手动去写SQL,一些复杂的或者联表查询的SQL权且不提,但是大部分的最简单的单表增删改查也要让我们手写,属实是有些麻烦。而 MybatisPlus 则是帮我们减轻这些繁琐的代码的一大利器,它能帮我们自动生成代码,也内置通用CRUD操作,使得我们不用手写一些简单SQL,从而大大减轻了开发代码负担。
三、MybatisPlus 的主要功能
1. 自动生成代码
我们在一个Spring项目中,可以引入 mybatis-plus-generator 来帮助我们创建代码,其原理就是连接数据库,按照你的配置去获取表信息,为其建立起完备的Controller、entity、mapper等层级。那么我们需要在pom中引入这些包。
<!-- Velocity模板引擎,允许任何人仅仅使用简单的模板语言来引用由java代码定义的对象 -->
<dependency>
<groupId>org.apache.velocity</groupId>
<artifactId>velocity-engine-core</artifactId>
<version>2.0</version>
</dependency>
<!-- mybatis-plus 本尊 -->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus</artifactId>
<version>3.5.3.2</version>
</dependency>
<!-- mybatis-plus 生成器,和本体是两个独立的包 -->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-generator</artifactId>
<version>3.5.3.2</version>
</dependency>
<!-- 数据库驱动 -->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>8.0.25</version>
</dependency>
然后代码上只需要写一个类就可以了,设定好数据库信息、文件生成目录以及一些策略,直接执行main方法就可以生成一堆东西
public class myProjectCreator {
public static void main(String[] args) {
FastAutoGenerator.create("jdbc:mysql://127.0.0.1:3306/kwan?useSSL=false&useUnicode=true&characterEncoding=UTF-8&serverTimezone=Asia/Shanghai", "root", "root")
.globalConfig(builder -> {
builder.author("zhanfu") // 设置作者
.enableSwagger() // 开启 swagger 模式,需要额外引入swagger的包
.outputDir("E:\\IdeaProject\\myOwnPro\\src\\main\\java"); // 指定输出目录
})
.dataSourceConfig(builder -> builder.typeConvertHandler((globalConfig, typeRegistry, metaInfo) -> {
int typeCode = metaInfo.getJdbcType().TYPE_CODE;
if (typeCode == Types.SMALLINT) {
// 自定义类型转换
return DbColumnType.INTEGER;
}
return typeRegistry.getColumnType(metaInfo);
}))
.packageConfig(builder -> {
builder.parent("com.zhanfu.demo") // 设置父包名
.moduleName("samples") // 设置父包模块名
.pathInfo(Collections.singletonMap(OutputFile.xml, "E:\\IdeaProject\\myOwnPro\\src\\main\\resources")); // 设置mapperXml生成路径
})
.strategyConfig(builder -> {
builder.addInclude("^csdn_.*"); // 选取表前缀为csdn的表
})
.execute();
}
}
执行前:
执行后:
可以看到各个层次的类,乃至xml文件都为我们生成了,大大减少了我们这些繁琐的动作。当然这里仅是举例使用,一些更细致的配置,大家可以去官网看看: 代码生成器配置新
2. 内置通用 CRUD 方法
按照在 Mybatis 的惯例,我们大部分的SQL 语句是写在XML文件中的,但是如果采用我们在上面提到过的代码生成器,会发现XML文件是空的
然而,我们也说过 MybatisPlus 内置一些通用的CRUD,这一部分是不用写SQL的。我们直接调用 mapper 层的方法即可。
@Autowired
ICsdnHistorySessionService csdnHistorySessionService;
void deleteHisSession(Integer id) {
csdnHistorySessionService.removeById(id);
}
当我们去看这个mapper 类的时候。会发现其也是空的,
public interface ICsdnHistorySessionService extends IService<CsdnHistorySession> {
}
那么所谓内置的方法,其实都源于其继承的 IService 及 其实现类 ServiceImpl
不难发现,对于一些通用的增删改查的工作,比如根据 ID 查询、插入、更新和删除等操作,开发人员无需编写 SQL 语句,只需要调用相应的方法即可。
3. 条件构造器
我们在第二步提到了,MybatisPlus 内置了一些通用 CRUD 方法,使得我们可以直接调用方法增删改查,而不用手写SQL,但是仍有一些稍复杂的情况,是用内置的SQL处理不了的,这时候我们就可以使用 MybatisPlus 的另一个功能 —— 条件构造器.
在介绍使用前,我们先来看一下提供的构造器关系
我们常用的构造器分为查询 与 更新。如下面这样
@Service
public class CsdnUserInfoServiceImpl extends ServiceImpl<CsdnUserInfoMapper, CsdnUserInfo> implements ICsdnUserInfoService {
public List<CsdnUserInfo> findUserByNickName(String nickName) {
QueryWrapper<CsdnUserInfo> queryWrapper = new QueryWrapper<>();
queryWrapper.like("nick_name", nickName);
return baseMapper.selectList(queryWrapper);
}
public void updateAge() {
UpdateWrapper<CsdnUserInfo> updateWrapper = new UpdateWrapper<>();
updateWrapper.set("age", 30); // 更新年龄为30的用户
updateWrapper.eq("nick_name", "John"); // 更新名字为John的用户
}
}
而 带Lambda的构造器则支持更丰富的lambda表达式,能够构建更复杂的查询条
public List<CsdnUserInfo> findValidUserByNickName() {
LambdaQueryWrapper<CsdnUserInfo> queryWrapper = new LambdaQueryWrapper<>();
queryWrapper.eq(CsdnUserInfo::getNickName, "John") // 名字为John的用户
.eq(CsdnUserInfo::getIsDelete, false)
.orderByDesc(CsdnUserInfo::getId);
return baseMapper.selectList(queryWrapper);
}
总的来说,LambdaQueryWrapper相对于QueryWrapper可以提供更加类型安全、可维护、易读的代码编写方式。但是对于一些简单的查询条件,QueryWrapper也是一种方便快捷的选择。当然最主要的。它的用法也非常契合自然语言,上手比较简单。更多的方法我们可以直接看官网的页面: 条件构造器
4. 其他特性
除了我们上面说的三点,还有一些比较细节的功能,比如
- 提供了分页查询的方法,可以方便地进行分页查询操作。
- 提供了自定义ID的能力,可以自动获取分布式ID再落库
- 提供了@TableLogic来实现逻辑删除
- 多种功能的插件,如乐观锁插件、动态表名插件
四、选择 MybatisPlus 还是 MyBaits
笔者所在的开发组在几年前完成了从 MyBaits
到 MybatisPlus
的迁移,对两者都有比较长时间的使用经验了。对于大部分开发者,我其实是推荐直接使用 MybatisPlus
的,
因为MybatisPlus
也会引入 MyBaits
, 所以并不影响你用 MyBaits
的功能,如果你习惯还是原来的手写SQL的模式,完全可以仅使用 MyBaits
的模式。而且MyBatis
提供了灵活性和可定制性,可以直接编写SQL语句,对于复杂的查询和性能优化有更多的控制权。所以对于大型、复杂的项目或者性能要求高的部分内容,即便引入了MybatisPlus
, 直接手写SQL也是最优解。
而对于一些小项目,或者很多表操作比较简单的场景,则完全可以使用 MybatisPlus
的特性来减轻开发负担,这也是我们采用 MybatisPlus
的原因。
当然,每多一个组件,也会带来更多的学习成本。不过MybatisPlus
的上手十分简单,它的核心内容条件构造器
也相当易学,开发者经过简单的学习就可以快速实现基本的增删改查操作(虽然可能会踩些坑)。所以,无论是初学者还是老手,直接上 MybatisPlus 都是比较推荐的。