目录
简介
MyBatis-Plus(简称MP)
是一个Mybatis
的增强工具,在MyBatis
的基础上只做功能增强而不做改变,为简化开发、提供效率而产生。
注:喜欢的朋友可以关注公众号“JAVA学习课堂”方便阅读,内容更丰富哦。
特性:
-
无侵入:只做增强不做改变,引入它不会对现有工程产生影响,如丝般顺滑
-
损耗小:启动即会自动注入基本 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 操作智能分析阻断,也可自定义拦截规则,预防误操作
支持数据库:
-
mysql 、mariadb 、oracle 、db2 、h2 、hsql 、sqlite 、postgresql 、sqlserver 、presto 、Gauss 、Firebird
-
Phoenix 、clickhouse 、Sybase ASE 、 OceanBase 、达梦数据库 、虚谷数据库 、人大金仓数据库 、南大通用数据库 、
框架结构:
环境准备:
新建一个名为 test
的测试数据库,并创建一张用户表,建表脚本如下
DROP TABLE IF EXISTS t_user;
CREATE TABLE `t_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 = '用户表';
一、新建 Spring Boot 示例项目
数据库准备好后,来创建一个 Spring Boot 项目,用来讲解 Mybatis Plus,项目结构如下
TIP : 不懂 Spring Boot 的朋友,可以参考之前发布的文章:springboot基础篇(快速入门+要点总结)。
二、添加 Mybatis Plus 依赖
在 pom.xml
文件中添加以下依赖:
<!-- mybatis-plus 依赖 -->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.5.1</version>
</dependency>
<!-- 单元测试依赖 -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
<!-- lombok 依赖(免写 setXXX/getXXX 方法) -->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.16.10</version>
</dependency>
<!-- mysql 依赖 -->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
</dependency>
三、配置管理:
在 application.yml 配置文件中添加 连接数据库的相关配置,(数据库的驱动、连接、用户名、密码):
# 数据库配置
spring:
datasource:
driver-class-name: com.mysql.cj.jdbc.Driver
url: jdbc:mysql://127.0.0.1:3306/test?characterEncoding=utf-8
username: root
password: xxxx
在项目中创建管理配置的文件:
在项目中新建一个 config 包,创建 MyBatis Plus 的配置类:
/**
* @Author: zcm
* @From: 公众号:Java 学习课堂
* @Date: 202-6-1 10:32
* @Version: v1.0.0
* @Description: TODO
**/
@Configuration
@MapperScan("com.quanxiaoha.mybatisplusdemo.mapper")
//@MapperScan 注解用于告诉 Mybatis Plus 框架需要扫描的 mapper 类的包路径,mapper 类主要用于操作数据库
public class MybatisPlusConfig {
}
MyBatis Plus的配置类在项目中是一个非常重要的角色,注意包括如下几个方面:
-
数据源配置,配置数据源的连接信息,包括数据库类型、 URL、用户名、密码等,确保 MyBatis Plus能够正确连接到数据库。
-
MyBatis Plus 全局配置L通过配置类可以进行全局的配置,如自动填充策略、逻辑删除配置、SQL注入器等,这些配置可以保证在整个项目中统一的行为。
-
MyBatis Plus 插件配置:可以配置各种插件,如分页插件、性能分析插件、乐观锁插件、这些插件可以扩展 MyBatis Plus 的功能,提示性能简化开发。
-
自定义配置:通过配置类可以进行各种自定义配置,包括类型处理器、表名生产策略、字段策略等,从而更好的满足项目的需求。
四、创建测试用到的 server、dao、和实体类:
创建实体类,用于和数据库中的字段进行映
@Data
@TableName("t_user")
public class User {
@TableId(type = IdType.AUTO)
private Long id;
private String name;
private Integer age;
private Integer gender;
}
在项目根目录下创建 mapper
包,并新建 UserMapper
接口,同时继承自 BaseMapper
, 代码如下:
public interface UserMapper extends BaseMapper<User> {
}
userMapper接口所继承的 BaseMapper
是由 MyBatis Plu
s 提供的,其中封装了一下常用的 增删改查操作,这使我们无需再像 MyBatis 那样 编写 xml
文件了,就可以简单的使用 CRUD
功能:
public interface BaseMapper<T> extends Mapper<T> {
// 新增数据
int insert(T entity);
// 根据 ID 删除
int deleteById(Serializable id);
// 删除数据
int deleteByMap(@Param("cm") Map<String, Object> columnMap);
// 删除数据
int delete(@Param("ew") Wrapper<T> queryWrapper);
// 根据 ID 批量删除数据
int deleteBatchIds(@Param("coll") Collection<? extends Serializable> idList);
// 根据 ID 更新
int updateById(@Param("et") T entity);
// 更新数据
int update(@Param("et") T entity, @Param("ew") Wrapper<T> updateWrapper);
// 根据 ID 查询
T selectById(Serializable id);
// 根据 ID 批量查询
List<T> selectBatchIds(@Param("coll") Collection<? extends Serializable> idList);
// 查询数据
List<T> selectByMap(@Param("cm") Map<String, Object> columnMap);
// 查询一条数据
T selectOne(@Param("ew") Wrapper<T> queryWrapper);
// 查询记录总数
Integer selectCount(@Param("ew") Wrapper<T> queryWrapper);
// 查询多条数据
List<T> selectList(@Param("ew") Wrapper<T> queryWrapper);
// 查询多条数据
List<Map<String, Object>> selectMaps(@Param("ew") Wrapper<T> queryWrapper);
// 查询多条数据
List<Object> selectObjs(@Param("ew") Wrapper<T> queryWrapper);
// 分页查询
<E extends IPage<T>> E selectPage(E page, @Param("ew") Wrapper<T> queryWrapper);
// 分页查询
<E extends IPage<Map<String, Object>>> E selectMapsPage(E page, @Param("ew") Wrapper<T> queryWrapper);
}
五、测试简单的 CURD
在项目的单元测试包下,重新创建一个测试类 MyBatisPlusDemoTest.java 编写几个测试方法:
@SpringBootTest
class MybatisPlusBaseMapperTests {
@Autowired
private UserMapper userMapper;
/**
* 查询数据
*/
@Test
public void testSelectUser() {
System.out.println(("----- 开始测试 mybatis-plus 查询数据 ------"));
// selectList() 方法的参数为 mybatis-plus 内置的条件封装器 Wrapper,这里不填写表示无任何条件,全量查询
List<User> userList = userMapper.selectList(null);
userList.forEach(System.out::println);
}
/**
* 新增一条数据
*/
@Test
public void testInsertUser() {
System.out.println(("----- 开始测试 mybatis-plus 插入数据 ------"));
User user = User.builder()
.name("Java 学习课堂")
.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("Java学习课堂,感兴趣的朋友点点小手,关注一下把。")
.build();
userMapper.updateById(user);
}
}
注:喜欢的朋友可以关注公众号“JAVA学习课堂”方便阅读,内容更丰富哦。