目录
1、什么是MyBatis-Plus
官方文档:MyBatis-Plus (baomidou.com)
简介
MyBatis-Plus (opens new window)(简称 MP)是一个 MyBatis (opens new window)的增强工具,在 MyBatis 的基础上只做增强不做改变,为简化开发、提高效率而生。
特性
- 无侵入:只做增强不做改变,引入它不会对现有工程产生影响,如丝般顺滑
- 损耗小:启动即会自动注入基本 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、导入对应依赖
2、研究依赖如何配置
3、代码如何编写
4、提高拓展技术能力
1.简单的一个mybatis-plus快速入门
1.创建数据库,依照官方文档给出的sql语句直接创建
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)
);
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');
2.创建项目,连接数据库mybatis_plus,导入依赖
<!--数据库驱动-->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
</dependency>
<!--lombok-->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
</dependency>
<!--mybatis-plus-->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.5.1</version>
</dependency>
3.连接数据库配置
#数据库连接配置
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.url=jdbc:mysql://localhost:3306/mybatis_plus?serverTimezone=UTC
spring.datasource.username=root
spring.datasource.password=123456
4.编写实体类(导入lombok可以小偷一下懒)
@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
private Long id;
private String name;
private Integer age;
private String email;
}
5.编写实体类对应的mapper接口
@Mapper //添加@Mapper注解就可以不用进行扫描操作
@Repository //代表持久层
public interface UserMapper extends BaseMapper<User> {
//继承BaseMapper以后,所有CRUD操作就已经完成了
//不需要像以前编写一大堆文件
}
如果在这里不添加@Mapper的话,就要在启动类中添加@MapperScan开启扫描
6.进行Test测试
@SpringBootTest
class MybatisPlusApplicationTests {
//继承了BaseMapper,所有的方法都来自父类,我们也可以编写自己的扩展方法
@Autowired
private UserMapper userMapper;
@Test
void contextLoads() {
//参数是一个wrapper ,条件构造器,这里我们先不用 null
List<User> users = userMapper.selectList(null);
users.forEach(System.out::println);
}
}
7.结果
2.配置日志
直接在配置文件中添加如下代码,在运行测试类即可
#配置日志
mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl
结果:
3.CRUD扩展
Insert
@Test
public void testInsert(){
User user = new User();
user.setName("lqh");
user.setAge(22);
user.setEmail("835788261@qq.com");
Integer insert = userMapper.insert(user);//会帮我们自动生成id
System.out.println(insert);//受影响的行数
System.out.println(user);//通过日志发现id会自动回填
}
这里自动生成了一长串的id
数据库插入的id的默认值为:全局的唯—id
主键生成策略
源码解释
public enum IdType {
AUTO(0), //数据库id自增
NONE(1), //未设置主键
INPUT(2), //手动输入
ASSIGN_ID(3), //默认的全局唯一id
ASSIGN_UUID(4); //全局唯一id uuid
}
默认 : ID_WORKER 全局唯一Id
分布式系统唯一Id生成:分布式系统唯一ID生成方案汇总 - nick hao - 博客园
- Twitter的snowflake算法
snowflake是Twitter开源的分布式ID生成算法,结果是一个long型的ID。其核心思想是:使用41bit作为毫秒数,10bit作为机器的ID(5个bit是数据中心(北京、香港···),5个bit的机器ID),12bit作为毫秒内的流水号(意味着每个节点在每毫秒可以产生 4096 个 ID),最后还有一个符号位,永远是0。
- 具体实现的代码可以参看https://github.com/twitter/snowflake。
主键自增:AUTO 我们需要配置主键自增
-
在实体类字段上配置
@TableId(type = IdType.AUTO)
@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
@TableId(type = IdType.AUTO)
private Long id;
private String name;
private Integer age;
private String email;
}
数据库主键自增
数据库ID字段自增
手动输入:Input
实体类中将 @TableId(type = IdType.AUTO)改为@TableId(type = IdType.INPUT)
@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
@TableId(type = IdType.INPUT)
private Long id;
private String name;
private Integer age;
private String email;
}
运行之后发现ID为空
所以就需要手动输入
@Test
public void testInsert(){
User user = new User();
user.setId(6L);
user.setName("lqh");
user.setAge(22);
user.setEmail("835788261@qq.com");
Integer insert = userMapper.insert(user);//会帮我们自动生成id
System.out.println(insert);//受影响的行数
System.out.println(user);//通过日志发现id会自动回填
}
数据库中成功添加
Update
@Test
public void testUpdate(){
User user = new User();
user.setId(6L);
user.setName("小明");
user.setAge(8);
int i = userMapper.updateById(user); //updateById,但是参数是个user
System.out.println(i);
}
可以自动拼接动态Sql
自动填充
创建时间、更改时间! 这些操作一般都是自动化完成,我们不希望手动更新
阿里巴巴开发手册︰几乎所有的表都要配置 gmt_create、gmt_modified !而且需要自动化
方式一:数据库级别(工作中不允许修改数据库级别)
1、在表中增加字段:create_time,update_time
更新时间要选上根据当前时间戳更新
2、再次测试插入或更新方法,我们需要在实体类中同步
@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
@TableId(type = IdType.INPUT)
private Long id;
private String name;
private Integer age;
private String email;
private Date createTime;
private Date updateTime;
}
3、查看结果
方式二:代码级别
1、删除数据库的默认值,更新操作
2、实体类字段属性上需要增加注解
//字段添加填充内容
@TableField(fill = FieldFill.INSERT)
private Date createTime;
@TableField(fill = FieldFill.INSERT_UPDATE)
private Date updateTime;
3、编写处理器来处理这个注解即可
@Slf4j //日志
@Component //放入SpringBoot中 一定不要忘记把处理器加到Ioc容器中
public class MyMetaObjectHandler extends MetaObjectHandler {=
//插入时的填充策略
@Override
public void insertFill(MetaObject metaObject) {
log.info("start insert fill ....");
//setFieldValByName(java.lang.String fieldName, java.lang.Object fieldVal, org.apache.ibatis.reflection.MetaObject metaObject)
this.setFieldValByName("createTIme",new Date(),metaObject);
this.setFieldValByName("updateTime",new Date(),metaObject);
}
//更新时的填充策略
@Override
public void updateFill(MetaObject metaObject) {
log.info("start insert fill ....");
this.setFieldValByName("updateTime",new Date(),metaObject);
}
}
4、测试插入/更新,观察时间
//测试插入
@Test
public void testInsert(){
User user = new User();
user.setName("lqh");
user.setAge(22);
user.setEmail("835788261@qq.com");
Integer insert = userMapper.insert(user);//会帮我们自动生成id
System.out.println(insert);//受影响的行数
System.out.println(user);//通过日志发现id会自动回填
}
//测试更新
@Test
public void testUpdate(){
User user = new User();
user.setId(1490940253118459910L);
user.setName("小明");
user.setAge(22);
int i = userMapper.updateById(user);
System.out.println(i);
}
官方用法:
@Slf4j //日志
@Component //放入SpringBoot中 一定不要忘记把处理器加到Ioc容器中
public class MyMetaObjectHandler implements MetaObjectHandler {
//插入时的填充策略
@Override
public void insertFill(MetaObject metaObject) {
log.info("start insert fill ....");
this.strictInsertFill(metaObject, "createTime", LocalDateTime.class, LocalDateTime.now());
this.strictInsertFill(metaObject, "updateTime", LocalDateTime.class, LocalDateTime.now());
}
//更新时的填充策略
@Override
public void updateFill(MetaObject metaObject) {
log.info("start insert fill ....");
this.strictInsertFill(metaObject, "updateTime", LocalDateTime.class, LocalDateTime.now());
}
}
这里使用了LocalDateTime,所以实体类的类型 也需要改成LocalDateTime
//字段添加填充内容
@TableField(fill = FieldFill.INSERT)
private LocalDateTime createTime;
@TableField(fill = FieldFill.INSERT_UPDATE)
private LocalDateTime updateTime;
测试
//测试插入
@Test
public void testInsert(){
User user = new User();
user.setName("lqh");
user.setAge(22);
user.setEmail("835788261@qq.com");
Integer insert = userMapper.insert(user);//会帮我们自动生成id
System.out.println(insert);//受影响的行数
System.out.println(user);//通过日志发现id会自动回填
}
//测试更新
@Test
public void testUpdate(){
User user = new User();
user.setId(1490940253118459909L);
user.setName("小明");
user.setAge(20);
int i = userMapper.updateById(user);
System.out.println(i);
}
乐观锁&悲观锁
乐观锁:顾名思义十分乐观,他总是认为不会出现问题,无论干什么都不上锁!如果出现了问题,再次更新值测试
悲观锁:顾名思义十分悲观,他总是认为出现问题,无论干什么都会上锁!再去操作
乐观锁实现方式:
- 取出记录时,获取当前version
- 更新时,带上这个version
- 执行更新时,set version = newVersion where version = oldVersion
- 如果version不对,就更新失败
乐观锁:先查询,获得版本号
-- A
update user set name = "wsk",version = version+1
where id = 1 and version = 1
-- B (B线程抢先完成,此时version=2,会导致A线程修改失败!)
update user set name = "wsk",version = version+1
where id = 1 and version = 1
测试Mybatis-Plus乐观锁插件
1、给数据库中增加version字段
2、实体类加对应的字段
@Version//乐观锁version注解
private Integer version;
3、注册组件
@EnableTransactionManagement //自动管理事务
@Configuration //配置类
public class MyBatisPlusConfig {
@Bean
public MybatisPlusInterceptor mybatisPlusInterceptor() {
MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
interceptor.addInnerInterceptor(new OptimisticLockerInnerInterceptor());
return interceptor;
}
}
4、测试
- 成功
@Test//测试乐观锁成功
public void testOptimisticLocker1(){
//1、查询用户信息
User user = userMapper.selectById(1L);
//2、修改用户信息
user.setAge(18);
user.setEmail("835788261@qq.com");
//3、执行更新操作
userMapper.updateById(user);
}
- 失败
Select
- 通过id查询单个用户
@Test //通过id查询单个用户
public void testSelectById(){
User user = userMapper.selectById(1L);
System.out.println(user);
}
- 通过id查询多个用户
@Test //通过id查询多个用户
public void testSelectByIds(){
List<User> users = userMapper.selectBatchIds(Arrays.asList(1L, 2L, 3L));
users.forEach(System.out::println);
}
- 条件查询 通过map封装
//条件查询 map
@Test
public void testSelectByIds1(){
HashMap<String, Object> map = new HashMap<>();
map.put("name","小明");
List<User> users = userMapper.selectByMap(map);
users.forEach(System.out::println);
}
分页查询
分页在网站的使用十分之多
1、原始的limit分页
2、pageHelper第三方插件
3、MybatisPlus其实也内置了分页插件
使用:
1、配置拦截器组件
//分页插件
@Bean
public MybatisPlusInterceptor mybatisPlusInterceptor1() {
MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.H2));
return interceptor;
}
2、直接使用page对象即可
//分页查询
@Test
public void testPageSelect(){
//参数一current:当前页 参数二size:页面大小
//使用了分页插件之后,所有的分页操作都变得简单了
Page<User> page = new Page<>(1,5);
userMapper.selectPage(page,null);
page.getRecords().forEach(System.out::println);
System.out.println("总数=>"+page.getTotal());
}
Delete
//根据ID删除
@Test
public void testDeleteById(){
userMapper.deleteById(1490940253118459912L);
}
//根据ID批量删除
@Test
public void testDeleteBatchIds(){
userMapper.deleteBatchIds(Arrays.asList(1490940253118459908L,1490940253118459911L));
}
//map集合条件筛选删除
@Test
public void testDeleteByMap(){
HashMap<String, Object> map = new HashMap<>();
map.put("name","小明");
map.put("age",22);
userMapper.deleteByMap(map);
}
逻辑删除
物理删除:从数据库中直接删除
逻辑删除:在数据库中没有被删除,而是通过一个变量来使他失效! deleted=0 ==> deleted=1
管理员可以查看被删除的记录!防止数据的丢失,类似于回收站
测试一下:
1、在数据表中增加一个deleted字段
2、实体类中添加对应属性
@TableLogic//逻辑删除注解
private Integer deleted;
3、配置(高版本可不需要配置组件,自动装配)
# 全局逻辑删除的实体字段名(since 3.3.0,配置后可以忽略不配置步骤2 步骤二:实体类字段上加上@TableLogic注解)
mybatis-plus.global-config.db-config.logic-delete-field=flag
# 逻辑已删除值(默认为 1)
mybatis-plus.global-config.db-config.logic-delete-value=1
# 逻辑未删除值(默认为 0)
mybatis-plus.global-config.db-config.logic-not-delete-value=0
4、测试一下删除
@Test
public void testDeleteById(){
userMapper.deleteById(1L);
}
1号用户还在,但是deleted变成了1
现在再查询一下以后,发现查询为空
以上所有的CRUD及其扩展操作,我们都必须精通掌握!会大大提高工作写项目的效率!
4、性能分析插件
目前官方已经废除了这个插件,现在基本都是使用Druid或者p6syp
5、条件构造器
测试一
@Test
void testWrapper1() {
//参数是一个wrapper ,条件构造器,和刚才的map对比学习
//查询name不为空,email不为空,age大于18的用户
QueryWrapper<User> wrapper = new QueryWrapper<>();
wrapper.isNotNull("name")
.isNotNull("email")
.ge("age",20);
userMapper.selectList(wrapper).forEach(System.out::println);
}
测试二
@Test
void testWrapper2() {
//查询name=lz的用户
QueryWrapper<User> wrapper = new QueryWrapper<>();
wrapper.eq("name","lz");
//查询一个数据selectOne,若查询出多个会报错
//Expected one result (or null) to be returned by selectOne(), but found: *
//若出现多个结果使用list或map
User user = userMapper.selectOne(wrapper);//查询一个数据,若出现多个结果使用list或map
System.out.println(user);
}
测试三
@Test
void testWrapper3() {
//查询age在10-20之间的用户
QueryWrapper<User> wrapper = new QueryWrapper<>();
wrapper.between("age",10,20);//区间
Long count = userMapper.selectCount(wrapper);//输出查询的数量selectCount
System.out.println(count);
}
测试四
@Test
void testWrapper4() {
//模糊查询
QueryWrapper<User> wrapper = new QueryWrapper<>();
wrapper
.notLike("name","s")
.likeRight("email","t");//qq% 左和右?
List<Map<String, Object>> maps = userMapper.selectMaps(wrapper);
maps.forEach(System.out::println);
}
测试五
@Test
void testWrapper5() {
//模糊查询
// SELECT id,name,age,email,version,deleted,create_time,update_time
//FROM user
//WHERE deleted=0 AND id IN
//(select id from user where id<5)
QueryWrapper<User> wrapper = new QueryWrapper<>();
wrapper.inSql("id","select id from user where id<5");
List<Object> objects = userMapper.selectObjs(wrapper);
objects.forEach(System.out::println);
}
测试六
@Test
public void testWrapper6() {
QueryWrapper<User> wrapper = new QueryWrapper<>();
//通过id进行降序排序
wrapper.orderByDesc("id");
List<User> userList = userMapper.selectList(wrapper);
userList.forEach(System.out::println);
}
6、代码自动生成器
官方文档:
新:代码生成器(新) | MyBatis-Plus (baomidou.com)
适用版本:mybatis-plus-generator 3.5.1 及其以上版本,对历史版本不兼容
旧:代码生成器(旧) | MyBatis-Plus (baomidou.com)
适用版本:mybatis-plus-generator 3.5.1 以下版本