MyBatisPlus：学习MyBatisPlus
文章目录
- 1、MyBatisPlus简介
- 2、快速开始
- 3、配置日志
- 4、CRUD扩展
-
- 4.1、插入操作
- 4.2、更新操作
- 4.3、自动填充
- 4.4、乐观锁
- 4.5、查询操作
- 4.6、分页查询
- 4.7、删除操作
- 4.8、逻辑删除
- 5、性能分析插件
- 6、条件构造器
- 7、代码自动生成器
1、MyBatisPlus简介
1、MyBatisPlus是什么？
官网：MyBatisPlus官网
MyBatis用简化JDBC，MyBatisPlus用于简化MyBatis
MyBatis-Plus（简称 MP）是一个 MyBatis 的增强工具，在 MyBatis 的基础上只做增强不做改变，为简化开发、提高效率而生
2、MyBatisPlus的特性
无侵入：只做增强不做改变，引入它不会对现有工程产生影响，如丝般顺滑损耗小：启动即会自动注入基本CURD，性能基本无损耗，直接面向对象操作强大的 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 操作智能分析阻断，也可自定义拦截规则，预防误操作
2、快速开始
参考地址：走你
步骤
1、创建数据库 mybatis_plus
2、创建user表
表结构：
数据库 Schema 脚本：
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)
);
表数据：
DELETE FROM user;
INSERT INTO user (id, name, age, email) VALUES
(1, 'Jone', 18, '[email protected]'),
(2, 'Jack', 20, '[email protected]'),
(3, 'Tom', 28, '[email protected]'),
(4, 'Sandy', 21, '[email protected]'),
(5, 'Billie', 24, '[email protected]');
3、编写项目，初始化项目，使用SpringBoot初始化
4、导入依赖
<dependency>
<groupId>mysqlgroupId>
<artifactId>mysql-connector-javaartifactId>
dependency>
<dependency>
<groupId>org.projectlombokgroupId>
<artifactId>lombokartifactId>
dependency>
<dependency>
<groupId>com.baomidougroupId>
<artifactId>mybatis-plus-boot-starterartifactId>
<version>3.0.5version>
dependency>
说明：我们使用mybatis-plus可以节省我们大量的代码，尽量不要同时导入mybatis和mybatis-plus ，因为可能会有版本的差异
5、连接数据库，这一步和mybatis相同
注意：需要添加时区的配置，serverTimezone=GMT%2B8
# 应用名称
spring.application.name=mybatis_plus
# 应用服务 WEB 访问端口
server.port=8080
# mysql配置
spring.datasource.username=root
spring.datasource.password=Seeyon123456
spring.datasource.url=jdbc:mysql://localhost:3306/mybatisplus?userSSL=false&useUnicode=true&characterEncoding=utf-8&serverTimezone=GMT%2B8
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
6、使用mybatis-plus之后的步骤
如果在mybatis里边，那么接下来的步骤是创建pojo、编写dao层(连接mybatis，配置mapper.xml文件)、编写service层，编写controller层，那么现在使用mybatis-plus的步骤是什么样的呢？
6.1、创建pojo实体类
@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
private Long id;
private String name;
private Integer age;
private String email;
}
6.2、创建mapper接口层
使用了mybatis-plus之后，mapper接口层只需要去继承BaseMapper接口
// 在对应的Mapper上面继承基本的类BaseMapper即可
@Repository // 代表持久层
public interface UserMapper extends BaseMapper<User> {
// 所有的CRUD操作都已经编写完成
}
mapper接口层创建完成之后，我们怎么才能让这个组件生效呢，只需要在启动类上边加注解@MapperScan进行扫描并识别
// 扫描编写的mapper文件夹
@MapperScan("com.jl.mapper")
@SpringBootApplication
public class MybatisPlusApplication {
public static void main(String[] args) {
SpringApplication.run(MybatisPlusApplication.class, args);
}
}
6.2、在单元测试中进行测试，查看是否能够正常使用
@SpringBootTest
class MybatisPlusApplicationTests {
// 继承了BaseMapper，所有的方法都来自己父类
// 我们也可以编写自己的扩展方法
@Autowired
private UserMapper userMapper;
@Test
void contextLoads() {
// selectList中的参数是一个 Wrapper,它是一个条件构造器
// 这里我们先不使用,所以将参数设为null
List<User> userList = userMapper.selectList(null);
userList.forEach(System.out::println);
}
}
结果：
至此，简单的功能已经实现
3、配置日志
在mybatis-plus中的sql语句是不可见的，我们希望知道它是怎么执行的，所以我们必须要查看日志
配置：
# 配置日志
mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl
再次启动测试类，查看日志信息
配置完毕日志之后，后面的学习就需要注意这个自动生成的SQL，你们就会喜欢上使用MyBatis-Plus
4、CRUD扩展
4.1、插入操作
1、插入操作
@Test
void insertTest(){
User user = new User();
user.setName("张无忌");
user.setAge(22);
user.setEmail("[email protected]");
// mybatis-plus 会帮我们自动生成id
int res = userMapper.insert(user);
// 输出受影响的行数
System.out.println(res);
// 发现id会自动回填
System.out.println(user);
}
结果：
这里数据库插入的id的默认值为：全局的唯一id
这里介绍一下主键生成策略
默认 ID_WORKER ，全局唯一id
分布式系统唯一id生成介绍：走你
雪花算法
snowflake是Twitter开源的分布式ID生成算法，结果是一个long型的ID。其核心思想是：使用41bit作为毫秒数，10bit作为机器的ID（5个bit是数据中心，5个bit的机器ID），12bit作为毫秒内的流水号（意味着每个节点在每毫秒可以产生 4096 个 ID），最后还有一个符号位，永远是0。可以保证几乎全球唯一！
主键自增
我们需要配置主键自增：
-
实体类字段上加注解：
@TableId(type = IdType.AUTO) -
数据库字段一定要是自增
-
再次测试插入即可！
其余的源码解释
public enum IdType {
AUTO(0), // 数据库id自增
NONE(1), // 未设置主键
INPUT(2), // 手动输入
ID_WORKER(3), // 默认的全局唯一id
UUID(4), // 全局唯一id UUID
ID_WORKER_STR(5); // ID_WORKER的字符串表示法
}
4.2、更新操作
2、更新操作
@Test
void updateTest(){
User user = new User();
// 这块会通过条件自动拼接动态sql
user.setId(6L);
user.setName("张无忌111");
user.setAge(21);
// 注意: updateById 的参数是一个对象
int i = userMapper.updateById(user);
System.out.println(i);
}
mybatis-plus会通过条件自动拼接动态sql
所有的sql都是自动帮你动态配置的
4.3、自动填充
3、自动填充
创建时间、修改时间！这些个操作一般都是自动化完成的，我们不希望手动更新！
阿里巴巴开发手册：所有的数据库表：gmt_create、gmt_modified(全球标准)几乎所有的表都要配置上！而且需要自动化！
3.1、方式一：数据库级别(工作中不允许使用)
-
在表中新增字段
create_time、update_time
-
再次测试插入方法，我们需要先把实体类同步
private Date createTime;
private Date updateTime;
- 结果
3.2、方式二：代码级别
- 删除数据库的默认值
- 实体类字段属性上需要增加注解
// 字段添加填充内容
@TableField(fill = FieldFill.INSERT)
private Date createTime;
@TableField(fill = FieldFill.INSERT_UPDATE)
private Date updateTime;
- 创建一个handler，编写处理器来处理这个注解即可
@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.4、乐观锁
4、乐观锁
- 乐观锁：顾名思义十分乐观，它总是认为不会出现问题，无论千什么不去上锁。如果出现了问题,再次更新值测试
- 悲观锁：顾名思义十分悲观，它总是认为总是出现问题，无论干什么都会上锁，再去操作
我们这里主要讲解乐观锁机制
乐观锁实现方式
- 取出记录时，获取当前
version - 更新时，带上这个
version - 执行更新时，
set version = newVersion where version = oldVersion - 如果
version不对，就更新失败
测试一下mybatis-plus插件
4.1、给数据库添加version字段，并设置version值为1
4.2、实体类中添加对应的字段
@Version // 乐观锁Version注解
private Integer version;
4.3、注册组件
这里我们可以将启动类上边的@MapperScan("com.jl.mapper")放到MybatisPlusConfig中
// 扫描编写的mapper文件夹
@MapperScan("com.jl.mapper")
@EnableTransactionManagement // 开启事务
@Configuration // 加上该注解,则表明该类为配置类
public class MybatisPlusConfig {
// 注册乐观锁插件
@Bean
public OptimisticLockerInterceptor optimisticLockerInterceptor() {
return new OptimisticLockerInterceptor();
}
}
4.4、测试乐观锁
测试成功的案例：
// 测试乐观锁 ==> 成功
@Test
void TestOptimisticLocker() {
// 1、查询用户信息
User user = userMapper.selectById(1L);
// 2、修改用户信息
user.setName("哈哈哈");
user.setEmail("[email protected]");
// 3、执行更新操作
userMapper.updateById(user);
}
结果：
测试失败的案例：
// 测试乐观锁 ==> 失败
@Test
void TestOptimisticLocker2() {
// 线程1
User user = userMapper.selectById(1L);
user.setName("哈哈哈");
user.setEmail("[email protected]");
// 模拟另外一个线程执行了插入操作
User user2 = userMapper.selectById(1L);
user2.setName("哈哈哈111");
user2.setEmail("[email protected]");
userMapper.updateById(user2);
// 如果没有乐观锁就会覆盖插队线程的值
userMapper.updateById(user);
}
结果：
4.5、查询操作
1、根据单个id查询
// 测试根据id查询
@Test
void testSelectById() {
User user = userMapper.selectById(1L);
System.out.println(user);
}
结果展示：
2、根据多个id查询(批量查询)
// 测试根据多个id查询
@Test
void testSelectByBatchId() {
List<User> users = userMapper.selectBatchIds(Arrays.asList(1,2,3));
users.forEach(System.out::println);
}
结果展示：
3、条件查询(可以用map进行封装)
// 条件查询
@Test
void testSelectByMap() {
HashMap<String, Object> map = new HashMap<>();
// 自定义要查询的条件
map.put("name","张无忌111");
map.put("age",20);
List<User> users = userMapper.selectByMap(map);
users.forEach(System.out::println);
}
结果展示：
4.6、分页查询
mybatis-plus也有自己的内置分页插件，参考官网地址：走你
1、配置拦截器组件即可
// 分页插件
@Bean
public PaginationInterceptor paginationInterceptor() {
return new PaginationInterceptor();
}
2、直接使用Page对象即可
// 测试分页查询
@Test
void testPage() {
// 查询第一页,显示5个
Page<User> page = new Page<>(2,5); // 参数一: 当前页 参数二: 页面大小
userMapper.selectPage(page,null);
page.getRecords().forEach(System.out::println);
System.out.println(page.getTotal());
}
3、启动测试，查看结果
4.7、删除操作
1、根据id删除用户
// 测试删除
@Test
void testDeleteById() {
userMapper.deleteById(1338123641799364609L);
}
结果：
2、批量删除用户
// 测试批量删除
@Test
void testDeleteBatchId() {
userMapper.deleteBatchIds(Arrays.asList(1338086689226223618L,1338123150046535681L,1338123394222235649L));
}
结果：
3、通过map删除
// 测试map删除
@Test
void testDeleteMap() {
HashMap<String, Object> map = new HashMap<>();
map.put("name","张无忌");
userMapper.deleteByMap(map);
}
结果：
4.8、逻辑删除
- 物理删除︰从数据库中直接移除
- 逻辑删除︰再数据库中没有被移除，而是通过一个变量来让他失效。
deleted = 0 => deleted = 1
1、在数据表中增加一个deleted字段
2、实体类中加注解
@TableLogic // 逻辑删除注解
private Integer deleted;
2、配置
config
// 逻辑删除组件
@Bean
public ISqlInjector sqlInjector() {
return new LogicSqlInjector();
}
properties
# 配置逻辑删除
mybatis-plus.global-config.db-config.logic-delete-value=1
mybatis-plus.global-config.db-config.logic-not-delete-value=0
3、此时再次测试删除操作
// 测试删除
@Test
void testDeleteById() {
userMapper.deleteById(1L);
}
结果：
那么我们查看一下数据库是否被删除了呢
可以看到的是用户并没有被删除，只是deleted字段值变为了1
4、我们在去查询一下该用户，看看结果又是怎么样的呢？
// 测试根据id查询
@Test
void testSelectById() {
User user = userMapper.selectById(1L);
System.out.println(user);
}
结果：
查询的时候会自动过滤被逻辑删除的用户
5、性能分析插件
作用：性能分析拦截器，用于输出每条SQL语句及其执行时间
1、导入
// SQL 执行效率插件
@Bean
@Profile({"dev","test"}) //设置dev test环境开启，保证我们的效率
public PerformanceInterceptor performanceInterceptor() {
PerformanceInterceptor performanceInterceptor = new PerformanceInterceptor();
performanceInterceptor.setMaxTime(1); // ms 设置sql执行的最大时间,如果超过了则不执行
performanceInterceptor.setFormat(true); // 开启格式化支持
return performanceInterceptor;
}
2、设置环境
# 设置开发环境
spring.profiles.active=dev
3、测试使用
@Test
void contextLoads() {
// selectList中的参数是一个 Wrapper,它是一个条件构造器
// 这里我们先不使用,所以将参数设为null
List<User> userList = userMapper.selectList(null);
userList.forEach(System.out::println);
}
结果：
使用性能分析插件，可以帮助我们提高效率
6、条件构造器
复杂的sql语句就可以使用条件构造器(Wrapper)来代替
1、测试一：(name不为空,email也不为空，并且age大于12岁)
@Test
void contextLoads() {
QueryWrapper<User> wrapper = new QueryWrapper<>();
wrapper
.isNotNull("name")
.isNotNull("email")
.ge("age",12);
userMapper.selectList(wrapper).forEach(System.out::println);
}
结果：
2、测试二：(查询名字为张无忌的用户)
@Test
void test2() {
QueryWrapper<User> wrapper = new QueryWrapper<>();
wrapper.eq("name","张无忌");
// 查询一个数据,如果查询多个数据则选择 Map 或者 List
User user = userMapper.selectOne(wrapper);
System.out.println(user);
}
结果：
3、测试三：(查询年龄在20~30之间的用户)
@Test
void test3() {
QueryWrapper<User> wrapper = new QueryWrapper<>();
wrapper.between("age",20,30);
Integer count = userMapper.selectCount(wrapper);
System.out.println(count);
}
结果：
4、测试四：(模糊查询)
@Test
void test4() {
QueryWrapper<User> wrapper = new QueryWrapper<>();
// likeRight: 就是%在右边 t%: 就是以t开头
wrapper
.notLike("name","e")
.likeRight("email","t");
List<Map<String, Object>> maps = userMapper.selectMaps(wrapper);
maps.forEach(System.out::println);
}
结果：
5、测试五：(子查询)
@Test
void test5() {
QueryWrapper<User> wrapper = new QueryWrapper<>();
// id 在子查询中查出来
wrapper.inSql("id","select id from user where id < 3 ");
List<Object> objects = userMapper.selectObjs(wrapper);
objects.forEach(System.out::println);
}
结果：
6、测试六：(通过id进行排序)
@Test
void test6() {
QueryWrapper<User> wrapper = new QueryWrapper<>();
wrapper.orderByAsc("id");
List<User> users = userMapper.selectList(wrapper);
users.forEach(System.out::println);
}
结果：
7、代码自动生成器
1、导入相关依赖
<dependency>
<groupId>com.baomidougroupId>
<artifactId>mybatis-plus-boot-starterartifactId>
<version>3.0.5version>
dependency>
<dependency>
<groupId>org.apache.velocitygroupId>
<artifactId>velocity-engine-coreartifactId>
<version>2.0version>
dependency>
<dependency>
<groupId>io.springfoxgroupId>
<artifactId>springfox-swagger2artifactId>
<version>3.0.0version>
dependency>
<dependency>
<groupId>io.springfoxgroupId>
<artifactId>springfox-swagger-uiartifactId>
<version>2.10.0version>
dependency>
2、在test中添加类JlCode进行配置
package com.jl;
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 JlCode {
public static void main(String[] args) {
// 需要构建一个 代码自动生成器 对象
AutoGenerator mpg = new AutoGenerator();
// 配置策略
// 1、全局配置
GlobalConfig gc = new GlobalConfig();
// 获取路径
String projectPath = System.getProperty("user.dir");
gc.setOutputDir(projectPath + "/src/main/java");
gc.setAuthor("jl");
gc.setOpen(false);
gc.setFileOverride(false); // 是否覆盖
gc.setServiceName("%sService"); // 去Service的I前缀
gc.setIdType(IdType.ID_WORKER); // id的生产策略
gc.setDateType(DateType.ONLY_DATE);
gc.setSwagger2(true);
mpg.setGlobalConfig(gc);
// 2、设置数据源
DataSourceConfig dsc = new DataSourceConfig();
dsc.setUrl("jdbc:mysql://localhost:3306/mybatisplus?userSSL=false&useUnicode=true&characterEncoding=utf-8&serverTimezone=GMT%2B8");
dsc.setUsername("root");
dsc.setPassword("Seeyon123456");
dsc.setDriverName("com.mysql.cj.jdbc.Driver");
dsc.setDbType(DbType.MYSQL);
mpg.setDataSource(dsc);
// 3、包的配置
PackageConfig pc = new PackageConfig();
pc.setModuleName("blog");
pc.setParent("com.jl");
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);
strategy.setEntityLombokModel(true); // 自动Lombok
strategy.setLogicDeleteFieldName("delete");
// 自动填充配置
TableFill gmtCreate = new TableFill("gmt_create", FieldFill.INSERT);
TableFill gmtModified = new TableFill("gmt_modified", FieldFill.INSERT_UPDATE);
ArrayList<TableFill> tableFills = new ArrayList<>();
tableFills.add(gmtCreate);
tableFills.add(gmtModified);
strategy.setTableFillList(tableFills);
// 乐观锁
strategy.setVersionFieldName("version");
// 开启驼峰命名格式
strategy.setRestControllerStyle(true);
strategy.setControllerMappingHyphenStyle(true); // localhost:8080/hello_id_2
mpg.setStrategy(strategy);
mpg.execute(); // 执行
}
}
3、启动测试
学习视频：走你