MyBatisPlus简介与基本CRUD
一、MyBatis-Plus简介
1、简介
MyBatis-Plus (简称 MP)是一个 MyBatis的增强工具,在 MyBatis 的基础上只做增强不做改变,为 简化开发、提高效率而生。Mybatis-Plus提供了通用的Mapper和Service,可以在不编写任何SQL语句的前提下,快速的实现单表的增删改查(CURD),批量,逻辑删除,分页等操作。只要把MyBatis-Plus的特性到优秀插件,以及多数据源的配置进行详细讲解。
愿景:我们的愿景是成为 MyBatis 最好的搭档,就像魂斗罗中的 1P、2P ,基友搭配,效率翻倍。
2、特性
- 无侵入:只做增强不做改变,引入它不会对现有工程产生影响,如丝般顺滑
- 损耗小:启动即会自动注入基本 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 操作智能分析阻断,也可自定义拦截规则,预防 误操作
3、支持数据库
任何能使用MyBatis进行 CRUD, 并且支持标准 SQL 的数据库,具体支持情况如下
MySQL ,Oracle , DB2 , H2 , HSQL ,SQLite , PostgreSQL ,SQLServer , Phoenix ,Gauss , ClickHouse ,Sybase ,OceanBase , Firebird ,Cubrid ,Goldilocks ,csiidb
达梦数据库,虚谷数据库,人大金仓数据库,南大通用(华库)数据库,南大通用数据库,神通数据 库,瀚高数据库
4、框架结构
5、代码及文档地址
官方地址: http://mp.baomidou.com
代码发布地址:
Github: https://github.com/baomidou/mybatis-plus
Gitee: https://gitee.com/baomidou/mybatis-plus
文档发布地址: https://baomidou.com/pages/24112f
二、入门案例
1、开发环境
IDE: idea 2021
JDK:JDK8+
构建工具: maven 3.6。0
MySQL版本: MySQL 5.7
Spring Boot:2.6.3
MyBatis-Plus:3.5.1
2、创建数据库及表
a>创建表
CREATE DATABASE `mybatis_plus` /*!40100 DEFAULT CHARACTER SET utf8mb4 */; use `mybatis_plus`;
CREATE TABLE `user` (
`id` bigint(20) NOT NULL COMMENT \'主键ID\',
`name` varchar(30) DEFAULT NULL COMMENT \'姓名 \',
`age` int(11) DEFAULT NULL COMMENT \'年龄 \',
`email` varchar(50) DEFAULT NULL COMMENT \'邮箱 \',
PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;
b>添加数据
INSERT INTO user (id, name, age, email) VALUES
(1, \'Jone\', 18, \'test1@baomidou.com\'),
(2, \'Jack\', 20, \'test2@baomidou.com\'),
(3, \'Tom\', 28, \'test3@baomidou.com\'),
(4, \'Sandy\', 21, \'test4@baomidou.com\'),
(5, \'Billie\', 24, \'test5@baomidou.com\');
3、创建Spring Boot工程
a>初始化工程
b>引入依赖
4.0.0 com.qcby myBatisPlus_demo 1.0-SNAPSHOT org.springframework.boot spring-boot-starter-parent 2.7.6 org.springframework.boot spring-boot-starter org.springframework.boot spring-boot-starter-test test com.baomidou mybatis-plus-boot-starter 3.5.1 org.projectlombok lombok true mysql mysql-connector-java runtime
c>idea中安装lombok插件
4、编写代码
a>配置application.yml
spring: # 配置数据源信息 datasource:# 配置数据源类型 type: com.zaxxer.hikari.HikariDataSource# 配置连接数据库信息 driver-class-name: com.mysql.cj.jdbc.Driver url: jdbc:mysql://localhost:3306/mybatisplus_demo?characterEncoding=utf-8&useSSL=false username: root password: 2020
注意:
1、驱动类driver-class-name
spring boot 2.0(内置jdbc5驱动),驱动类使用
driver-class-name: com.mysql.jdbc.Driver
spring boot 2.1及以上(内置jdbc8驱动),驱动类使用:
driver-class-name: com.mysql.cj.jdbc.Driver
否则运行测试用例的时候会有 WARN 信息
2、连接地址url
MySQL5.7版本的url:
jdbc:mysql://localhost:3306/mybatis_plus?characterEncoding=utf-8&useSSL=false
MySQL8.0版本的url:
jdbc:mysql://localhost:3306/mybatis_plus?
serverTimezone=GMT%2B8&characterEncoding=utf-8&useSSL=false
否则运行测试用例报告如下错误:
java.sql.SQLException: The server time zone value\'Öйú±ê׼ʱ¼ä\' is unrecognized or represents more
b>启动类
在Spring Boot启动类中添加@MapperScan注解,扫描mapper包
@SpringBootApplication@MapperScan(\"com.qcby.mybatisplus.mapper\")public class MybatisplusApplication { public static void main(String[] args) { SpringApplication.run(MybatisplusApplication.class, args); }}
c>添加实体
@Data //lombok注解public class User { private Long id; private String name; private Integer age; private String email;}
User类编译之后的结果:
d>添加mapper
BaseMapper是MyBatis-Plus提供的模板mapper,其中包含了基本的CRUD方法,泛型为操作的 实体类型
public interface UserMapper extends BaseMapper<User> {
}
e>测试
@SpringBootTestpublic class MybatisPlusTest { @Autowired private UserMapper userMapper; @Test public void testSelectList(){ //selectList()根据MP内置的条件构造器查询一个list集合,null表示没有条件,即查询所有 userMapper.selectList(null).forEach(System.out::println); }}
结果:
注意:
IDEA在 userMapper 处报错,因为找不到注入的对象,因为类是动态创建的,但是程序可以正确 的执行。
为了避免报错,可以在mapper接口上添加 @Repository 注解
f>添加日志
在application.yml中配置日志输出
# 配置MyBatis日志
mybatis-plus:
configuration:
log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
三、基本CRUD
1、 BaseMapper
MyBatis-Plus中的基本CRUD在内置的BaseMapper中都已得到了实现,我们可以直接使用,接口如 下:
BaseMapper中封装的19个基础CRUD方法:
package com.qcby;import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;import com.baomidou.mybatisplus.core.conditions.update.UpdateWrapper;import com.baomidou.mybatisplus.core.metadata.IPage;import com.baomidou.mybatisplus.extension.plugins.pagination.Page;import com.qcby.entity.User;import com.qcby.mapper.UserMapper;import org.junit.jupiter.api.Test;import org.springframework.beans.factory.annotation.Autowired;import org.springframework.boot.test.context.SpringBootTest;import java.util.ArrayList;import java.util.HashMap;import java.util.List;import java.util.Map;@SpringBootTestpublic class MybatisPlusTest { @Autowired private UserMapper userMapper; /*1添加数据*/ @Test public void testInsert() { //INSERT INTO user ( id, name, age, email ) VALUES ( ?, ?, ?, ? ) User user = new User(); user.setName(\"李四\"); user.setAge(25); user.setEmail(\"123@qq.com\"); int result = userMapper.insert(user); System.out.println(\"影响行数:\" + result); } /*2根据id值删除数据*/ @Test public void testDeleteById() { //DELETE FROM user WHERE id=? int result = userMapper.deleteById(2); System.out.println(\"影响行数:\" + result); } /*3根据实体类的id值删除数据*/ @Test public void testDeleteByEntity() { //DELETE FROM user WHERE id=? User user = new User(); user.setId(1L); int result = userMapper.deleteById(user); System.out.println(\"影响行数:\" + result); } /*4通过map条件删除数据*/ @Test public void testDeleteByMap() { //根据map集合中所设置的条件删除记录 //DELETE FROM user WHERE name = ? AND age = ? Map map = new HashMap(); map.put(\"name\", \"张三\"); map.put(\"age\", 23); int result = userMapper.deleteByMap(map); System.out.println(\"受影响行数:\"+result); } /*5根据entity条件删除数据*/ @Test public void testDeleteByEntityCondition() { //DELETE FROM user WHERE name=? AND age=? User user = new User(); user.setName(\"张三\"); user.setAge(25); int result = userMapper.delete(new QueryWrapper(user)); System.out.println(\"受影响行数:\"+result); } /*6批量删除数据*/ @Test public void testDeleteBatchIds() { //批量删除id为3和4的记录 //DELETE FROM user WHERE id IN ( ? , ? ) List list = new ArrayList(); list.add(3L); list.add(4L); int result = userMapper.deleteBatchIds(list); System.out.println(\"受影响行数:\"+result); } /*7根据id值修改数据*/ @Test public void testUpdateById() { //UPDATE user SET age=?, email=? WHERE id=? User user = new User(); user.setId(5L); user.setAge(26); user.setEmail(\"456@qq.com\"); int result = userMapper.updateById(user); System.out.println(\"受影响行数:\"+result); } /*8根据entity条件修改数据*/ @Test public void testUpdateByEntityCondition() { // 假设有一个 UpdateWrapper 对象,设置查询条件为 age > 25,更新满足条件的用户的邮箱 //UPDATE user SET email=? WHERE (age > ?) UpdateWrapper updateWrapper = new UpdateWrapper(); updateWrapper.gt(\"age\", 25); User updateUser = new User(); updateUser.setEmail(\"new.email@example.com\"); int rows = userMapper.update(updateUser, updateWrapper); // 调用 update 方法 if (rows > 0) { System.out.println(\"Users updated successfully.\"); } else { System.out.println(\"No users updated.\"); } } /*9根据id值查询数据*/ @Test public void testSelectById() { //SELECT id,name,age,email FROM user WHERE id=? User user = userMapper.selectById(5L); System.out.println(user); } /*10根据id值批量查询数据*/ @Test public void testSelectBatchIds() { //SELECT id,name,age,email FROM user WHERE id IN ( ? , ? ) List ids = new ArrayList(); ids.add(5L); ids.add(1948664325964873730L); List users = userMapper.selectBatchIds(ids); users.forEach(System.out::println); } /*11根据map条件查询数据*/ @Test public void testSelectByMap() { // 根据map集合中所设置的条件查询记录 // SELECT * FROM user WHERE name = ? AND age = ? Map map = new HashMap(); map.put(\"name\", \"张三\"); map.put(\"age\", 25); List users = userMapper.selectByMap(map); users.forEach(System.out::println); } /*12根据entity条件查询一条记录*/ @Test public void testSelectOneByEntity() { //SELECT id,name,age,email FROM user WHERE name=? AND age=? User user = new User(); user.setName(\"张三\"); user.setAge(25); User result = userMapper.selectOne(new QueryWrapper(user)); System.out.println(result); } /*13根据Wrapper条件,判断是否存在记录*/ @Test public void testExist() { //SELECT COUNT( * ) FROM user WHERE name=? AND age=? User user = new User(); user.setName(\"张三\"); user.setAge(25); boolean exist = userMapper.exists(new QueryWrapper(user)); System.out.println(exist); } /*14查询总记录数*/ @Test public void testCount() { // 查询总记录数 //SELECT COUNT( * ) FROM user WHERE name=? AND age=? User user = new User(); user.setName(\"张三\"); user.setAge(25); Long count = userMapper.selectCount(new QueryWrapper(user)); System.out.println(count); } /*15查询全部数据,返回List集合*/ @Test public void testSelectList() { //SELECT id,name,age,email FROM user WHERE age=? User user = new User(); user.setAge(25); List users = userMapper.selectList(new QueryWrapper(user)); users.forEach(System.out::println); } /*16根据warpper条件查询数据,返回Map集合*/ @Test public void testSelectMaps() { //SELECT id,name,age,email FROM user WHERE age=? User user = new User(); user.setAge(25); List<Map> maps = userMapper.selectMaps(new QueryWrapper(user)); maps.forEach(System.out::println); } /*17根据Wrapper条件查询数据 返回第一个字段的值*/ @Test public void testSelectOne() { //SELECT id,name,age,email FROM user WHERE (age = ?) QueryWrapper wrapper = new QueryWrapper(); wrapper.eq(\"age\", 25); List users =userMapper.selectObjs(wrapper); users.forEach(System.out::println); } /*18根据实体类分页条件查询*/ @Test public void testSelectPage() { //SELECT COUNT(*) AS total FROM user WHERE (age = ?) //SELECT id,name,age,email FROM user WHERE (age = ?) LIMIT ?,? Page page = new Page(2, 1); QueryWrapper wrapper = new QueryWrapper(); wrapper.eq(\"age\", 25); IPage result = userMapper.selectPage(page, wrapper); result.getRecords().forEach(System.out::println); System.out.println(result.getTotal()); } /*19根据Wrapper条件查询所有数据selectMapsPage*/ @Test public void testSelectMapsPage() { // 假设要进行分页查询,每页显示10条记录,查询第1页,查询条件为 age > 25,并将结果映射为 Map //SELECT COUNT(*) AS total FROM user WHERE (age > ?) //SELECT id,name,age,email FROM user WHERE (age > ?) LIMIT ?,? IPage<Map> page = new Page(); page.setCurrent(1); page.setSize(1); QueryWrapper queryWrapper = new QueryWrapper(); queryWrapper.gt(\"age\", 25); IPage<Map> userPageMaps = userMapper.selectMapsPage(page, queryWrapper); // 调用 selectMapsPage 方法 List<Map> userMapList = userPageMaps.getRecords(); long total = userPageMaps.getTotal(); System.out.println(\"Total users (age > 25): \" + total); for (Map userMap : userMapList) { System.out.println(\"User Map: \" + userMap); } }}