MyBatis-Plus简介 简介 MyBatis-Plus (简称MP)是一个 MyBatis 的增强工具,在 MyBatis 的基础上只做增强不做改变 ,为 简化开发、提高效率而生 。
MyBatis-Plus 提供了通用的mapper和service,可以在不编写任何SQL语句的情况下,快速的实现对单表的CRUD、批量、逻辑删除、分页等操作。
特性
无侵入 :只做增强不做改变,引入它不会对现有工程产生影响,如丝般顺滑
损耗小 :启动即会自动注入基本 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
进行 CRUD,并且支持标准 SQL 的数据库,具体支持情况如下:
MySQL,Oracle,DB2,H2,HSQL,SQLite,PostgreSQL,SQLServer,Phoenix,Gauss ,ClickHouse,Sybase,OceanBase,Firebird,Cubrid,Goldilocks,csiidb
达梦数据库,虚谷数据库,人大金仓数据库,南大通用(华库)数据库,南大通用数据库,神通数据库,瀚高数据库
框架结构
入门案例 开发环境
IDE:idea 2021.3
JDK:JDK8+
构建工具:maven 3.8.4
MySQL版本:MySQL 8.0.28
Spring Boot:2.4.1
MyBatis-Plus:3.4.2
创建数据库及表 创建表 1 2 3 4 5 6 7 8 9 CREATE DATABASE `mybatis_plus` ;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;
添加数据 1 2 3 4 5 6 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' );
创建Spring Boot工程 初始化工程 使用 Spring Initializr 快速初始化一个 Spring Boot 工程
引入依赖 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 <dependency > <groupId > com.baomidou</groupId > <artifactId > mybatis-plus-boot-starter</artifactId > <version > 3.4.2</version > </dependency > <dependency > <groupId > org.projectlombok</groupId > <artifactId > lombok</artifactId > <optional > true</optional > </dependency > <dependency > <groupId > mysql</groupId > <artifactId > mysql-connector-java</artifactId > <scope > runtime</scope > </dependency >
IDEA中安装lombok插件
编写代码 配置application.yml 1 2 3 4 5 6 7 8 9 10 spring: datasource: type: com.zaxxer.hikari.HikariDataSource driver-class-name: com.mysql.cj.jdbc.Driver url: jdbc:mysql://localhost:3306/mybatis_plus?serverTimezone=GMT%2B8&characterEncoding=utf-8&useSSL=false username: root password: 12345678
注意:
驱动类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
连接地址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
启动类 在Spring Boot启动类中添加@MapperScan注解,扫描mapper包
1 2 3 4 5 6 7 8 9 10 11 12 13 package com.exercise.mybatis_plus;import org.mybatis.spring.annotation.MapperScan;import org.springframework.boot.SpringApplication;import org.springframework.boot.autoconfigure.SpringBootApplication;@SpringBootApplication @MapperScan("com.exercise.mybatis_plus.mapper") public class MybatisPlusApplication { public static void main (String[] args) { SpringApplication.run(MybatisPlusApplication.class, args); } }
添加实体 1 2 3 4 5 6 7 8 9 10 11 package com.exercise.mybatis_plus.pojo;import lombok.Data;@Data public class User { private Long id; private String name; private Integer age; private String email; }
添加mapper BaseMapper是MyBatis-Plus提供的模板mapper,其中包含了基本的CRUD方法,泛型为操作的实体类型
1 2 3 4 5 6 7 8 9 package com.exercise.mybatis_plus.mapper;import com.baomidou.mybatisplus.core.mapper.BaseMapper;import com.exercise.mybatis_plus.pojo.User;import org.springframework.stereotype.Repository;@Repository public interface UserMapper extends BaseMapper <User > {}
测试 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 package com.exercise.mybatis_plus.test;import com.exercise.mybatis_plus.mapper.UserMapper;import org.junit.jupiter.api.Test;import org.springframework.beans.factory.annotation.Autowired;import org.springframework.boot.test.context.SpringBootTest;@SpringBootTest public class MyBatisPlusTest { @Autowired private UserMapper userMapper; @Test public void testSelectList () { userMapper.selectList(null ).forEach(System.out::println); } }
注意:
IDEA在 userMapper 处报错,因为找不到注入的对象,因为类是动态创建的,但是程序可以正确的执行。
为了避免报错,可以在mapper接口上添加 @Repository 注解
添加日志 在application.yml中配置日志输出
1 2 3 4 mybatis-plus: configuration: log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
基本CRUD BaseMapper MyBatis-Plus中的基本CRUD在内置的BaseMapper中都已得到了实现,我们可以直接使用,接口如下:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 package com.baomidou.mybatisplus.core.mapper;import com.baomidou.mybatisplus.core.conditions.Wrapper;import com.baomidou.mybatisplus.core.metadata.IPage;import java.io.Serializable;import java.util.Collection;import java.util.List;import java.util.Map;import org.apache.ibatis.annotations.Param;public interface BaseMapper <T > extends Mapper <T > { int insert (T entity) ; int deleteById (Serializable id) ; int deleteByMap (@Param("cm") Map<String, Object> columnMap) ; int delete (@Param("ew") Wrapper<T> queryWrapper) ; int deleteBatchIds (@Param("coll") Collection<? extends Serializable> idList) ; int updateById (@Param("et") T entity) ; int update (@Param("et") T entity, @Param("ew") Wrapper<T> updateWrapper) ; T selectById (Serializable 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) ; }
添加 1 2 3 4 5 6 7 @Test public void testInsert () { User user = new User(null ,"小新" ,22 ,"1096463510@qq.com" ); int result = userMapper.insert(user); System.out.println("受影响行数:" + result); System.out.println("id自动获取:" + user.getId()); }
最终执行的结果,所获取的id为1584747080637784065
这是因为MyBatis-Plus在实现插入数据时,会默认基于雪花算法的策略生成id
删除 通过id删除 1 2 3 4 5 @Test public void testDeleteById () { int result = userMapper.deleteById(6 ); System.out.println("受影响行数:" +result); }
通过id批量删除 1 2 3 4 5 6 @Test public void testDeleteBatchIds () { List<Integer> list = Arrays.asList(7 , 8 ); int result = userMapper.deleteBatchIds(list); System.out.println("受影响行数:" +result); }
通过map条件删除 1 2 3 4 5 6 7 8 @Test public void testDeleteByMap () { Map<String,Object> map = new HashMap<>(); map.put("name" ,"bbb" ); map.put("age" ,33 ); int result = userMapper.deleteByMap(map); System.out.println("受影响行数:" +result); }
修改 1 2 3 4 5 6 7 8 @Test public void testUpdateById () { User user = new User(); user.setId(1584747080637784065L ); user.setEmail("1096463510@126.com" ); int result = userMapper.updateById(user); System.out.println("受影响行数:" +result); }
查询 根据id查询 1 2 3 4 @Test public void testSelectById () { System.out.println(userMapper.selectById(1584747080637784065L )); }
根据多个id查询 1 2 3 4 5 @Test public void testSelectBatchIds () { List<Integer> list = Arrays.asList(1 , 2 , 3 , 4 ); userMapper.selectBatchIds(list).forEach(System.out::println); }
通过map条件查询 1 2 3 4 5 6 7 @Test public void testSelectByMap () { Map<String,Object> map = new HashMap<>(); map.put("name" ,"小新" ); map.put("age" ,22 ); userMapper.selectByMap(map).forEach(System.out::println); }
查询所有数据 1 2 3 4 @Test public void testSelectAll () { userMapper.selectList(null ).forEach(System.out::println); }
通过观察BaseMapper中的方法,大多方法中都有Wrapper类型的形参,此为条件构造器 ,可针对于SQL语句设置不同的条件,若没有条件,则可以为该形参赋值null,即查询(删除/修改)所有数据。
通用Service
通用 Service CRUD 封装 IService 接口,进一步封装 CRUD,采用get查询单行、remove删除、list查询集合、page分页,前缀命名方式区分 Mapper 层避免混淆
泛型 T 为任意实体对象
建议如果存在自定义通用 Service 方法的可能,请创建自己的 IBaseService 继承 Mybatis-Plus 提供的基类
IService MyBatis-Plus 中有一个接口 IService 和其实现类 ServiceImpl,封装了常见的业务层逻辑
详情查看源码 IService 和 ServiceImpl
创建Service接口和实现类 1 2 3 4 5 6 7 8 9 10 package com.exercise.mybatis_plus.service;import com.baomidou.mybatisplus.extension.service.IService;import com.exercise.mybatis_plus.pojo.User;public interface UserService extends IService <User > {}
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 package com.exercise.mybatis_plus.service.impl;import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;import com.exercise.mybatis_plus.mapper.UserMapper;import com.exercise.mybatis_plus.pojo.User;import com.exercise.mybatis_plus.service.UserService;import org.springframework.stereotype.Service;@Service public class UserServiceImpl extends ServiceImpl <UserMapper , User > implements UserService {}
测试查询记录数 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 package com.exercise.mybatis_plus.test;import com.exercise.mybatis_plus.service.UserService;import org.junit.jupiter.api.Test;import org.springframework.beans.factory.annotation.Autowired;import org.springframework.boot.test.context.SpringBootTest;@SpringBootTest public class ServiceTest { @Autowired private UserService userService; @Test public void testGetCount () { System.out.println("总记录数:" + userService.count()); } }
测试批量插入 SQL长度有限制,海量数据插入单条SQL无法实行,因此MP将批量插入放在了通用Service中实现,而不是通用Mapper
1 2 3 4 5 6 7 8 9 10 11 12 @Test public void testSaveBatch () { ArrayList<User> usersList = new ArrayList<>(); for (int i = 0 ; i < 5 ; i++){ User user = new User(); user.setName("用户" + i); user.setAge(20 + i); user.setEmail("abcd" + i + "@qq.com" ); usersList.add(user); } userService.saveBatch(usersList); }
常用注解 @TableName 经过以上的测试,在使用MyBatis-Plus实现基本的CRUD时,我们并没有指定要操作的表,只是在Mapper接口继承BaseMapper时,设置了泛型User,而操作的表为user表。
由此得出结论,MyBatis-Plus在确定操作的表时,由BaseMapper的泛型决定,即实体类型决定,且默认操作的表名和实体类型的类名一致。
问题 若实体类类型的类名和要操作的表的表名不一致,会出现什么问题?
我们将表user更名为t_user,测试查询功能程序抛出异常,Table ‘mybatis_plus.user’ doesn’t exist,因为现在的表名为t_user,而默认操作的表名和实体类型的类名一致,即user表。
通过@TableName解决 在实体类类型上添加@TableName(“t_user”),标识实体类对应的表,即可成功执行SQL语句。
通过全局配置解决 在开发的过程中,我们经常遇到以上的问题,即实体类所对应的表都有固定的前缀,例如t_
或tbl_
此时,可以使用MyBatis-Plus提供的全局配置,为实体类所对应的表名设置默认的前缀,那么就不需要在每个实体类上通过@TableName标识实体类对应的表。
@TableId 经过以上的测试,MyBatis-Plus在实现CRUD时,会默认将id作为主键列,并在插入数据时,默认基于雪花算法的策略生成id 。
问题 若实体类和表中表示主键的不是id,而是其他字段,例如uid,MyBatis-Plus会自动识别uid为主键列吗?
我们实体类中的属性id改为uid,将表中的字段id也改为uid,测试添加功能程序抛出异常,Field ‘uid’ doesn’t have a default value,说明MyBatis-Plus没有将uid作为主键赋值。
通过@TableId解决 在实体类中uid属性上通过@TableId将其标识为主键,即可成功执行SQL语句。
@TableId的value属性 若实体类中主键对应的属性为id,而表中表示主键的字段为uid,此时若只在属性id上添加注解 @TableId,则抛出异常Unknown column ‘id’ in ‘field list’,即MyBatis-Plus仍然会将id作为表的主键操作,而表中表示主键的是字段uid。
此时需要通过@TableId注解的value属性,指定表中的主键字段,@TableId(“uid”) 或 @TableId(value=”uid”)
@TableId的type属性 type属性用来定义主键策略 。
值
描述
IdType.ASSIGN_ID(默认)
基于雪花算法的策略生成数据id,与数据库id是否设置自增无关
IdType.AUTO
使用数据库的自增策略,注意,该类型请确保数据库设置了id自增, 否则无效
雪花算法 背景 需要选择合适的方案去应对数据规模的增长,以应对逐渐增长的访问压力和数据量。
数据库的扩展方式主要包括:业务分库、主从复制,数据库分表。
数据库分表 将不同业务数据分散存储到不同的数据库服务器,能够支撑百万甚至千万用户规模的业务,但如果业务继续发展,同一业务的单表数据也会达到单台数据库服务器的处理瓶颈。例如,淘宝的几亿用户数据,如果全部存放在一台数据库服务器的一张表中,肯定是无法满足性能要求的,此时就需要对单表数据进行拆分。
单表数据拆分有两种方式:垂直分表和水平分表 。示意图如下:
垂直分表 垂直分表适合将表中某些不常用且占了大量空间的列拆分出去 。
例如,前面示意图中的 nickname 和 description 字段,假设我们是一个婚恋网站,用户在筛选其他用户的时候,主要是用 age 和 sex 两个字段进行查询,而 nickname 和 description 两个字段主要用于展示,一般不会在业务查询中用到。description 本身又比较长,因此我们可以将这两个字段独立到另外一张表中,这样在查询 age 和 sex 时,就能带来一定的性能提升。
水平分表 水平分表适合表行数特别大的表 ,有的公司要求单表行数超过 5000 万就必须进行分表,这个数字可以作为参考,但并不是绝对标准,关键还是要看表的访问性能。对于一些比较复杂的表,可能超过 1000 万就要分表了;而对于一些简单的表,即使存储数据超过 1 亿行,也可以不分表。
但不管怎样,当看到表的数据量达到千万级别时,作为架构师就要警觉起来,因为这很可能是架构的性能瓶颈或者隐患。
水平分表相比垂直分表,会引入更多的复杂性,例如要求全局唯一的数据id该如何处理 。
主键自增
以最常见的用户 ID 为例,可以按照 1000000 的范围大小进行分段,1 ~ 999999 放到表1中, 1000000 ~ 1999999 放到表2中,以此类推。
复杂点 :分段大小的选取。分段太小会导致切分后子表数量过多,增加维护复杂度;分段太大可能会导致单表依然存在性能问题,一般建议分段大小在 100 万至 2000 万之间,具体需要根据业务选取合适的分段大小。
优点 :可以随着数据的增加平滑地扩充新的表。例如,现在的用户是 100 万,如果增加到 1000 万, 只需要增加新的表就可以了,原有的数据不需要动。
缺点 :分布不均匀。假如按照 1000 万来进行分表,有可能某个分段实际存储的数据量只有 1 条,而 另外一个分段实际存储的数据量有 1000 万条。
取模
同样以用户 ID 为例,假如我们一开始就规划了 10 个数据库表,可以简单地用 user_id % 10 的值来表示数据所属的数据库表编号,ID 为 985 的用户放到编号为 5 的子表中,ID 为 10086 的用户放到编号为 6 的子表中。
复杂点 :初始表数量的确定。表数量太多维护比较麻烦,表数量太少又可能导致单表性能存在问题。
优点 :表分布比较均匀。
缺点 :扩充新的表很麻烦,所有数据都要重分布。
雪花算法
@TableField 经过以上的测试,我们可以发现,MyBatis-Plus在执行SQL语句时,要保证实体类中的属性名和表中的字段名一致
如果实体类中的属性名和字段名不一致的情况,会出现什么问题呢?
情况1 若实体类中的属性使用的是驼峰命名风格,而表中的字段使用的是下划线命名风格。例如实体类属性userName,表中字段user_name。
此时MyBatis-Plus会自动将下划线命名风格转化为驼峰命名风格 ,相当于在MyBatis中配置。
情况2 若实体类中的属性和表中的字段不满足情况1,例如实体类属性name,表中字段username,此时需要在实体类属性上使用@TableField(“username”)设置属性所对应的字段名。
@TableLogic 逻辑删除
物理删除:真实删除,将对应数据从数据库中删除,之后查询不到此条被删除的数据
逻辑删除:假删除,将对应数据中代表是否被删除字段的状态修改为“被删除状态”,之后在数据库中仍旧能看到此条数据记录
使用场景:可以进行数据恢复
实现逻辑删除
数据库中创建逻辑删除状态列 ,设置默认值为0
实体类中添加逻辑删除属性
测试
测试删除功能,真正执行的是修改,UPDATE t_user SET is_deleted=1 WHERE id=? AND is_deleted=0
测试查询功能,被逻辑删除的数据默认不会被查询,SELECT id,username AS name,age,email,is_deleted FROM t_user WHERE is_deleted=0
条件构造器和常用接口 wapper介绍
Wrapper:条件构造抽象类,最顶端父类
AbstractWrapper:用于查询条件封装,生成 sql 的 where 条件
QueryWrapper:查询条件封装
UpdateWrapper:Update 条件封装
AbstractLambdaWrapper:使用Lambda 语法
LambdaQueryWrapper:用于Lambda语法使用的查询Wrapper
LambdaUpdateWrapper:Lambda 更新封装Wrapper
QueryWrapper 组装查询条件 1 2 3 4 5 6 7 8 9 10 11 @Test public void test1 () { QueryWrapper<User> queryWrapper = new QueryWrapper<>(); queryWrapper.like("name" ,"a" ) .ge("age" ,21 ) .isNotNull("email" ); userMapper.selectList(queryWrapper).forEach(System.out::println); }
组装排序条件 1 2 3 4 5 6 7 8 9 10 11 @Test public void test2 () { QueryWrapper<User> queryWrapper = new QueryWrapper<>(); queryWrapper.orderByAsc("age" ) .orderByAsc("id" ) .isNotNull("age" ); userMapper.selectList(queryWrapper).forEach(System.out::println); }
组装删除条件 1 2 3 4 5 6 7 8 9 10 @Test public void test3 () { QueryWrapper<User> queryWrapper = new QueryWrapper<>(); queryWrapper.isNull("email" ); int result = userMapper.delete(queryWrapper); System.out.println("受影响的行数:" + result); }
组装修改条件 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 @Test public void test4 () { QueryWrapper<User> queryWrapper = new QueryWrapper<>(); queryWrapper.like("name" ,"用户" ) .ge("age" ,22 ) .or() .like("email" ,"126" ); User user = new User(); user.setEmail("abcde@baomidou.com" ); int result = userMapper.update(user,queryWrapper); System.out.println("受影响的行数:" + result); }
条件的优先级 1 2 3 4 5 6 7 8 9 10 11 12 13 @Test public void test5 () { QueryWrapper<User> queryWrapper = new QueryWrapper<>(); queryWrapper.like("name" ,"a" ) .and(u -> u.gt("age" ,20 ).or().isNull("email" )); User user = new User(); user.setEmail("abcde@baomidou.com" ); int result = userMapper.update(user,queryWrapper); System.out.println("受影响的行数:" + result); }
组装select子句 1 2 3 4 5 6 7 8 9 10 @Test public void test6 () { QueryWrapper<User> queryWrapper = new QueryWrapper<>(); queryWrapper.orderByAsc("age" ) .select("name" ,"age" ); userMapper.selectMaps(queryWrapper).forEach(System.out::println); }
实现子查询 1 2 3 4 5 6 7 8 9 @Test public void test7 () { QueryWrapper<User> queryWrapper = new QueryWrapper<>(); queryWrapper.inSql("id" ,"select id from user where id < 10" ); userMapper.selectList(queryWrapper).forEach(System.out::println); }
UpdateWrapper 1 2 3 4 5 6 7 8 9 10 11 12 @Test public void test8 () { UpdateWrapper<User> updateWrapper = new UpdateWrapper<>(); updateWrapper.like("name" ,"j" ) .and(u -> u.lt("age" ,20 ).or().isNull("email" )) .set("email" ,"12345@baomidou.com" ); int result = userMapper.update(null , updateWrapper); System.out.println("受影响的行数:" + result); }
condition 在真正开发的过程中,组装条件是常见的功能,而这些条件数据来源于用户输入,是可选的,因此我们在组装这些条件时,必须先判断用户是否选择了这些条件,若选择则需要组装该条件,若没有选择则一定不能组装,以免影响SQL执行的结果。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 @Test public void test9 () { String username = null ; Integer ageBegin = 20 ; Integer ageEnd = 22 ; QueryWrapper<User> queryWrapper = new QueryWrapper<>(); if (StringUtils.isNotBlank(username)){ queryWrapper.like("name" ,username); } if (ageBegin != null ){ queryWrapper.ge("age" , ageBegin); } if (ageEnd != null ) { queryWrapper.le("age" , ageEnd); } userMapper.selectList(queryWrapper).forEach(System.out::println); }
上面的实现方案没有问题,但是代码比较复杂,我们可以使用带condition参数的重载方法构建查询条件 ,简化代码的编写
1 2 3 4 5 6 7 8 9 10 11 12 @Test public void test10 () { String username = null ; Integer ageBegin = 20 ; Integer ageEnd = 22 ; QueryWrapper<User> queryWrapper = new QueryWrapper<>(); queryWrapper.like(StringUtils.isNotBlank(username),"name" ,username) .ge(ageBegin != null ,"age" ,ageBegin) .le(ageEnd != null ,"age" ,ageEnd); userMapper.selectList(queryWrapper).forEach(System.out::println); }
LambdaQueryWrapper 1 2 3 4 5 6 7 8 9 10 11 @Test public void test11 () { String username = null ; Integer ageBegin = 20 ; Integer ageEnd = 22 ; LambdaQueryWrapper<User> lambdaQueryWrapper = new LambdaQueryWrapper<>(); lambdaQueryWrapper.like(StringUtils.isNotBlank(username),User::getName,username) .ge(ageBegin != null ,User::getAge,ageBegin) .le(ageEnd != null ,User::getAge,ageEnd); userMapper.selectList(lambdaQueryWrapper).forEach(System.out::println); }
LambdaUpdateWrapper 1 2 3 4 5 6 7 8 9 10 @Test public void test12 () { LambdaUpdateWrapper<User> lambdaUpdateWrapper = new LambdaUpdateWrapper<>(); lambdaUpdateWrapper.like(User::getName,"k" ) .and(u -> u.lt(User::getAge,21 ).or().isNull(User::getEmail)) .set(User::getEmail,"23456@baomidou.com" ); int result = userMapper.update(null , lambdaUpdateWrapper); System.out.println("受影响的行数:" + result); }
插件 分页插件 MyBatis Plus自带分页插件,只要简单的配置即可实现分页功能。
添加配置类 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 package com.exercise.mybatis_plus.config;import com.baomidou.mybatisplus.annotation.DbType;import com.baomidou.mybatisplus.extension.plugins.MybatisPlusInterceptor;import com.baomidou.mybatisplus.extension.plugins.inner.PaginationInnerInterceptor;import org.mybatis.spring.annotation.MapperScan;import org.springframework.context.annotation.Bean;import org.springframework.context.annotation.Configuration;@Configuration @MapperScan("com.exercise.mybatis_plus.mapper") public class MyBatisPlusConfig { @Bean public MybatisPlusInterceptor mybatisPlusInterceptor () { MybatisPlusInterceptor mybatisPlusInterceptor = new MybatisPlusInterceptor(); mybatisPlusInterceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL)); return mybatisPlusInterceptor; } }
测试 1 2 3 4 5 6 7 8 9 10 11 12 @Test public void testPage () { Page<User> page = new Page<>(1 ,5 ); userMapper.selectPage(page,null ); page.getRecords().forEach(System.out::println); System.out.println("当前页:" +page.getCurrent()); System.out.println("每页显示的条数:" +page.getSize()); System.out.println("总记录数:" +page.getTotal()); System.out.println("总页数:" +page.getPages()); System.out.println("是否有上一页:" +page.hasPrevious()); System.out.println("是否有下一页:" +page.hasNext()); }
1 2 3 4 5 6 7 8 9 10 11 User(id=1, name=Jone, age=18, email=12345@baomidou.com) User(id=2, name=Jack, age=20, email=23456@baomidou.com) User(id=3, name=Tom, age=28, email=test3@baomidou.com) User(id=4, name=Sandy, age=21, email=abcde@baomidou.com) User(id=5, name=Billie, age=24, email=test5@baomidou.com) 当前页:1 每页显示的条数:5 总记录数:12 总页数:3 是否有上一页:false 是否有下一页:true
xml自定义分页 Mapper中定义接口方法 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 package com.exercise.mybatis_plus.mapper;import com.baomidou.mybatisplus.core.mapper.BaseMapper;import com.baomidou.mybatisplus.core.metadata.IPage;import com.baomidou.mybatisplus.extension.plugins.pagination.Page;import com.exercise.mybatis_plus.pojo.User;import org.apache.ibatis.annotations.Param;import org.springframework.stereotype.Repository;@Repository public interface UserMapper extends BaseMapper <User > { IPage<User> selectPageByAge (@Param("page") Page<User> page, @Param("age") Integer age) ; }
编写SQL 1 2 3 4 5 6 7 8 9 10 11 <?xml version="1.0" encoding="UTF-8" ?> <!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd" > <mapper namespace ="com.exercise.mybatis_plus.mapper.UserMapper" > <select id ="selectPageByAge" resultType ="com.exercise.mybatis_plus.pojo.User" > select * from user where age >= #{age} </select > </mapper >
测试 1 2 3 4 5 6 7 8 9 10 11 12 @Test public void testPageVo () { Page<User> page = new Page<>(1 ,3 ); userMapper.selectPageByAge(page,20 ); page.getRecords().forEach(System.out::println); System.out.println("当前页:" +page.getCurrent()); System.out.println("每页显示的条数:" +page.getSize()); System.out.println("总记录数:" +page.getTotal()); System.out.println("总页数:" +page.getPages()); System.out.println("是否有上一页:" +page.hasPrevious()); System.out.println("是否有下一页:" +page.hasNext()); }
1 2 3 4 5 6 7 8 9 User(id=2, name=Jack, age=20, email=23456@baomidou.com) User(id=3, name=Tom, age=28, email=test3@baomidou.com) User(id=4, name=Sandy, age=21, email=abcde@baomidou.com) 当前页:1 每页显示的条数:3 总记录数:11 总页数:4 是否有上一页:false 是否有下一页:true
乐观锁 场景 一件商品,成本价是80元,售价是100元。老板先是通知小李,说你去把商品价格增加50元。小李正在玩游戏,耽搁了一个小时。正好一个小时后,老板觉得商品价格增加到150元,价格太高,可能会影响销量。又通知小王,你把商品价格降低30元。
此时,小李和小王同时操作商品后台系统。小李操作的时候,系统先取出商品价格100元;小王也在操作,取出的商品价格也是100元。小李将价格加了50元,并将100+50=150元存入了数据库;小王将商品减了30元,并将100-30=70元存入了数据库。是的,如果没有锁,小李的操作就完全被小王的覆盖了。
现在商品价格是70元,比成本价低10元。几分钟后,这个商品很快出售了1千多件商品,老板亏1万多。
乐观锁与悲观锁 上面的故事,如果是乐观锁,小王保存价格前,会检查下价格是否被人修改过了。如果被修改过了,则重新取出的被修改后的价格,150元,这样他会将120元存入数据库。
如果是悲观锁,小李取出数据后,小王只能等小李操作完之后,才能对价格进行操作,也会保证最终的价格是120元。
模拟修改冲突
1 2 3 4 5 6 7 8 CREATE TABLE product( id BIGINT (20 ) NOT NULL COMMENT '主键ID' , NAME VARCHAR (30 ) NULL DEFAULT NULL COMMENT '商品名称' , price INT (11 ) DEFAULT 0 COMMENT '价格' , VERSION INT (11 ) DEFAULT 0 COMMENT '乐观锁版本号' , PRIMARY KEY (id));
1 INSERT INTO product (id, NAME, price) VALUES (1 , '外星人笔记本' , 100 );
1 2 3 4 5 6 7 8 9 10 11 package com.exercise.mybatis_plus.pojo;import lombok.Data;@Data public class Product { private Long id; private String name; private Integer price; private Integer version; }
1 2 3 4 5 6 7 8 9 package com.exercise.mybatis_plus.mapper;import com.baomidou.mybatisplus.core.mapper.BaseMapper;import com.exercise.mybatis_plus.pojo.Product;import org.springframework.stereotype.Repository;@Repository public interface ProductMapper extends BaseMapper <Product > {}
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 @Test public void testProduct () { Product productLi = productMapper.selectById(1 ); System.out.println("小李查询商品价格:" + productLi.getPrice()); Product productWang = productMapper.selectById(1 ); System.out.println("小王查询商品价格:" + productWang.getPrice()); productLi.setPrice(productLi.getPrice() + 50 ); productMapper.updateById(productLi); productWang.setPrice(productWang.getPrice() - 30 ); productMapper.updateById(productWang); Product productBoss = productMapper.selectById(1 ); System.out.println("老板查询商品价格:" + productBoss.getPrice()); }
乐观锁实现流程
数据库中添加version字段
取出记录时,获取当前version
1 SELECT id,`name`,price,`version` FROM product WHERE id= 1
更新时,version + 1,如果where语句中的version版本不对,则更新失败
1 2 UPDATE product SET price = price+ 50 , `version`= `version` + 1 WHERE id= 1 AND `version`= 1
MybatisPlus实现乐观锁
1 2 3 4 5 6 7 8 9 10 11 12 13 14 package com.exercise.mybatis_plus.pojo;import com.baomidou.mybatisplus.annotation.Version;import lombok.Data;@Data public class Product { private Long id; private String name; private Integer price; @Version private Integer version; }
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 package com.exercise.mybatis_plus.config;import com.baomidou.mybatisplus.annotation.DbType;import com.baomidou.mybatisplus.extension.plugins.MybatisPlusInterceptor;import com.baomidou.mybatisplus.extension.plugins.inner.OptimisticLockerInnerInterceptor;import com.baomidou.mybatisplus.extension.plugins.inner.PaginationInnerInterceptor;import org.mybatis.spring.annotation.MapperScan;import org.springframework.context.annotation.Bean;import org.springframework.context.annotation.Configuration;@Configuration @MapperScan("com.exercise.mybatis_plus.mapper") public class MyBatisPlusConfig { @Bean public MybatisPlusInterceptor mybatisPlusInterceptor () { MybatisPlusInterceptor mybatisPlusInterceptor = new MybatisPlusInterceptor(); mybatisPlusInterceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL)); mybatisPlusInterceptor.addInnerInterceptor(new OptimisticLockerInnerInterceptor()); return mybatisPlusInterceptor; } }
1 2 3 4 5 6 7 8 9 10 11 12 小李查询商品信息: SELECT id,name,price,version FROM t_product WHERE id=? 小王查询商品信息: SELECT id,name,price,version FROM t_product WHERE id=? 小李修改商品价格,自动将 version + 1 UPDATE t_product SET name=?, price=?, version=? WHERE id=? AND version=? Parameters: 外星人笔记本(String), 150(Integer), 1(Integer), 1(Long), 0(Integer) 小王修改商品价格,此时version已更新,条件不成立,修改失败 UPDATE t_product SET name=?, price=?, version=? WHERE id=? AND version=? Parameters: 外星人笔记本(String), 70(Integer), 1(Integer), 1(Long), 0(Integer) 最终,小王修改失败,查询价格:150 SELECT id,name,price,version FROM t_product WHERE id=?
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 @Test public void testProduct () { Product productLi = productMapper.selectById(1 ); System.out.println("小李查询商品价格:" + productLi.getPrice()); Product productWang = productMapper.selectById(1 ); System.out.println("小王查询商品价格:" + productWang.getPrice()); productLi.setPrice(productLi.getPrice() + 50 ); productMapper.updateById(productLi); productWang.setPrice(productWang.getPrice() - 30 ); int resultWang = productMapper.updateById(productWang); if (resultWang == 0 ){ Product productNew = productMapper.selectById(1 ); productNew.setPrice(productNew.getPrice() - 30 ); productMapper.updateById(productNew); } Product productBoss = productMapper.selectById(1 ); System.out.println("老板查询商品价格:" + productBoss.getPrice()); }
通用枚举 表中的有些字段值是固定的,例如性别(男或女),此时我们可以使用MyBatis-Plus的通用枚举来实现。
数据库表添加字段sex
创建通用枚举类型 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 package com.exercise.mybatis_plus.enums;import com.baomidou.mybatisplus.annotation.EnumValue;import lombok.AllArgsConstructor;import lombok.Getter;@AllArgsConstructor @Getter public enum SexEnum { MALE(1 ,"男" ), FEMALE(2 ,"女" ); @EnumValue private Integer sex; private String sexName; }
配置扫描通用枚举 1 2 3 4 5 6 7 8 mybatis-plus: configuration: log-impl: org.apache.ibatis.logging.stdout.StdOutImpl type-aliases-package: com.exercise.mybatis_plus.pojo type-enums-package: com.exercise.mybatis_plus.enums
测试 1 2 3 4 5 6 7 8 @Test public void test () { User user = new User(); user.setName("admin" ); user.setAge(23 ); user.setSex(SexEnum.MALE); userMapper.insert(user); }
代码生成器 引入依赖 1 2 3 4 5 6 7 8 9 10 11 12 <dependency > <groupId > com.baomidou</groupId > <artifactId > mybatis-plus-generator</artifactId > <version > 3.5.1</version > </dependency > <dependency > <groupId > org.freemarker</groupId > <artifactId > freemarker</artifactId > <version > 2.3.31</version > </dependency >
快速生成 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 package com.exercise.mybatis_plus.test;import com.baomidou.mybatisplus.generator.FastAutoGenerator;import com.baomidou.mybatisplus.generator.config.OutputFile;import com.baomidou.mybatisplus.generator.engine.FreemarkerTemplateEngine;import java.util.Collections;public class FastAutoGeneratorTest { public static void main (String[] args) { FastAutoGenerator.create("jdbc:mysql://127.0.0.1:3306/mybatis_plus?characterEncoding=utf-8&userSSL=false" , "root" , "12345678" ) .globalConfig(builder -> { builder.author("小新" ) .fileOverride() .outputDir("/Users/liuwq/Desktop/mybatis_plus" ); }) .packageConfig(builder -> { builder.parent("com.exercise" ) .moduleName("mybatis_plus" ) .pathInfo(Collections.singletonMap(OutputFile.mapperXml, "/Users/liuwq/Desktop/mybatis_plus" )); }) .strategyConfig(builder -> { builder.addInclude("user" ) .addTablePrefix("t_" , "c_" ); }) .templateEngine(new FreemarkerTemplateEngine()) .execute(); } }
多数据源 适用于多种场景:纯粹多库、读写分离、一主多从、混合模式等
目前我们就来模拟一个纯粹多库的一个场景,其他场景类似
场景说明:我们创建两个库,分别为:mybatis_plus(以前的库不动)与mybatis_plus_1(新建),将 mybatis_plus 库的 product 表移动到 mybatis_plus_1 库,这样每个库一张表,通过一个测试用例分别获取用户数据与商品数据,如果获取到,则说明多库模拟成功。
创建数据库及表
创建数据库mybatis_plus_1和表product
1 2 3 4 5 6 7 8 9 10 CREATE DATABASE `mybatis_plus_1` ;use `mybatis_plus_1`; CREATE TABLE product( id BIGINT (20 ) NOT NULL COMMENT '主键ID' , name VARCHAR (30 ) NULL DEFAULT NULL COMMENT '商品名称' , price INT (11 ) DEFAULT 0 COMMENT '价格' , version INT (11 ) DEFAULT 0 COMMENT '乐观锁版本号' , PRIMARY KEY (id));
1 INSERT INTO product (id, NAME, price) VALUES (1 , '外星人笔记本' , 100 );
1 2 use mybatis_plus; DROP TABLE IF EXISTS product;
引入依赖 1 2 3 4 5 6 <dependency > <groupId > com.baomidou</groupId > <artifactId > dynamic-datasource-spring-boot-starter</artifactId > <version > 3.4.1</version > </dependency >
配置多数据源 说明:注释掉之前的数据库连接,添加新配置
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 spring: datasource: dynamic: primary: master strict: false datasource: master: url: jdbc:mysql://localhost:3306/mybatis_plus?characterEncoding=utf-8&useSSL=false driver-class-name: com.mysql.cj.jdbc.Driver username: root password: 12345678 slave_1: url: jdbc:mysql://localhost:3306/mybatis_plus_1?characterEncoding=utf-8&useSSL=false driver-class-name: com.mysql.cj.jdbc.Driver username: root password: 12345678
创建用户service 1 2 public interface UserService extends IService <User > {}
1 2 3 4 @Service @DS("master") public class UserServiceImpl extends ServiceImpl <UserMapper , User > implements UserService {}
创建商品service 1 2 public interface ProductService extends IService <Product > {}
1 2 3 4 @Service @DS("slave_1") public class ProductServiceImpl extends ServiceImpl <ProductMapper , Product > implements ProductService {}
测试 1 2 3 4 5 6 7 8 9 10 @Autowired private UserService userService;@Autowired private ProductService productService;@Test public void test () { userService.list().forEach(System.out::println); productService.list().forEach(System.out::println); }
结果:
都能顺利获取对象,则测试成功
如果我们实现读写分离,将写操作方法加上主库数据源,读操作方法加上从库数据源,自动切换,是不是就能实现读写分离?
使用@DS切换数据源,可以加到类上,也可以加到方法上。加到方法上即可实现读写分离。
MyBatisX插件 MyBatis-Plus为我们提供了强大的mapper和service模板,能够大大的提高开发效率,但是在真正开发过程中,MyBatis-Plus并不能为我们解决所有问题,例如一些复杂的SQL,多表联查 ,我们就需要自己去编写代码和SQL语句,我们该如何快速的解决这个问题呢,这个时候可以使用MyBatisX插件。
MyBatisX 一款基于 IDEA 的快速开发插件,为效率而生。
安装MyBatisX插件
XML跳转 MyBatisX插件用法:https://baomidou.com/pages/ba5b24/
代码快速生成
重置模版 MyBatisX插件用法:https://baomidou.com/pages/ba5b24/
JPA提示 MyBatisX插件用法:https://baomidou.com/pages/ba5b24/