1.什么是Myabtis-puls
简介:
MyBatis-Plus(简称 MP)是一个 MyBatis 的增强工具,在 MyBatis 的基础上只做增强不做改变,为简化开发、提高效率而生。
我们的愿景是成为 MyBatis 最好的搭档,就像 魂斗罗 中的 1P、2P,基友搭配,效率翻倍,双飞哈哈哈
特性:
- 无侵入:只做增强不做改变,引入它不会对现有工程产生影响,如丝般顺滑
- 损耗小:启动即会自动注入基本 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 操作智能分析阻断,也可自定义拦截规则,预防误操作
2.简单入门(查询操作)
1.第一步:创建数据库,创建数据库表,添加数据,进行操作
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)
);
2.在插入一些数据,方便参数
DELETE FROM user;
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.新建一个SpringBoot项目,并导入我们需要使用的依赖
<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>
<exclusions>
<exclusion>
<groupId>org.junit.vintage</groupId>
<artifactId>junit-vintage-engine</artifactId>
</exclusion>
</exclusions>
</dependency>
<!--mybatis-plus-->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.0.5</version>
</dependency>
<!--mysql-->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
</dependency>
<!--lombok用来简化实体类-->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
</dependency>
</dependencies>
4.编写数据库配置,我们这里使用application.properties 后面基本上有yml进行配置
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.url=jdbc:mysql://localhost:3306/mybatis_plus?serverTimezone=GMT
spring.datasource.username=root
spring.datasource.password=147258
5.我们配置已经搭建的差不多了,我们下一步看见编写java实体类
package com.lwq.mpdemo.pojo;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
/**
* @author
* @since 2020/10/15 17:43
*/
@Data
@AllArgsConstructor
@NoArgsConstructor
//以上三个注解会为我们生产set get 方法 无参构造 带参构造 还有重写toString方法等
public class User {
private Long id;
private String name;
private Integer age;
private String email;
}
6.编写mapper 编写mapper接口并且继承BaseMapper<User> User为类型
这样我们就可以调用里面的方法了
package com.lwq.mpdemo.mapper;
import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.lwq.mpdemo.pojo.User;
/**
* @author
* @since 2020/10/15 17:59
*/
public interface UserMapper extends BaseMapper<User> {
}
在我们的启动类上加上注解,这样才能扫描到我们的我们的mapper
7.测试功能实现
我们在测试类注入我们的mapper
package com.lwq.mpdemo;
import com.lwq.mpdemo.mapper.UserMapper;
import com.lwq.mpdemo.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 MpdemoApplicationTests {
//基本测试,查询user表中的所有数据
@Autowired
private UserMapper userMapper;
@Test
void contextLoads() {
//null 表示没有条件 全部查出来
List<User> users = userMapper.selectList(null);
System.out.println(users);
}
}
测试结果:
如果发现UserMapper无法注入的话,因为我们没有把UserMapper接口交给SpringBoot管理,我们可以在UserMapper上加入 @Repository
我们发现我们看不见SQL语句是怎么执行,那么我们可以这么做呢,我们可以在配置文件中添加以下代码
#mybatis日志
mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl
然后我们在测试一下我们的查询全部的功能,我们发现我们的SQL语句显示出来而且非常的详细
3.添加操作
我们只需要调用insert()方法
//添加操作
@Test
public void addUser() {
User user = new User();
user.setAge(888);
user.setEmail("666@qq.com");
user.setName("666");
int i = userMapper.insert(user);
System.out.println(i);
}
测试结果:
我们看看数据库里面的数据,看看这个ID是否为这个值
问题:我们发现我们添加操作的时候,并没有指定ID,那么这个ID是怎么来的呢?
回答:这个是MP为我们自动生成的一个ID,为19位的一个ID
问题:我们是否可以修改这个生成ID的策略呢?
回答:这个是当然可以的,下面详细介绍一下
生成ID策略详细介绍:
- 先在我们需要生成ID的属性上加上注解 @TableId(type = IdType.ID_WORKER)
- 我们发现这里面有几个参数,可以解释一下
- ID_WORKER :mp自带的策略,生成一个19位值,数字类型使用这种策略,比如long
- ID_WORKER_STR:mp自带的策略生成一个19位值,字符串类型使用这种策略,比如String
- UUID:随机生成一个ID,并保证唯一
- INPUT:表示自己设置ID
- NONE:没有策略,为自己设置ID值
4.修改操作
我们只需要调用我们的updateById()方法
测试一下:
//修改操作
@Test
public void updateUser(){
User user = new User();
user.setId(1317991845396934658L);
user.setAge(128);
int i = userMapper.updateById(user);
System.out.println("i"+i);
}
这个方法是通过ID进行修改里面的值,那么我们必须设置我们的ID
5.自动填充
在进行自动填充的时候我们要搭建一下我们的环境
1.在我们的实体类中添加两个参数
2.我们改了实体类,当然我们也需要添加我们的数据库字段
环境添加完成,开始测试
1.在我们的实体类参数上加上注解
@TableField(fill = FieldFill.INSERT)
private Date createTime;
@TableField(fill = FieldFill.INSERT_UPDATE)
private Date updateTime;
这里fill里面也有一些参数:
DEFAULT:默认不处理
INSERT:插入式添加字段
UPDATE:更新时添加字段
INSERT_UPDATE:插入和更新时填充字段
2.编写一个类,实现MetaObjectHandler,重写里面的方法
package com.lwq.mpdemo.handler;
import com.baomidou.mybatisplus.core.handlers.MetaObjectHandler;
import org.apache.ibatis.reflection.MetaObject;
import org.springframework.stereotype.Component;
import org.springframework.stereotype.Repository;
import org.springframework.stereotype.Service;
import java.time.LocalDateTime;
import java.util.Date;
/**
* @author
* @since 2020/10/19 9:59
*/
@Component
public class MyMetaObjectHandler implements MetaObjectHandler {
//使用MP实现一个添加操作,这个方法执行
@Override
public void insertFill(MetaObject metaObject) {
//3个参数 第一个你要设置的时间的名字,第二个为时间,第三个元数据
this.setFieldValByName("createTime",new Date(), metaObject);
this.setFieldValByName("updateTime", new Date(), metaObject);
}
//使用MP实现一个修改操作,这个方法执行
@Override
public void updateFill(MetaObject metaObject) {
this.setFieldValByName("updateTime", new Date(), metaObject);
}
}
我们在进行测试一下:
我们在日志中已经看见成功了,那么我们看看数据库中的数据
6.乐观锁
主要适用的环境:当要更新一条记录的时候,希望这条数据没有被别人更新,也就是实现线程安全的数据更新
第一步:在数据库中添加version片段(作为乐观锁的版本号)
ALTER TABLE user add column `version` INT;
第二步:对应实体类添加版本号的属性(在实现类版本号属性上加上注解 @Version)
@Version
@TableField(fill = FieldFill.INSERT) //添加的时候默认有个初始值
private Integer version; //版本号
第三步:配置乐观锁的插件
package com.lwq.mpdemo.config;
import com.baomidou.mybatisplus.extension.plugins.OptimisticLockerInterceptor;
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.context.annotation.Configuration;
/**
* @author
* @since 2020/10/21 13:41
*/
@Configuration
@MapperScan("com.lwq.mpdemo.mapper")
public class MpConfig {
/**
* 乐观锁插件
*/
@Bean
public OptimisticLockerInterceptor optimisticLockerInterceptor(){
return optimisticLockerInterceptor();
}
}
第四步:测试
1.插入了一条了数据,version初始化为1
2.我们修改一下这条数据看看version是否有变化
//测试乐观锁
@Test
public void optimisticLocker(){
//根据ID查询数据
User user = userMapper.selectById(1318791198017523713L);
//进行修改
user.setName("张飞");
user.setAge(555);
userMapper.updateById(user);
}
7.多种查询数据的方法
1.通过ID查询
@Test
public void userIds(){
//根据ID查询数据
User user = userMapper.selectById(1318791198017523713L);
System.out.println(user);
}
2.多个ID批量查询
//多个ID批量查询
@Test
public void testSelectBatchIds(){
List<User> users=userMapper.selectBatchIds(Arrays.asList(1,2,3));
users.forEach(System.out::println);
}
测试结果
3.通过map封装查询条件
@Test
public void testSelectByMap() {
HashMap<String, Object> map = new HashMap<>();
map.put("name", "Jone");
map.put("age", 18);
List<User> users = userMapper.selectByMap(map);
users.forEach(System.out::println);
}
8.分页
MyBatis Plus自带分页插件,只要简单的配置就能实现分页功能
1:创建配置类(可以写在我们配置乐观锁那个配置类中)
@Bean
public PaginationInterceptor paginationInterceptor() {
return new PaginationInterceptor();
}
2.编写分页代码:
直接new page对象,传两个参数:(当前页和每页显示记录数)
然后在调用mp方法实现分页查询
//分页查询
@Test
public void testPage() {
//1 创建page对象
//传入两个参数:当前页和每页显示记录数
Page<User> page = new Page<>(1, 3);
//2 调用mp方法实现分页查询
//调用mp分页查询过程中,底层封装
//把分页所有的数据封装到page对象中去
userMapper.selectPage(page, null);
System.out.println(page.getCurrent()); //当前页
System.out.println(page.getRecords()); //每页数据list集合
System.out.println(page.getSize()); //每页显示记录数
System.out.println(page.getTotal()); //总记录数
System.out.println(page.getPages()); //总页数
System.out.println(page.hasNext()); //是否有下一页
System.out.println(page.hasPrevious()); //是否有上一页
}
9.MP删除操作
1.根据ID删除
//根据id删除 物理删除
@Test
public void testDeleteById() {
int i = userMapper.deleteById(1L);
System.out.println(i);
}
测试结果
2.批量删除(通过id)
//批量删除
@Test
public void testDeleteBatchIds() {
int i = userMapper.deleteBatchIds(Arrays.asList(2, 3, 4));
System.out.println(i);
}
测试结果
3.逻辑删除
第一步:表中添加一个逻辑删除的字段,对应实体类添加属性
ALTER TABLE user add column `deleted` boolean
private Integer deleted;
第二步:为实体类属性添加的时候加一个默认值,需要在实体类上加上注解
@TableField(fill = FieldFill.INSERT)
@TableLogic
private Integer deleted;
然后还需要在配置类里面添加一下
第三步,在config配置类中注册bean
/**
* 逻辑删除插件
* @return
*/
@Bean
public ISqlInjector sqlInjector(){
return new LogicSqlInjector();
}
第四步:我们开始测试一下
先添加一条数据,便于测试(我们发现插入的时候有默认值,那么我们的第二步是成功的)
我们执行一下删除操作
我们执行了删除操作,最终效果deleted值变成了1
我们在执行一下查询操作,看一下这条数据能被查询出来吗?
我们发现我们MP自动帮我们加上了一个条件,这样就可以过滤已经被我们删除的数据了
10.MP实现复杂条件查询
1.介绍wapper
Wrapper : 条件构造抽象类,最顶端父类
AbstractWrapper : 用于查询条件封装,生成 sql 的 where 条件
QueryWrapper : Entity 对象封装操作类,不是用lambda语法
UpdateWrapper : Update 条件封装,用于Entity对象更新操作
AbstractLambdaWrapper : Lambda 语法使用 Wrapper统一处理解析 lambda 获取 column。
LambdaQueryWrapper :看名称也能明白就是用于Lambda语法使用的查询Wrapper
LambdaUpdateWrapper : Lambda 更新封装Wrapper
一般使用 QueryWrapper
- ge gt le lt:>= > <= <
@Test
public void testSelectQuery() {
//创建对象
QueryWrapper<User> wrapper = new QueryWrapper<>();
//通过QueryWrapper设置条件
//ge gt le lt
//查询age>=30记录
//第一个参数为字段的名称,第二个为设置的值
wrapper.ge("age", 30);
List<User> users = userMapper.selectList(wrapper);
System.out.println(users);
}
- eq
@Test
public void testSelectQuery() {
//创建对象
QueryWrapper<User> wrapper = new QueryWrapper<>();
//查询的是为name等于小强的数据
wrapper.eq("name","小强");
List<User> users = userMapper.selectList(wrapper);
System.out.println(users);
}
- ne
@Test
public void testSelectQuery() {
//创建对象
QueryWrapper<User> wrapper = new QueryWrapper<>();
//查询的是为name不等于小强的数据
wrapper.ne("name","小强");
List<User> users = userMapper.selectList(wrapper);
System.out.println(users);
}
- between
@Test
public void testSelectQuery() {
//创建对象
QueryWrapper<User> wrapper = new QueryWrapper<>();
//between
//查询年纪 20-30这个范围的数据
wrapper.between("age",20,30);
List<User> users = userMapper.selectList(wrapper);
System.out.println(users);
}
- like
@Test
public void testSelectQuery() {
//创建对象
QueryWrapper<User> wrapper = new QueryWrapper<>();
//like
//模糊查询,查询出包含m的数据
wrapper.like("name","m");
List<User> users = userMapper.selectList(wrapper);
System.out.println(users);
}
- orderByDesc
@Test
public void testSelectQuery() {
//创建对象
QueryWrapper<User> wrapper = new QueryWrapper<>();
//orderByDesc
//通过ID进行排序
wrapper.orderByDesc("id");
List<User> users = userMapper.selectList(wrapper);
System.out.println(users);
}
- last
@Test
public void testSelectQuery() {
//创建对象
QueryWrapper<User> wrapper = new QueryWrapper<>();
//last
//在后面拼接一个SQL语句
wrapper.last("limit 1");
List<User> users = userMapper.selectList(wrapper);
System.out.println(users);
}
- 指定要查询的列
@Test
public void testSelectQuery() {
//创建对象
QueryWrapper<User> wrapper = new QueryWrapper<>();
//指定要查询的列
//查询id和name
wrapper.select("id","name");
List<User> users = userMapper.selectList(wrapper);
System.out.println(users);
}