【后端】MyBatis-Plus 体系（一）

MyBatis-Plus

一、MyBatis-Plus简介

1. 简介

• MyBatis-Plus（简称 MP）是一个 MyBatis的增强工具，在 MyBatis 的基础上只做增强不做改变，为简化开发、提高效率而生。

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. 框架结构

二、入门案例

1. 开发环境

• IDE：idea 2019.2
• JDK：JDK8+
• 构建工具：maven 3.5.4
• MySQL版本：MySQL 5.7
• Spring Boot：2.6.3
• MyBatis-Plus：3.5.1

2. 创建数据库

2.1 创建表

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;

2.2 添加数据

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工程

3.1 初始化工程

• 使用 Spring Initializr 快速初始化一个 Spring Boot 工程
  
  
  
  

3.2 引入依赖

<dependencies> 
	<dependency> 
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-starter</artifactId> 
		</dependency> 
	<dependency> 
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-starter-test</artifactId> 		
		<scope>test</scope> 
	</dependency> 
	<!-- mybatis-plus 启动器 -->
	<dependency> 
		<groupId>com.baomidou</groupId> 
		<artifactId>mybatis-plus-boot-starter</artifactId> 
		<version>3.5.1</version> 
	</dependency> 
	<!-- lombok 用于简化实体类开发 -->
	<dependency> 
		<groupId>org.projectlombok</groupId> 	
		<artifactId>lombok</artifactId> 	
		<optional>true</optional> 
	</dependency> 
	<!-- mysql 驱动 -->
	<dependency> 
		<groupId>mysql</groupId> 
		<artifactId>mysql-connector-java</artifactId> 
		<scope>runtime</scope> 
	</dependency> 
</dependencies>

3.3 idea中安装lombok插件

4. 编写代码

4.1 配置application.yml

spring: 
  # 配置数据源信息 
  datasource: 
    # 配置数据源类型 
    type: com.zaxxer.hikari.HikariDataSource 
    # 配置连接数据库信息 
    driver-class-name: com.mysql.cj.jdbc.Driver 
    url: jdbc:mysql://localhost:3306/mybatis_plus?characterEncoding=utf-8&useSSL=false 
    username: root 
    password: 123456

注意：
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 orrepresents more

4.2 启动类

• 在Spring Boot启动类中添加@MapperScan注解，扫描mapper包

@SpringBootApplication
@MapperScan("com.alex.mybatisplus.mapper") 
public class MybatisplusApplication { 
	public static void main(String[] args) { 		
		SpringApplication.run(MybatisplusApplication.class, args); 
	} 
}

4.3 添加实体

@Data 
//lombok注解 
public class User { 
	private Long id; 
	private String name; 
	private Integer age; 
	private String email; 
}

• User类编译之后的结果：
  

4.4 添加 mapper

• BaseMapper是MyBatis-Plus提供的模板mapper，其中包含了基本的CRUD方法，泛型为操作的实体类型

// @Repository // 将mapper接口
public interface UserMapper extends BaseMapper<User> { }

4.5 测试

@SpringBootTest 
public 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 注解

4.6 添加日志

• 在application.yml中配置日志输出

# 配置MyBatis日志 
mybatis-plus: 
  configuration: 
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl

三、基本CRUD

1. BaseMapper

• MyBatis-Plus中的基本CRUD在内置的BaseMapper中都已得到了实现，我们可以直接使用

2. 插入

@Test 
public void testInsert(){ 
	// 实现新增用户信息
	User user = new User(null, "张三", 23, "zhangsan@baidu.com"); 
	//INSERT INTO user ( id, name, age, email ) VALUES ( ?, ?, ?, ? ) 
	int result = userMapper.insert(user); 
	System.out.println("受影响行数："+result); 	
	//1475754982694199298 
	System.out.println("id自动获取："+user.getId()); }

3. 删除

// 通过id删除记录
@Test 
public void testDeleteById(){ 
	//通过id删除用户信息 
	//DELETE FROM user WHERE id=? 
	int result = userMapper.deleteById(1475754982694199298L); 	
	System.out.println("受影响行数："+result); 
}

// 通过id批量删除记录
@Test 
public void testDeleteBatchIds(){ 
	//通过多个id批量删除 
	//DELETE FROM user WHERE id IN ( ? , ? , ? ) 
	List<Long> idList = Arrays.asList(1L, 2L, 3L); 
	int result = userMapper.deleteBatchIds(idList); 
	System.out.println("受影响行数："+result); 
}

// 通过map条件删除记录
@Test 
public void testDeleteByMap(){ 
	//根据map集合中所设置的条件删除记录 
	//DELETE FROM user WHERE name = ? AND age = ? 
	Map<String, Object> map = new HashMap<>(); 
	map.put("age", 23); 
	map.put("name", "张三"); 
	int result = userMapper.deleteByMap(map); 
	System.out.println("受影响行数："+result); 
}

4. 修改

@Test 
public void testUpdateById(){ 
	User user = new User(4L, "admin", 22, null); 
	//UPDATE user SET name=?, age=? WHERE id=? 
	int result = userMapper.updateById(user); 
	System.out.println("受影响行数："+result); 
}

5. 查询

// 根据id查询用户信息
@Test 
public void testSelectById(){ 
	//根据id查询用户信息 
	//SELECT id,name,age,email FROM user WHERE id=? 
	User user = userMapper.selectById(4L); 
	System.out.println(user); 
}

// 根据多个id查询多个用户信息
@Test 
public void testSelectBatchIds(){ 
	//根据多个id查询多个用户信息 
	//SELECT id,name,age,email FROM user WHERE id IN ( ? , ? ) 
	List<Long> idList = Arrays.asList(4L, 5L); 
	List<User> list = userMapper.selectBatchIds(idList); 
	list.forEach(System.out::println); 
}

// 通过map条件查询用户信息
@Test 
public void testSelectByMap(){ 
	//通过map条件查询用户信息 
	//SELECT id,name,age,email FROM user WHERE name = ? AND age = ? 
	Map<String, Object> map = new HashMap<>(); 
	map.put("age", 22); 
	map.put("name", "admin"); 
	List<User> list = userMapper.selectByMap(map); 
	list.forEach(System.out::println); 
}

// 查询所有数据
@Test 
public void testSelectList(){ 
	//查询所有用户信息 
	//SELECT id,name,age,email FROM user 
	List<User> list = userMapper.selectList(null); 
	list.forEach(System.out::println); 
}

• 通过观察BaseMapper中的方法，大多方法中都有Wrapper类型的形参，此为条件构造器，可针对于SQL语句设置不同的条件，若没有条件，则可以为该形参赋值null，即查询（删除/修改）所有数据。

6. 通用Service

• 说明:
  • 通用 Service CRUD 封装 IService 接口，进一步封装 CRUD 采用 get 查询单行 remove 删除 list 查询集合 page 分页 前缀命名方式区分 Mapper 层避免混淆，
  • 泛型 T 为任意实体对象
  • 建议如果存在自定义通用 Service 方法的可能，请创建自己的 IBaseService 继承 Mybatis-Plus 提供的基类

6.1 IService

• MyBatis-Plus中有一个接口 IService和其实现类 ServiceImpl，封装了常见的业务层逻辑

6.2 创建Service接口和实现类

/*** UserService继承IService模板提供的基础功能 */ 
public interface UserService extends IService<User> { }

/*** ServiceImpl实现了IService，提供了IService中基础功能的实现 * 若ServiceImpl无法满足业务需求，则可以使用自定的UserService定义方法，并在实现类中实现 */ 
@Service 
public class UserServiceImpl extends ServiceImpl<UserMapper, User> implements UserService { }

6.3 测试查询记录数

@Autowired 
private UserService userService; 

@Test 
public void testGetCount(){ 
	long count = userService.count(); 
	System.out.println("总记录数：" + count); 
}

6.4 测试批量插入

@Test public void testSaveBatch(){ 
	// SQL长度有限制，海量数据插入单条SQL无法实行， 
	// 因此MP将批量插入放在了通用Service中实现，而不是通用Mapper 
	ArrayList<User> users = new ArrayList<>(); 
	for (int i = 0; i < 5; i++) { 
		User user = new User(); 
		user.setName("ybc" + i); 
		user.setAge(20 + i); 
		users.add(user); 
	}
	//SQL:INSERT INTO t_user ( username, age ) VALUES ( ?, ? ) 
	userService.saveBatch(users); 
}