简介
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 操作智能分析阻断,也可自定义拦截规则,预防误操作
开始上手
1、首先导入依赖
<!--mybatis-plus-->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.0.5</version>
</dependency>
<!--数据连接-->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
</dependency>
2、创建数据库和表,插入数据
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');
3、根据表里的各个属性,创建实体类
注意:这里的实体类名要和表名一致
@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
private Long id;
private String name;
private Integer age;
private String email;
}
4、创建mapper接口继承BaseMapper,添加注解设置为持久层
BaseMapper<User> 它会自动封装一些CRUD操作,这个User泛型就是表也是返回的实体类
这里不需要定义一些方法,BaseMapper都帮我们写好了,直接调用即可
@Repository //持久层
public interface UserMapper extends BaseMapper<User> {//CRUD可以直接使用:继承 BaseMapper
}
5、在主类开启扫描,让它能找到这个usermapper
@MapperScan("com.kai.Mapper")
@SpringBootApplication
public class DemoApplication {
public static void main(String[] args) {
SpringApplication.run(DemoApplication.class, args);
}
}
6、添加数据库和日志配置
#数据库配置
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.url=jdbc:mysql://localhost:3306/mybatis_plus?serverTimezone=GMT%2B8&useUnicode=true&characterEncoding=utf-8
spring.datasource.username=root
spring.datasource.password=root
#日志
mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl
7、测试查询数据的方法(删除的方法和下面差不多)
@SpringBootTest
class DemoApplicationTests {
@Autowired
UserMapper userMapper;
//(查询全部)
@Test
void contextLoads() {
List<User> users = userMapper.selectList(null);//选择条件的mapper
users.forEach(System.out::println);
}
@Test //通过id查找
void selectByid(){
User user = userMapper.selectById(1L);
System.out.println(user);
}
@Test //通过map条件查询
void selectByMap(){
Map<String,Object> map = new HashMap<>();
map.put("name","Jack");
List<User> users = userMapper.selectByMap(map);
users.forEach(System.out::println);
}
// 测试批量查询:根据ID!
@Test public void testSelectByBatchId(){
List<User> users = userMapper.selectBatchIds(Arrays.asList(1, 2, 3));
users.forEach(System.out::println);
}
}
主键生成策略(Id、插入、修改)
分布式系统唯一id生成:https://www.cnblogs.com/haoxinyue/p/5208136.html
雪花算法: :@TableId(type = IdType.ID_WORKER)
snowflake是Twitter开源的分布式ID生成算法,结果是一个long型的ID。其核心思想是:使用41bit作为
毫秒数,10bit作为机器的ID(5个bit是数据中心,5个bit的机器ID),12bit作为毫秒内的流水号(意味
着每个节点在每毫秒可以产生 4096 个 ID),最后还有一个符号位,永远是0。可以保证几乎全球唯一!
插入数据(自增):在这里我并没有设置id,但是可以默认生成
@Test
void testInsert() { //插入
User user = new User();
user.setName("asdf");
user.setAge(33);
user.setEmail("22@qq.com");
int insert = userMapper.insert(user);//我并没有设置di
System.out.println(insert);
}
实体类字段上 @TableId(type = IdType.AUTO)
并且在数据库设置自增
TableId注解的其他type生成主键id
public enum IdType {
AUTO(0), // 数据库id自增
NONE(1), // 未设置主键
INPUT(2), // 手动输入
ID_WORKER(3), // 默认的全局唯一id
UUID(4), // 全局唯一id uuid
ID_WORKER_STR(5); //ID_WORKER 字符串表示法
}
修改数据
它的内部是根据id修改的
@Test
void testUpdate() { //修改
User user = new User( 6L,"hh",22,"2134@qq.com"); //6L代表 Long类型的6
int i = userMapper.updateById(user);
System.out.println(i);
}
数据的自动填充(创建、修改时间)
1、通过修改数据库
创建时间和修改时间:添加默认值,时间戳
修改时间的更新打勾。
2、通过代码设置
数据库不用任何修改:
注解填充字段 @TableField(… fill = FieldFill.INSERT) 生成器策略部分也可以配置!
在User实体类中添加两个属性
@TableField(fill = FieldFill.INSERT) //设置属性在插入时候修改
private Date createTime;
@TableField(fill = FieldFill.INSERT_UPDATE) //设置属性在插入和修改的时候修改
private Date updateTime;
自定义实现类 MyMetaObjectHandler
@Component //放入spring的IOC容器中
public class MyMetaObjectHandler implements MetaObjectHandler {
//创建自动填充(需要修改两个属性)
@Override
public void insertFill(MetaObject metaObject) {
this.setFieldValByName("createTime",new Date(),metaObject);
this.setFieldValByName("updateTime",new Date(),metaObject);
}
//修改自动填充
@Override
public void updateFill(MetaObject metaObject) {
this.setFieldValByName("updateTime",new Date(),metaObject);
}
}
乐观锁(修改后上锁)
OptimisticLockerInnerInterceptor
当要更新一条记录的时候,希望这条记录没有被别人更新,如果被人更新了就没法执行本次操作了。
乐观锁实现方式:
- 先进行查询,获取当前version
- 然后在更新时,带上这个version
- 执行更新时,update table set version = newVersion where version = oldVersion
- 如果version不对,就更新失败
乐观锁 : 十分乐观,它总是认为不会出现问题,无论做什么不去上锁!如果出现了问题,再次更新值测试
悲观锁:十分悲观,它总是认为总是出现问题,无论做什么都会上先上锁!再去操作!
使用方法
乐观锁:先查询,获得版本号 version = 1
– 假设一个A线程 进行修改数据
update user set name = “nihao”, version = version + 1 where id = 2 and version = 1
– B 线程抢先完成,这个时候 version = 2,会导致 A 修改失败!
update user set name = “nihao”, version = version + 1 where id = 2 and version = 1
字段上加上@Version注解
注意:乐观锁当前仅支持 updateById(id) 与 update(entity, wrapper) 方法
1、首先添加version属性
@Version
private Integer version;
2、同时在数据库中也添加,并设置默认值为1
3、自定义Configuration通过Bean 注入乐观锁:OptimisticLockerInterceptor
@MapperScan("com.kai.Mapper") //开启包扫描
@Configuration
@EnableTransactionManagement //开启事务
public class MyConfig {
@Bean //注册乐观锁
public OptimisticLockerInterceptor optimisticLockerInterceptor() {
return new OptimisticLockerInterceptor();
}
}
4、测试正常情况的乐观锁
@Test //测试正确的乐观锁
void testLock(){
User user = userMapper.selectById(1L);
user.setName("nihao");
user.setEmail("nihao.qq.com");
int i = userMapper.updateById(user);
System.out.println(i);
}
测试没有修改成功的乐观锁
@Test //测试失败的乐观锁
void testLock2(){
//模拟第一线程
User user = userMapper.selectById(1L);
user.setName("nihao");
user.setEmail("nihao.qq.com");
//模拟插队线程
User user2 = userMapper.selectById(1L);
user2.setName("nihao2");
user2.setEmail("nihao.qq.com2");
userMapper.updateById(user2);
userMapper.updateById(user);//如果没有乐观锁的话,插队的线程会被第一线程覆盖
如图第一个线程被插队了所以执行没成功说明乐观锁起效了。
分页查询
在Configuration下自己添加一个 分页插件
// 分页插件
@Bean
public PaginationInterceptor paginationInterceptor() {
return new PaginationInterceptor();
}
使用方法:
//分页查询
@Test
void testPage(){
Page<User> page =new Page<User>(2,5); //5个为一页,当前是第二页就是 6-10
//得到Page接口
IPage<User> userIPage = userMapper.selectPage(page, null);
//返回List<User>
List<User> records = userIPage.getRecords();
records.forEach(System.out::println);
}
逻辑删除
物理删除 :从数据库中直接移除 逻辑删除 :再数据库中没有被移除,而是通过一个变量来让他失效! deleted = 0 =>
deleted = 1
现在数据库添加一个deleted属性。
在User类中添加
@TableLogic //逻辑删除
private Integer deleted;
application.properties中添加以下配置
#配置逻辑删除,没删除是0被删除的修改为1
mybatis-plus.global-config.db-config.logic-delete-value=1
mybatis-plus.global-config.db-config.logic-not-delete-value=0
在configuration中注入逻辑删除配置
//逻辑删除
@Bean
public ISqlInjector Injector(){
return new LogicSqlInjector();
}
测试
//-------------------------------------------逻辑删除
@Test
void testDelete(){
int i = userMapper.deleteById(6L);
}
它是用的update然后在后面自动填充了一个 and deleted = 0 ,当我们调用删除的一些sql方法时候,会将deleted修改为1
再次执行查询,也会添加 and deleted = 0
配置的策略汇总:MyConfig.java
package com.kai.Config;
import com.baomidou.mybatisplus.core.injector.ISqlInjector;
import com.baomidou.mybatisplus.extension.injector.LogicSqlInjector;
import com.baomidou.mybatisplus.extension.plugins.OptimisticLockerInterceptor;
import com.baomidou.mybatisplus.extension.plugins.PaginationInterceptor;
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.transaction.annotation.EnableTransactionManagement;
@MapperScan("com.kai.Mapper") //开启包扫描
@Configuration
@EnableTransactionManagement //开启事务
public class MyConfig {
@Bean //注册乐观锁
public OptimisticLockerInterceptor optimisticLockerInterceptor() {
return new OptimisticLockerInterceptor();
}
// 分页插件
@Bean
public PaginationInterceptor paginationInterceptor() {
return new PaginationInterceptor();
}
//逻辑删除
@Bean
public ISqlInjector Injector(){
return new LogicSqlInjector();
}
}
User.java
package com.kai.Pojo;
import com.baomidou.mybatisplus.annotation.*;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import java.util.Date;
@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
@TableId(type = IdType.AUTO) //设置主键自增
private Long id;
private String name;
private Integer age;
private String email;
@Version
private Integer version;
@TableField(fill = FieldFill.INSERT) //设置属性在插入时候修改
private Date createTime;
@TableField(fill = FieldFill.INSERT_UPDATE) //设置属性在插入和修改的时候修改
private Date updateTime;
@TableLogic //逻辑删除
private Integer deleted;
}