Mybatis-plus 对 MyBatis 做了封装,使得我们可以更加方便的进行操作,本文主要讲述了 Spring boot 中 如何快速使用 MyBatis-plus 实现简单crud、id生成策略配置、逻辑删除、自动填充数据、数据库乐观锁等常用功能。
org.springframework.boot
spring-boot-starter
mysql
mysql-connector-java
runtime
org.projectlombok
lombok
true
org.springframework.boot
spring-boot-starter-test
test
com.baomidou
mybatis-plus-boot-starter
3.0.5
server:
port: 15536
spring:
datasource:
url: jdbc:mysql://localhost:3306/spring-tx-learning?useSSL=false
driver-class-name: com.mysql.jdbc.Driver
username: xxxxx
password: xxxxx
# mybatis-plus 打印sql的日志秩序配置这句就可以了,
# 在 mybatis-plus 中配置mybatis的debug日志(logging.level.******:debug)已经不生效了
mybatis-plus:
configuration:
log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
DROP TABLE IF EXISTS `mp_test`;
CREATE TABLE `mp_test` (
`id` bigint(20) NOT NULL,
`name` varchar(255) COLLATE utf8mb4_general_ci NOT NULL,
`create_time` datetime ,
`update_time` datetime,
`deleted` tinyint ,
PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_general_ci;
@Data
public class MpTest {
private Long id;
private String name;
private Date createTime;
private Date updateTime;
private Integer deleted;
}
public interface MpTestMapper extends BaseMapper {
}
@MapperScan("com.fly.mp.mapper")
@TableId()
的方式自动生成ID。@TableId(type = IdType.ID_WORKER) // 雪花算法,数字类型,默认
private Long id;
其中,IdType 共有如下几种枚举类型:
AUTO(0), // 自动
NONE(1),// 无
INPUT(2),// 自己设置的值
ID_WORKER(3), // 雪花算法,数字类型
UUID(4), // uuid字符串
ID_WORKER_STR(5); // 雪花算法,字符串类型
编写测试:
@Autowired
private MpTestMapper mpTestMapper;
@Test
public void testInsert() {
MpTest mpTest = new MpTest();
mpTest.setName("lisa");
int rows = mpTestMapper.insert(mpTest);
System.out.println("影响行数: " + rows);
}
运行测试得到如下结果:
可以看到打印出了执行的sql语句,插入了一行记录。我们在数据库中看下结果如下:
实体类中配置:
@TableField(fill = FieldFill.INSERT) // 创建记录的时候需要填充
private Date createTime;
@TableField(fill = FieldFill.INSERT_UPDATE) // 创建和修改的时候都需要填充
private Date updateTime;
配置拦截器
@Component
public class MPMetaObjectHandler implements MetaObjectHandler {
// 插入的时候自动填充
@Override
public void insertFill(MetaObject metaObject) {
Date date = new Date();
setFieldValByName("createTime", date, metaObject);
setFieldValByName("updateTime", date, metaObject);
}
// 更新的时候自动填充
@Override
public void updateFill(MetaObject metaObject) {
Date date = new Date();
setFieldValByName("updateTime", date, metaObject);
}
}
运行测试得到如下结果:
数据库中的结果:
可以看到,相比前面的测试,这次为我们自动填充了 create_time 和 update_time 字段。
我们做一次更新测试,测试代码如下:
@Test
public void testUpdate() {
MpTest mpTest = new MpTest();
mpTest.setId(1246358037395869697L);
mpTest.setName("linda222");
int rows = mpTestMapper.updateById(mpTest);
System.out.println("影响行数: " + rows);
}
更新结果如下:
可以看到在更新是自动为我们更新了update_time 字段为当前时间。
实体类中加入注解:
@TableLogic // 标记这个字段是逻辑删除字段
@TableField(fill = FieldFill.INSERT) // 插入记录的时候便初始化该字段
private Integer deleted;
拦截器中初始化逻辑删除字段的值:
@Component
public class MPMetaObjectHandler implements MetaObjectHandler {
// 插入的时候自动填充
@Override
public void insertFill(MetaObject metaObject) {
Date date = new Date();
setFieldValByName("createTime", date, metaObject);
setFieldValByName("updateTime", date, metaObject);
// 初始化逻辑删除字段为0
setFieldValByName("deleted", 0, metaObject);
}
}
配置逻辑删除的bean:
@Bean
public ISqlInjector sqlInjector() {
return new LogicSqlInjector();
}
插入数据结果,我们可以看到,deleted字段已经被初始化为0,
我们调用 delete 方法:
@Test
public void testUpdate() {
int rows = mpTestMapper.deleteById(1246362537481412610L);
System.out.println("影响行数: " + rows);
}
运行结果:
我们看到其实执行的是update 操作,将逻辑删除字段deleted 修改成了1:
我们再执行查询操作:
@Test
public void testSelect() {
List mpTest1 = mpTestMapper.selectList(null);
}
执行结果:
可以发现,在where条件中已经自动加上了deleted=0, 被逻辑删除的记录已经无法查到了。
实体类配置:
@Version // 标记这个字段为乐观锁
@TableField(fill = FieldFill.INSERT) // 插入记录是初始化乐观锁的值
private Integer version;
表中加入 version 字段.
初始化乐观锁的值:
@Component
public class MPMetaObjectHandler implements MetaObjectHandler {
// 插入的时候自动填充
@Override
public void insertFill(MetaObject metaObject) {
Date date = new Date();
setFieldValByName("createTime", date, metaObject);
setFieldValByName("updateTime", date, metaObject);
// 初始化逻辑删除字段为0
setFieldValByName("deleted", 0, metaObject);
// 初始化乐观锁字段值为1
setFieldValByName("version", 1, metaObject);
}
}
配置逻辑删除插件:
@Bean
public OptimisticLockerInterceptor optimisticLockerInterceptor() {
return new OptimisticLockerInterceptor();
}
执行插入逻辑结果如下:
可以看到自动初始化 version 字段为1, 再执行更新逻辑:
@Test
public void testOptimisticLock() {
// 乐观锁的更新一般是需要将原来的数据查出来,再去更新
MpTest mpTest = mpTestMapper.selectById(1246368556806774786L);
mpTest.setName("lalalalasdfafssadf");
int update = mpTestMapper.update(mpTest, null);
System.out.println("影响行数:" + update);
}