前言:MyBatis-Plus是一个 MyBatis 的增强工具包,自动注入单表基本的CRUD操作,大大解放了开发者的生产力。下面会讲解如何在 Spring Boot 中快速集成 Mybatis-Plus 框架入门。
在说 MyBatis-Plus 之前,先回顾一下什么是 MyBatis:
MyBatis 是一款优秀的持久层框架,它支持自定义 SQL、存储过程以及高级映射。MyBatis 免除了几乎所有的 JDBC 代码以及设置参数和获取结果集的工作。MyBatis 可以通过简单的 XML 或注解来配置和映射原始类型、接口和 Java POJO(Plain Old Java Objects,普通老式 Java 对象)为数据库中的记录。
MyBatis-Plus 是一个 MyBatis 的增强工具,就像 IPhone手机一般都有个 plus 版本一样,它在 MyBatis 的基础上只做增强不做改变,为简化开发、提高效率而生。
MyBatis-Plus 的愿景是成为 MyBatis 最好的搭档,就像魂斗罗中的 1P、2P,基友搭配,效率翻倍。
无侵入:只做增强不做改变,引入它不会对现有工程产生影响,如丝般顺滑
损耗小:启动即会自动注入基本 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 操作智能分析阻断,也可自定义拦截规则,预防误操作
简单来说,MyBatis 支持的数据库,MyBatis-Plus 都支持, 如 MySQL、MariaDB、Oracle、DB2、H2、HSQL、SQLite、Postgre、SQLServer 等。
本博客以操作 MySQL 数据库为例,造一批测试数据:
新建一个名为 test
的测试数据库,创建一张用户表,Schema 建表脚本如下:
DROP TABLE IF EXISTS user;
CREATE TABLE `user` (
`id` bigint(20) UNSIGNED NOT NULL AUTO_INCREMENT COMMENT '主键ID',
`name` varchar(30) NOT NULL DEFAULT '' COMMENT '姓名',
`age` int(11) NULL DEFAULT NULL COMMENT '年龄',
`gender` tinyint(2) NOT NULL DEFAULT 0 COMMENT '性别,0:女 1:男',
PRIMARY KEY (`id`)
) COMMENT = '用户表';
再插入一些测试数据:
DELETE FROM user;
INSERT INTO user (name, age, gender) VALUES
('何哥1', 16, 0),
('何哥2', 18, 1),
('何哥3', 20, 0),
('何哥4', 28, 1),
('何哥5', 30, 0);
数据库准备好了,我们新建一个 Spring Boot 项目来讲解如何使用 Mybatis-Plus。
测试项目目录结构如下:
Spring Boot 整合 mybatis-plus 项目结构全新的
MyBatis-Plus
3.0 版本基于 JDK8,提供了lambda
形式的调用,所以安装集成 Mybatis-Plus 3.0 要求如下:
JDK 8+;
Maven or Gradle, 本文以 maven 作为版本管理工具;
新建好 Spring Boot 项目后,在 pom.xml
文件中添加以下依赖:
com.baomidou
mybatis-plus-boot-starter
3.4.2
org.springframework.boot
spring-boot-starter-test
test
org.projectlombok
lombok
1.16.10
mysql
mysql-connector-java
PS: MyBatis-Plus 的最新版本为
3.4.2
。警告:引入
MyBatis-Plus
之后请不要再次引入MyBatis
以及MyBatis-Spring
,以避免因版本差异导致的问题。
接下来,在 applicaiton.yml 配置文件中添加 MySQL 数据库的相关配置:
# 数据库配置
spring:
datasource:
driver-class-name: com.mysql.cj.jdbc.Driver
url: jdbc:mysql://127.0.0.1:3306/test?useUnicode=ture&characterEncoding=UTF8&serverTimezone=GMT%2B8
username: root
password: qwe123
配置好数据库驱动、连接、用户名和密码。
然后,在 Spring Boot 启动类中添加 @MapperScan
注解,配置好 Mapper 文件夹的全路径,作用是为了 mybatis-plus 能够扫描到:
@SpringBootApplication
@MapperScan("com.quanxiaoha.mybatisplusdemo.mapper")
public class MybatisPlusDemoApplication {
public static void main(String[] args) {
SpringApplication.run(MybatisPlusDemoApplication.class, args);
}
}
前面已经建好了用户表,下面编写用户表对应的实体类 User.java
:
@Data
@Builder
//定义表名:当数据库名与实体类名不一致或不符合驼峰命名时,需要在此注解指定表名
//@TableName(value = "user")
public class User {
//指定主键自增策略:value与数据库主键列名一致,若实体类属性名与表主键列名一致可省略value
@TableId(value = "id",type = IdType.AUTO)
private Long id;
private String name;
private Integer age;
private Integer gender;
}
@TableId(type = IdType.AUTO)注解:指定了字段 id
为表的主键,同时指定主键为自增类型。
@Builder注解:lombok的@Builder实际是建造者模式的一个变种,所以在创建对象时常使用。使用了@Bulider注解后,就可以使用链式风格优雅地创建对象。
编写 Mapper 接口 UserMapper.java
:
public interface UserMapper extends BaseMapper {
}
编写的接口需要继承 BaseMapper
接口,该接口源码定义了一些通用的操作数据库方法, 单表大部分 CRUD 操作都能直接搞定,相比原生的 mybatis,效率提高了很多:
public interface BaseMapper extends Mapper {
int insert(T entity);
int deleteById(Serializable id);
int deleteByMap(@Param("cm") Map columnMap);
int delete(@Param("ew") Wrapper queryWrapper);
int deleteBatchIds(@Param("coll") Collection extends Serializable> idList);
int updateById(@Param("et") T entity);
int update(@Param("et") T entity, @Param("ew") Wrapper updateWrapper);
T selectById(Serializable id);
List selectBatchIds(@Param("coll") Collection extends Serializable> idList);
List selectByMap(@Param("cm") Map columnMap);
T selectOne(@Param("ew") Wrapper queryWrapper);
Integer selectCount(@Param("ew") Wrapper queryWrapper);
List selectList(@Param("ew") Wrapper queryWrapper);
List
添加测试类,对用户表进行增删改查操作, 测试代码如下:
@RunWith(SpringRunner.class)
@SpringBootTest
public class MybatisPlusDemoApplicationTests
{
@Autowired
private UserMapper userMapper;
/**
* 查询数据
*/
@Test
public void testSelectUser() {
System.out.println(("----- 开始测试 mybatis-plus 查询数据 ------"));
// selectList() 方法的参数为 mybatis-plus 内置的条件封装器 Wrapper,这里不填写表示无任何条件,全量查询
List userList = userMapper.selectList(null);
userList.forEach(System.out::println);
}
/**
* 新增一条数据
*/
@Test
public void testInsertUser() {
System.out.println(("----- 开始测试 mybatis-plus 插入数据 ------"));
User user = User.builder()
.name("Mybatis-Plus框架")
.age(30)
.gender(1)
.build();
userMapper.insert(user);
}
/**
* 删除数据
*/
@Test
public void testDeleteUser() {
System.out.println(("----- 开始测试 mybatis-plus 删除数据 ------"));
// 根据主键删除记录
userMapper.deleteById(1);
// 根据主键批量删除记录
userMapper.deleteBatchIds(Arrays.asList(1, 2));
}
/**
* 更新数据
*/
@Test
public void testUpdateUser() {
System.out.println(("----- 开始测试 mybatis-plus 更新数据 ------"));
User user = User.builder()
.id(1L)
.name("Mybatis-Plus框架")
.build();
userMapper.updateById(user);
}
}
总结:本文简单介绍了在 Spring Boot 中如何快速整合集成 Mybatis-Plus, 同时在本地搭建了一个 Mysql 环境,演示了如何通过 Mybatis-Plus 做一些简单的增删改查(CRUD)操作,其他更丰富的功能,大家可以参考官网:MyBatis-Plus
参考链接,感谢大佬犬小哈:
Spring Boot 快速整合 Mybatis-Plus 入门教程 !解放生产力 !
Lombok的@Builder注解的作用