MyBatis-Plus
Mybatis-Plus
MyBatisPlus概述
MyBatisPlus可以节省我们大量工作时间，所有的CRUD代码它都可以自动化完成！
类似 JPA、 tk-mapper、MyBatisPlus
简介
MyBatis本来就是简化JDBC开发的
特性
- 无侵入：只做增强不做改变，引入它不会对现有工程产生影响，如丝般顺滑
- 损耗小：启动即会自动注入基本 CURD，性能基本无损耗，直接面向对象操作，BaseMapper
- 强大的 CRUD 操作：内置通用 Mapper、通用 Service，仅仅通过少量配置即可实现单表大部分 CRUD 操作，更有强大的条件构造器，满足各类使用需求，以后简单的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 操作智能分析阻断，也可自定义拦截规则，预防误操作
快速入门
地址：https://mp.baomidou.com/guide/quick-start.html#初始化工程
使用第三方组件：
1.导入对应的依赖
2.研究依赖如何配置
3.代码如何编写
4.提高扩展技术能力！
步骤
1.创建数据库 'mybatisplus'
2.创建user表
DROP TABLE IF EXISTS user;
CREATE TABLE user
(
id BIGINT(20) NOT NULL COMMENT '主键ID',
name VARCHAR(30) NULL DEFAULT NULL COMMENT '姓名',
age INT(11) NULL DEFAULT NULL COMMENT '年龄',
email VARCHAR(50) NULL DEFAULT NULL COMMENT '邮箱',
PRIMARY KEY (id)
);
--真实开发中 ，version（乐观锁），deleted（逻辑删除）、gmt_create、gmt_modified
3.编写项目，初始化项目！使用SpringBoot初始化！
4.导入依赖
<!-- 数据库驱动 -->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
</dependency>
<!-- lombok驱动 -->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
</dependency>
<!-- mybatis-plus -->
<!-- mybatis-plus 是自己开发的，并非官方的 -->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.0.5</version>
</dependency>
说明：我们使用mybatis-plus可以节省我们大量的代码，尽量不要同时导入mybatis和mybatis-plus，版本的差异！
5.连接数据库！这一步和mybatis相同
#MySQL 5 驱动不同
spring.datasource.username=root
spring.datasource.password=root
#userSSL=false 是否开启安全连接 true开启 false关闭-----useUnicode=true&characterEncoding=utf-8：设置存储的字符编码
spring.datasource.url=jdbc:mysql://localhost:3306/mybatisplus?userSSL=false&useUnicode=true&characterEncoding=utf-8&serverTimezone=GMT%2B8
#com.mysql.cj.jdbc.Driver：mysql8的驱动配置，要加时区 serverTimezone=GMT%2B8
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
我们在连接mysql数据库的时候一般都会在url后面添加useUnicode=true&characterEncoding=UTF-8 ，但是问什么要添加呢？
添加的作用是：指定字符的编码、解码格式。
例如：mysql数据库用的是gbk编码，而项目数据库用的是utf-8编码。这时候如果添加了useUnicode=true&characterEncoding=UTF-8 ，那么作用有如下两个方面：
-
存数据时：
数据库在存放项目数据的时候会先用UTF-8格式将数据解码成字节码，然后再将解码后的字节码重新使用GBK编码存放到数据库中。
2.取数据时：
在从数据库中取数据的时候，数据库会先将数据库中的数据按GBK格式解码成字节码，然后再将解码后的字节码重新按UTF-8格式编码数据，最后再将数据返回给客户端。
6.传统方式pojo-dao（连接mybatis，配置mapper.xml文件）-service-controller
7、使用了mybatis-plus之后
@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
private long id;
private String name;
private String age;
private String email;
}
mapper接口
```java
package com.mybatisplus.mybatis_plus.mapper;
import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.mybatisplus.mybatis_plus.pojo.User;
import org.springframework.stereotype.Repository;
//在对应的Mapper上面实现基本的接口 BaseMapper、
@Repository //代表持久层
public interface UserMapper extends BaseMapper<User> {
// 所有的CRUD操作已经编写完成
// 你不需要像以前配置一大堆文件了
}
注意点，我们需要在主启动类上去扫描我们的mapper包下的所有接口 @MapperScan("com.mybatisplus.mybatis_plus.mapper")
测试类中测试
package com.mybatisplus.mybatis_plus;
import com.mybatisplus.mybatis_plus.mapper.UserMapper;
import com.mybatisplus.mybatis_plus.pojo.User;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import java.util.List;
@SpringBootTest
class MybatisPlusApplicationTests {
// 继承了BaseMapper，所有的方法都来自于自己父类
// 我们也可以编写自己的扩展方法
@Autowired
private UserMapper userMapper;
@Test
void contextLoads() {
// 查询全部用户
// 参数是一个Wrapper，条件构造器，这里我们先不用 null
List<User> users = userMapper.selectList(null);
for (User user : users) {
System.out.println(user);
}
}
}
结果
思考问题
1、SQL谁帮我们写的？MyBatis-Plus都写好了
2、方法哪里来的？MyBatis-Plus都写好了
配置日志
#配置日志
mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl
配置完毕日志之后，后面的学习就需要注意这个自动生成的SQL。
CRUD扩展
Insert（插入）
// 测试插入
@Test
public void testInsert(){
User user = new User();
user.setName("小绿绿");
user.setAge(18);
user.setEmail("19876352891@qq.com");
int result = userMapper.insert(user);
System.out.println(result);
System.out.println(user);
}
数据库插入的id默认值为：全局的唯一id
主键生成策略
默认ID_WORKER全局唯一id
分布式系统唯一id生成：https://www.cnblogs.com/haoxinyue/p/5208136.html
雪花算法：
snowflake是Twitter开源的分布式ID生成算法，结果是一个long型的ID。其核心思想是：使用41bit作为毫秒数，10bit作为机器的ID（5个bit是数据中心，5个bit的机器ID），12bit作为毫秒内的流水号（意味着每个节点在每毫秒可以产生 4096 个 ID），最后还有一个符号位，永远是0。
主键自增
我们需要配置主键自增：
1、实体类字段上@TableId(type = IdType.AUTO)
2、数据库字段一定要是自增！
3、再次测试即可！
其余的源码解释
public enum IdType {
AUTO(0), //数据库id自增
NONE(1), //未设置主键
INPUT(2), //手动输入
ID_WORKER(3), //默认的全局唯一ID
UUID(4), //全局唯一ID uuid
ID_WORKER_STR(5); //ID_WORKER 字符串表示法
Update（更新）
// 测试更新
@Test
public void testUpdate(){
User user = new User();
user.setId(2L);
user.setName("小灰灰");
// 注意：updateById 但是参数是一个 对象！
int i = userMapper.updateById(user);
System.out.println(i);
}
所有的SQL都是帮你动态配置的！
自动填充
创建时间！修改时间！这个操作一般都是自动化完成的，我们不希望手动更新！
阿里巴巴开发手册：所有的数据库表：gmt_create、gmt_modified 几乎所有的表都要配置上！而且需要自动化！
方式一：数据库级别修改(工作中不允许你修改数据库)
数据库级别
1、在表中新增字段create_time、update_time
2、再次测试插入方法，需要先把实体类同步！
private Date createTime;
private Date updateTime;
3、再次更新查看即可
方式二：代码级别
代码级别
1、删除数据库默认值、更新操作
2、实体类字段属性上需要增加注解
// @TableField 字段属性注解 FieldFill insert 添加时触发 Update 更新是触发
@TableField(fill = FieldFill.INSERT)
private Date createTime;
// 因为在添加是更新也应该是有值的
@TableField(fill = FieldFill.INSERT_UPDATE)
private Date updateTime;
3、编写处理器来处理这个注解
package com.mybatisplus.mybatis_plus.handler;
import com.baomidou.mybatisplus.core.handlers.MetaObjectHandler;
import lombok.extern.slf4j.Slf4j;
import org.apache.ibatis.reflection.MetaObject;
import org.springframework.stereotype.Component;
import java.util.Date;
@Slf4j //日志
@Component // 一定不要忘记把处理器交由IOC容器中
public class MyMetaObjectHandler implements MetaObjectHandler {
// 插入时的填充
@Override
public void insertFill(MetaObject metaObject) {
log.info("start insert fill.....");
// setFieldValByName(String fieldName, Object fieldVal, MetaObject metaObject)
/*
* 第一个参数是 字段名
* 第二个参数是 字段值
* 第三个参数是 交由谁处理
* */
this.setFieldValByName("createTime",new Date(),metaObject);
this.setFieldValByName("updateTime",new Date(),metaObject);
}
// 更新时的填充
@Override
public void updateFill(MetaObject metaObject) {
log.info("start update fill.....");
this.setFieldValByName("updateTime",new Date(),metaObject);
}
}
4、测试插入
5、测试更新，观察时间即可！
乐观锁
乐观锁：顾名思义十分乐观；它总是认为不会出现问题，无论干什么不去上锁！如果出现问题，再次更新值测试
悲观锁：顾名思义十分悲观；它总是认为总是出现问题，无论干什么都会上锁！再去操作！
乐观锁机制
乐观锁实现方式：
- 取出记录时，获取当前version
- 更新时，带上这个version
- 执行更新时， set version = newVersion where version = oldVersion
- 如果version不对，就更新失败
乐观锁：1.先查询，获得版本号 version = 1
-- A
update user set name = "xiaohong",version = version +1
where id = 2 and version = 1;
-- B 想成抢先完成，这个时候 version = 2，会导致 A 修改失败！
update user set name = "xiaohong",version = version +1
where id = 2 and version = 1;
测试MyBatis-Plus的乐观锁插件
1、给数据库中增加version字段
2、实体类加对应的字段
@Version // 乐观锁 Version 注解
private Integer version;
3、注册主键
// 扫描我们的 mapper 文件夹
@MapperScan("com.mybatisplus.mybatis_plus.mapper")
@EnableTransactionManagement //自动注解配置
@Configuration //配置类
public class MyBatisPlusConfig {
// 注册乐观锁插件
@Bean
public OptimisticLockerInterceptor optimisticLockerInterceptor(){
return new OptimisticLockerInterceptor();
}
}
4、测试一下
// 测试乐观锁成功
@Test
public void tesOptimisticLocker(){
// 查询用户信息
User user = userMapper.selectById(1L);
// 修改用户信息
user.setName("小恐龙");
user.setEmail("23456789@qq.com");
// 执行更新操作
userMapper.updateById(user);
}
// 模拟乐观锁失败
@Test
public void testOptimisticLocker(){
// 线程1
User user = userMapper.selectById(1L);
user.setName("小乐乐");
user.setEmail("21345678@qq.com");
// 模拟另外一个线程执行了插队操作
User user1 = userMapper.selectById(1L);
user1.setName("小绿帽");
user1.setEmail("23451678@qq.com");
userMapper.updateById(user1);
// 自旋锁来多次尝试提交
userMapper.updateById(user); // 如果没有乐观锁就会覆盖插队线程的值
}
Select（查询）
// 测试查询
@Test
public void testSelectById(){
User user = userMapper.selectById(1L);
System.out.println(user);
}
// 测试批量查询
@Test
public void testSelectByBatchId(){
List<User> users = userMapper.selectBatchIds(Arrays.asList(1, 2, 3));
users.forEach(System.out::println);
}
// 按条件查询之一 map操作
@Test
public void testSelectByBatchIds(){
HashMap<String, Object> map = new HashMap<>();
// 自定义查询条件
map.put("name","小绿绿");
map.put("age","10");
userMapper.selectByMap(map);
}
分页查询
1、原始的 limit 分页查询
2、pageHelper第三方插件
3、MyBatisPlus 其实也内置了分页插件
如何使用
1、配置拦截器组件即可
// 旧版 分页插件
@Bean
public PaginationInterceptor paginationInterceptor() {
return new PaginationInterceptor();
}
2、直接使用Page对象即可
// 测试分页查询
@Test
public void testPage(){
// 参数一：当前页
// 参数二：页面的大小
// 使用分页插件之后，所有的分页操作也变得简单的！
Page<User> page = new Page<>(1, 5);
userMapper.selectPage(page,null);
// 打印总记录数
System.out.println(page.getTotal());
page.getRecords().forEach(System.out::println);
}
Delete（删除）
// 测试通过ID删除
@Test
public void testDeleteById(){
userMapper.deleteById(1390488893872721923L);
}
// 批量通过ID删除
@Test
public void testDeleteByBatchIds(){
userMapper.deleteBatchIds(Arrays.asList(2,3));
}
// 通过 Map 删除
@Test
public void testDeleteByMao(){
HashMap<String, Object> map = new HashMap<>();
// 自定义删除条件
map.put("name","小红红");
userMapper.deleteByMap(map);
}
逻辑删除
物理删除 ：从数据库中直接移除
逻辑删除 ：在数据库中没有被移除，而是通过一个变量来让它失效！ deleted = 0 =》deleted = 1
1、在实体类中添加一个 deleted 字段
默认值给0
2、实体类加上对应的字段
@TableLogic //逻辑删除
private Integer deleted;
3、配置（高版本只需要注解就可以，忽略这一步）
// 逻辑删除插件
@Bean
public ISqlInjector sqlInjector(){
return new LogicSqlInjector();
}
}
#配置逻辑删除
#删除的值 就让其为 1
mybatis-plus.global-config.db-config.logic-delete-value=1
#没有删除的值 未删除的就让其为 0
mybatis-plus.global-config.db-config.logic-not-delete-value=0
4、测试一下删除
记录依然存在数据库当中，但是值确实发生了变化
性能分析插件
性能分析插件（旧版;新版见官方文档）
平时开发当中；会遇见一些慢sql。测试！druid....
作用：性能分析拦截器；用于输出每条SQL语句及其执行时间
MyBatis-Plus 也提供了性能分析插件，如果超过这个时间就停止运行！
1、导入插件
/**
* SQL执行效率插件
*/
@Bean
@Profile({"dev","test"}) // 设置 dev test 环境开启；保证我们的效率
public PerformanceInterceptor performanceInterceptor(){
PerformanceInterceptor performanceInterceptor = new PerformanceInterceptor();
// 此功能在项目中用的较多
performanceInterceptor.setMaxTime(1000); //设置SQL执行的最大时间；如果超过了则不执行；默认单位是毫秒
performanceInterceptor.setFormat(true); // SQL格式化
return performanceInterceptor ;
}
要在SpringBoot 中配置环境为 dev 或者 test 环境
#设置开发环境
spring.profiles.active=dev
2、测试使用
@Test
public void contextLoads() {
//查询全部用户
// 参数是一个Wrapper，条件构造器，这里我们先不用 就直接写 null
List<User> users = userMapper.selectList(null);
for (User user : users) {
System.out.println(user);
}
}
条件构造器
十分重要：Wrapper
复杂SQL就可以使用它来替代
1、测试一
@Test
public void contextLoads() {
// 查询 name 不为空的用户，并且邮箱不为空的用户；年龄大于等于12
QueryWrapper<User> wrapper = new QueryWrapper<>();
/**
* isNotNull ：不为空
* ge ： 大于
*/
wrapper.isNotNull("name")
.isNotNull("email")
.ge("age","12");
userMapper.selectList(wrapper).forEach(System.out::println);
}
2、测试二
@Test
public void test2(){
// 查询名字为 小绿帽
QueryWrapper<User> wrapper = new QueryWrapper<>();
// eq 同步或者相等
wrapper.eq("name","小红红");
User user = userMapper.selectOne(wrapper); //查询一个数据，如果出现多个结果使用List
System.out.println(user);
}
3、测试三
@Test
public void test3(){
// 查询名字在 20 ~ 30 岁之间的用户
QueryWrapper<User> wrapper = new QueryWrapper<>();
// between 查询key值在多少到多少之间
wrapper.between("age","20","30");
// selectCount 查询结果数量
userMapper.selectCount(wrapper);
}
4、测试四
// 模糊查询
@Test
public void test4(){
// 模糊查询
QueryWrapper<User> wrapper = new QueryWrapper<>();
// 左和右 t% notlike 不包含那个字符
wrapper.notLike("name","红").likeRight("email","2");
List<Map<String, Object>> maps = userMapper.selectMaps(wrapper);
maps.forEach(System.out::println);
}
5、测试五
// 子查询
@Test
public void test5(){
QueryWrapper<User> wrapper = new QueryWrapper<>();
wrapper.inSql("id","select id from user where id < 3");
List<Object> objects = userMapper.selectObjs(wrapper);
objects.forEach(System.out::println);
}
6、测试六
// 排序查询
@Test
public void test6(){
QueryWrapper<User> wrapper = new QueryWrapper<>();
// 通过id 排序
wrapper.orderByDesc("id");
List<User> users = userMapper.selectList(wrapper);
users.forEach(System.out::println);
}
代码自动生成器
AutoGenerator是Mybatis-Plus的代码生成器，通过AutoGenerator可以快速生成Entity、Mapper、Mapper XML、Service、Controller
等各个模块的代码，极大的提升了开发效率
测试
package com.mybatisplus.mybatis_plus;
import com.baomidou.mybatisplus.annotation.DbType;
import com.baomidou.mybatisplus.annotation.FieldFill;
import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.generator.AutoGenerator;
import com.baomidou.mybatisplus.generator.config.DataSourceConfig;
import com.baomidou.mybatisplus.generator.config.GlobalConfig;
import com.baomidou.mybatisplus.generator.config.PackageConfig;
import com.baomidou.mybatisplus.generator.config.StrategyConfig;
import com.baomidou.mybatisplus.generator.config.po.TableFill;
import com.baomidou.mybatisplus.generator.config.rules.DateType;
import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;
import java.util.ArrayList;
/**
* 代码自动生成器配置类
*/
public class AutoConfig {
public static void main(String[] args) {
// 需要构建一个 代码自动生成器 对象
AutoGenerator mpg = new AutoGenerator();
// 配置策略
// 1、全局配置
GlobalConfig gc = new GlobalConfig();
// 获取用户目录
String propertyPath = System.getProperty("user.dir");
// 设置路径
gc.setOutputDir(propertyPath + "/src/main/java");
// 设置作者名字
gc.setAuthor("小灰灰");
// 设置是否打开资源管理器
gc.setOpen(false);
// 是否覆盖原来生成的
gc.setFileOverride(false);
// 去除service的I前缀
gc.setServiceName("%sService");
// 让 ID 保持最初的算法
gc.setIdType(IdType.ID_WORKER);
// 日期的类型
gc.setDateType(DateType.ONLY_DATE);
// 配置Swagger
gc.setSwagger2(true);
// 设置全局配置
mpg.setGlobalConfig(gc);
// 2、设置数据源
DataSourceConfig dsc = new DataSourceConfig();
// 设置数据库连接的URL
dsc.setUrl("jdbc:mysql://localhost:3306/mybatisplus?userSSL=false&useUnicode=true&characterEncoding=utf-8&serverTimezone=GMT%2B8");
// 设置数据库连接驱动
dsc.setDriverName("com.mysql.cj.jdbc.Driver");
// 设置数据库用户名
dsc.setUsername("root");
// 设置数据库密码
dsc.setPassword("root");
// 设置数据库类型
dsc.setDbType(DbType.MYSQL);
mpg.setDataSource(dsc);
// 3、包的配置
PackageConfig pc = new PackageConfig();
pc.setModuleName("blog");
pc.setParent("com.mybatisplus.mybatis_plus");
pc.setEntity("entity");
pc.setMapper("mapper");
pc.setService("service");
pc.setController("controller");
mpg.setPackageInfo(pc);
// 4、策略配置
StrategyConfig strategy = new StrategyConfig();
// 设置要映射表名；可以包含多张表
strategy.setInclude("user");
// 命名规则，驼峰命名
strategy.setNaming(NamingStrategy.underline_to_camel);
// 列的名字也支持下划线转驼峰命名
strategy.setColumnNaming(NamingStrategy.underline_to_camel);
// 自动生成lombok
strategy.setEntityLombokModel(true);
// 配置逻辑删除字段
strategy.setLogicDeleteFieldName("deleted");
// 自动填充配置
TableFill createTime = new TableFill("createTime", FieldFill.INSERT);
TableFill updateTime = new TableFill("updateTime", FieldFill.INSERT_UPDATE);
// 设置自动填充
ArrayList<TableFill> tableFills = new ArrayList<>();
tableFills.add(createTime);
tableFills.add(updateTime);
strategy.setTableFillList(tableFills);
// 乐观锁
strategy.setVersionFieldName("version");
// 开启controller层的驼峰命名
strategy.setRestControllerStyle(true);
// 请求变成下划线命名
// localhost；8080/hello_id_2
strategy.setControllerMappingHyphenStyle(true);
mpg.setStrategy(strategy);
// 执行
mpg.execute();
}
}
导入的依赖
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.0.5</version>
</dependency>
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-generator</artifactId>
<version>3.0.5</version>
</dependency>
<dependency>
<groupId>org.apache.velocity</groupId>
<artifactId>velocity-engine-core</artifactId>
<version>2.3</version>
</dependency>
效果图
练习源码在Gitee：
https://gitee.com/luo-yun1/framework-code-notes
浙公网安备 33010602011771号