MybatisPlus
1 简介
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 快速入门
3.1 描述
地址:https://baomidou.com/pages/226c21/#初始化工程
使用第三方组件:
1.导入对应的依赖
2.研究依赖如何配置
3.代码如何编写
4.提高扩展技术能力!
3.2 步骤
1.创建数据库 mybatis_plus
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.插入数据
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]');
4.编写项目,初始化项目!使用SpringBoot初始化!
5.导入依赖
<!--数据库驱动-->
<dependency>
<groupId>com.mysql</groupId>
<artifactId>mysql-connector-j</artifactId>
<version>8.0.31</version>
</dependency>
<!--lombok-->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.18.22</version>
</dependency>
<!-- mybatis-plus -->
<!-- mybatis-plus 是自己开发的,并非官方的!-->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.4.3</version>
</dependency>
说明:我们使用mybatis-plus 可以节省我们大量的代码,尽量不要同时导入mybatis 和 mybatis-plus !版本的差异!
6.连接数据库!这一步和mybatis 相同!
application.properties
# mysql 5 驱动不同 com.mysql.jdbc.Driver 驱动可以向下兼容
spring.datasource.username=root
spring.datasource.password=xx
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.url=jdbc:mysql://localhost:3306/mybatis_plus?useSSL=false&useUnicode=true&characterEncoding=utf-8&serverTimezone=UTC
# mysql 8 驱动不同 com.mysql.cj.jdbc.Driver 需要增加时区的配置 serverTimezone=GMT%2B8
7.传统方式pojo-dao(连接mybatis,配置mapper.xml文件 ) -service-controller
7.使用了mybatis-plus 之后
- pojo
- mapper接口
- 使用
新建实体User
@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
private Long id;
private String name;
private Integer age;
private String email;
}
UserMapper
package com.feng.mapper;
import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.feng.pojo.User;
import org.springframework.stereotype.Repository;
// 在对应的Mapper 上面继承基本的类 BaseMapper
@Repository //代表持久层
public interface UserMapper extends BaseMapper<User> {
// 所有的CRUD操作都已经编写完成了
// 你不需要像以前的配置一大堆文件了!
}
主程序MybatisPlusApplication
注意点,我们需要在主启动类上去扫描我们的mapper包下的所有接口
package com.feng;
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
// 扫描我们的 mapper 文件夹
@MapperScan("com.feng.mapper")
@SpringBootApplication
public class MybatisPlusApplication {
public static void main(String[] args) {
SpringApplication.run(MybatisPlusApplication.class, args);
}
}
测试MybatisPlusApplicationTests
@SpringBootTest
class MybatisPlusApplicationTests {
// 继承了BaseMapper,所有的方法都来自于父类
// 我们也可以编写自己的扩展方法!
@Autowired
private UserMapper userMapper;
@Test
void contextLoads() {
//参数是一个wrapper, 条件构造器,这里我们先不用 null
//查询全部用户
List<User> users = userMapper.selectList(null);
users.forEach(user -> System.out.println(user));
}
}
如果遇到问题,选择降版本
运行结果
思考问题:
1.SQL谁帮我们写的?MyBatis-Plus
2.方法哪里来的?MyBatis-Plus 都写好了
4 配置日志
我们所有的sql现在是不可见的,我们希望知道它是怎么执行的,所以我们必须要看日志!
application.properties
# 数据库连接配置
spring.datasource.username=root
spring.datasource.password=fp
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.url=jdbc:mysql://localhost:3306/mybatis_plus?useSSL=false&useUnicode=true&characterEncoding=utf-8&serverTimezone=UTC
# 配置日志
mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl
配置完毕日志之后,后面的学习就需要注意这个自动生成的SQL,就会喜欢上mybatis-plus !
5 CRUD扩展
5.1 Insert
//测试插入
@Test
public void testInsert(){
User user = new User();
user.setName("fengpeng");
user.setAge(18);
user.setEmail("[email protected]");
int res = userMapper.insert(user);//帮我们自动生成id
System.out.println(res);// 受影响的行数
System.out.println(user);// 发现,id会自动回填
}
数据库插入的id的默认值为:全局的唯一id
5.2 主键生成策略
分布式系统唯一id生成:https://blog.csdn.net/qq_37469055/article/details/118061067
雪花算法:
snowflake是Twitter开源的分布式ID生成算法,结果是一个long型的ID。
其核心思想是:使用41bit作为毫秒数,10bit作为机器的ID(5个bit是数据中心,5个bit的机器ID),12bit作为毫秒内的流水号(意味着每个节点在每毫秒可以产生4096个 ID ),最后还有一个符号位,永远是0。可以保证几乎全球唯一!
这个算法单机每秒内理论上最多可以生成1000*(2^12),也就是409.6万个ID。
主键自增
我们需要配置主键自增:
1.实体类字段上@TableId(type = IdType.AUTO)
2.数据库字段一定要是自增!
User
package com.feng.pojo;
import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.annotation.TableId;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
// 对应数据库中的主键(uuid,自增id,雪花算法,redis,zookeeper!)
@TableId(type = IdType.AUTO)
private Long id;
private String name;
private Integer age;
private String email;
}
3.再次测试插入即可!
其余的源码解释
public enum IdType {
AUTO(0), // 数据库id自增
NONE(1), // 未设置主键
INPUT(2), // 手动输入
ASSIGN_ID(3),
ASSIGN_UUID(4);
private final int key;
private IdType(int key) {
this.key = key;
}
public int getKey() {
return this.key;
}
}
5.3 update
//测试更新
@Test
public void testUpdate(){
User user = new User();
// 通过条件自动拼接动态sql
user.setId(1666793926552178689L);
user.setName("feng~");
// 注意:updateById 但是参数是一个对象!
int rows = userMapper.updateById(user);
System.out.println(rows);
}
所有的sql都是自动帮你动态配置的!
5.4 自动填充
创建时间,修改时间!这些个操作一般都是自动化完成的,我们不希望手动更新!
阿里巴巴开发手册:所有的数据库表:gmt_create, gmt_modified几乎所有的表都要配置上!而且需要自动化!
方式一:数据库级别(工作中不允许你修改数据库)
1.在表中新增字段create_time,update_time
2.再次测试插入方法,我们需要先把实体类同步!
@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
// 对应数据库中的主键(uuid,自增id,雪花算法,redis,zookeeper!)
@TableId(type = IdType.AUTO)
private Long id;
private String name;
private Integer age;
private String email;
private Date createTime;
private Date updateTime;
}
3.再次更新查看结果即可
方式二:代码级别
1、删除数据库的默认值,更新操作!
2、实体类字段属性上需要增加注解
@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
// 对应数据库中的主键(uuid,自增id,雪花算法,redis,zookeeper!)
@TableId(type = IdType.AUTO)
private Long id;
private String name;
private Integer age;
private String email;
//字段添加填充内容
@TableField(fill = FieldFill.INSERT)
private Date createTime;
@TableField(fill = FieldFill.INSERT_UPDATE)
private Date updateTime;
}
3、编写处理器来处理这个注解即可!
MyMetaObjectHandler
package com.feng.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 //打印日志 lombok.extern.slf4j.Slf4j;
@Component // 一定不要忘记把处理器加到IOC容器中!
public class MyMetaObjectHandler implements MetaObjectHandler {
//插入时的填充策略
@Override
public void insertFill(MetaObject metaObject) {
log.info("start insert fill....");
//default MetaObjectHandler 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);
}
}
执行插入数据
//测试插入
@Test
public void testInsert(){
User user = new User();
user.setName("fengpeng");
user.setAge(18);
user.setEmail("[email protected]");
int res = userMapper.insert(user);//帮我们自动生成id
System.out.println(res);// 受影响的行数
System.out.println(user);// 发现,id会自动回填
}
执行更新操作
//测试更新
@Test
public void testUpdate(){
User user = new User();
// 通过条件自动拼接动态sql
user.setId(1666793952879788035L);
user.setName("feng~~~");
// 注意:updateById 但是参数是一个对象!
int rows = userMapper.updateById(user);
System.out.println(rows);
}
5.5 乐观锁
在面试过程中,我们经常会被问到乐观锁,悲观锁!这个其实非常简单!
乐观锁:顾名思义十分乐观,它总是认为不会出现问题,无论干什么不去上锁!如果出现了问题,再次更新值测试
悲观锁:顾名思义十分悲观,它总是认为总是出现问题,无论干什么都会上锁!再去操作!
我们这里主要讲解 乐观锁机制!
乐观锁实现方式:
- 取出记录时,获取当前version
- 更新时,带上这个version
- 执行更新时,set version = newVersion where version = oldVersion
- 如果version不对,就更新失败
乐观锁:1、先查询,获得版本号 version = 1
-- A
update user set name = 'feng' ,version = version + 1
where id = 2 and version =1
-- B 线程抢先完成,这个时候 version = 2 ,会导致 A 修改失败!
update user set name = 'feng' ,version = version + 1
where id = 2 and version =1
测试一下mybatis-plus的乐观锁插件
1、给数据库中增加version字段
2、我们实体类加对应的字段
@Version // 乐观锁Version注解
private Integer version;
3、
MyBatisPlusConfig
package com.feng.config;
import com.baomidou.mybatisplus.extension.plugins.MybatisPlusInterceptor;
import com.baomidou.mybatisplus.extension.plugins.inner.OptimisticLockerInnerInterceptor;
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.transaction.annotation.EnableTransactionManagement;
/**
* @author fengpeng
* @date 2023/6/10 15:43
*/
// 扫描我们的 mapper 文件夹
@MapperScan("com.feng.mapper")
@EnableTransactionManagement //事务
@Configuration //配置类
public class MyBatisPlusConfig {
// 注册乐观锁插件
@Bean
public MybatisPlusInterceptor mybatisPlusInterceptor() {
MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
interceptor.addInnerInterceptor(new OptimisticLockerInnerInterceptor());
return interceptor;
}
}
MybatisPlusApplicationTests
//测试乐观锁成功!
@Test
public void testOptimisticLocker(){
// 1、查询用户信息
User user = userMapper.selectById(1L);
// 2、修改用户信息
user.setName("feng");
user.setEmail("[email protected]");
// 3、执行更新操作
userMapper.updateById(user);
}
//测试乐观锁失败!多线程下
@Test
public void testOptimisticLocker2(){
// 线程1
User user = userMapper.selectById(1L);
user.setName("feng111");
user.setEmail("[email protected]");
// 模拟另外一个线程执行了插队操作
User user2 = userMapper.selectById(1L);
user2.setName("feng222");
user2.setEmail("[email protected]");
userMapper.updateById(user2);
// 自旋锁来多次尝试提交!
userMapper.updateById(user); // 如果没有乐观锁就会覆盖插队线程的值!
}
5.6 查询操作
//测试查询
@Test
public void testSelectById(){
User user = userMapper.selectById(1L);
System.out.println(user);
}
// 测试批量查询!
@Test
public void testSelectBatchId(){
/* Arrays.asList使用注意点:
(1)该方法适用于对象型数据的数组(String、Integer)
(2)该方法不建议使用于基本数据类型的数组(byte,short,int,long,float,double,boolean)
(3)该方法将数组与List列表链接起来:当更新其一个时,另一个自动更新
(4)不支持add()、remove()、clear()等方法
(5)如果你提前命名一个长度为3的基本类型,转成数组后,输出的长度就是1
总结:如果你的List只是用来遍历,就用Arrays.asList()*/
List<User> users = userMapper.selectBatchIds(Arrays.asList(1, 2, 3));
users.forEach(System.out::println);
}
// 按条件查询之一使用map操作
@Test
public void testSelectByBatchIds(){
Map<String, Object> map = new HashMap<>();
// 自定义要查询
map.put("name", "fengpeng");
map.put("age", "18");
List<User> users = userMapper.selectByMap(map);
users.forEach(System.out::println);
}
5.7 分页查询
分页在网站使用的十分之多!
1、原始的limit进行分页
2、pageHelper第三方插件
3、mybatis-plus其实也内置了分页插件!
如何使用
1、配置拦截器组件即可
MyBatisPlusConfig.java
// 扫描我们的 mapper 文件夹
@MapperScan("com.feng.mapper")
@EnableTransactionManagement //事务
@Configuration //配置类
public class MyBatisPlusConfig {
@Bean
public MybatisPlusInterceptor mybatisPlusInterceptor() {
MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
// 注册乐观锁插件
interceptor.addInnerInterceptor(new OptimisticLockerInnerInterceptor());
//添加分页插件
interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL));
return interceptor;
}
}
2、直接使用Page对象即可!
// 测试分页查询
@Test
public void testPage(){
// 参数一:当前第几页
// 参数二:页面大小数
// 使用了分页插件之后,所有的分页操作也变得简单了!
Page<User> page = new Page<>(2, 5);
userMapper.selectPage(page,null);
page.getRecords().forEach(System.out::println);
System.out.println(page.getTotal());
}
5.8 删除操作
基本的删除操作
// 测试删除
@Test
public void testDeleteById(){
userMapper.deleteById(1666793952879788035L);
}
// 通过id批量删除
@Test
public void testDeleteBatchId(){
userMapper.deleteBatchIds(Arrays.asList(1666793926552178689L,1666793952879788033L));
}
// 通过map删除
@Test
public void testDeleteMap(){
Map<String, Object> map = new HashMap<>();
map.put("name","fengpeng");
userMapper.deleteByMap(map);
}
我们在工作中会遇到一些问题:逻辑删除!
5.9 逻辑删除
物理删除:从数据库中直接移除
逻辑删除:在数据库中没有被移除,而是通过一个变量来让它失效! delete = 0 => delete = 1
管理员可以查看被删除的记录!防止数据的丢失,类似于回收站!
测试一下:
1、在数据表中增加一个delete 字段
2、实体类中增加属性
@TableLogic // 逻辑删除
private Integer deleted;
3、配置
application.properties
# 配置逻辑删除
mybatis-plus.global-config.db-config.logic-delete-value=1
mybatis-plus.global-config.db-config.logic-not-delete-value=0
4、测试删除一下!
// 测试删除
@Test
public void testDeleteById(){
userMapper.deleteById(1L);
}
记录依旧在数据库,但是值确已经变化了!
//测试查询
@Test
public void testSelectById(){
User user = userMapper.selectById(1L);
System.out.println(user);
}
以上的所有CRUD操作及其扩展操作,我们都必须精通掌握!
5.10 性能分析插件
新版本已经移除,使用执行SQL分析打印
6 条件构造器
十分重要:Wrapper
我们写一些复杂的sql就可以使用它来替代!
测试一
@Test
void contextLoads() {
// 查询name不为空的用户, 并且邮箱不为空的用户,年龄大于等于12
QueryWrapper<User> wrapper = new QueryWrapper<>();
wrapper.isNotNull("name")
.isNotNull("email")
.ge("age",12);
userMapper.selectList(wrapper).forEach(System.out::println);//和我们刚才学习的map对比一下
}
测试二
@Test
void test2(){
// 查询名字
QueryWrapper<User> wrapper = new QueryWrapper<>();
wrapper.eq("name","feng222");
//查询一个数据,出现多个结果使用List 或者 Map
User user = userMapper.selectOne(wrapper);
System.out.println(user);
}
测试三
@Test
void test3(){
// 查询年龄在 20 ~ 30 岁之间的用户
QueryWrapper<User> wrapper = new QueryWrapper<>();
wrapper.between("age",20,30); // 区间
Integer count = userMapper.selectCount(wrapper);// 查询结果数
System.out.println(count);
}
测试四
记住查看输出的SQL进行分析
// 模糊查询
@Test
void test3(){
// 查询年龄在 20 ~ 30 岁之间的用户
QueryWrapper<User> wrapper = new QueryWrapper<>();
// 左和右 指的是%在左边还是右边 %t%
wrapper
.notLike("name","e")//不包含
.likeRight("email","t"); // t%
List<Map<String, Object>> maps = userMapper.selectMaps(wrapper);
maps.forEach(System.out::println);
}
测试五
// 模糊查询
@Test
void test4(){
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);
}
测试六
//测试六
@Test
void test5(){
QueryWrapper<User> wrapper = new QueryWrapper<>();
// 通过id进行排序
wrapper.orderByDesc("id");
List<User> users = userMapper.selectList(wrapper);
users.forEach(System.out::println);
}
7 代码自动生成器
参考官网教程
标签:MybatisPlus,void,userMapper,public,user,com,id From: https://www.cnblogs.com/fengpeng123/p/17472623.html