MyBatis-Plus通过version机制实现乐观锁的思路

356 阅读 0 评论 235 点赞

我是靠谱客的博主无奈棉花糖，最近开发中收集的这篇文章主要介绍MyBatis-Plus通过version机制实现乐观锁的思路，觉得挺不错的，现在分享给大家，希望可以做个参考。

概述

MyBatis-Plus是通过version机制实现乐观锁的。

大致思路：

取出记录，携带记录的当前version；
更新记录的时候，比较记录当前的version是否有改变；
如果version未改变，则更新记录，并更新version，一般值+1；
如果version改变了，则不更新记录。

version机制的核心思想就是，假设发生并发冲突的几率很低，只有当更新数据的时候采取检查是否有冲突，而判断是否有冲突的依据就是version的值是否被改变了。

配置

MyBatis-Plus中配置乐观锁分两步：

实例化OptimisticLockerInnerInterceptor，并添加到MyBatis-Plus的拦截器链中；
定义version字段，并在Entity中使用@Version注解注释version字段。

说明:

支持的数据类型只有: int、Integer、long、Long、Date、Timestamp、LocalDateTime；

整数类型下 newVersion = oldVersion + 1；

newVersion 会回写到 entity 中；

仅支持 updateById(id) 与 update(entity, wrapper) 方法；

在 update(entity, wrapper) 方法下， wrapper 不能复用!!!

配置如下：

首先，实例化OptimisticLockerInnerInterceptor，并添加到拦截器链中：

@Configuration
public class MyBatisPlusConfig {

    /**
     * 插件配置
     *
     * @return
     */
    @Bean
    public MybatisPlusInterceptor mybatisPlusInterceptor() {
        MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
        // 向MyBatis-Plus的过滤器链中添加分页拦截器，需要设置数据库类型（主要用于分页方言）
        interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL));
        // 添加乐观锁拦截器
        interceptor.addInnerInterceptor(new OptimisticLockerInnerInterceptor());
        return interceptor;
    }
}

然后，使用@Version注解：

@Data
@TableName("tb_user")
public class UserEntity {
    private Long id;
    private String name;
    private Integer age;
    private String email;

    @TableField(value = "create_time", fill = FieldFill.INSERT)
    private Date createTime;

    @TableField(value = "update_time", fill = FieldFill.INSERT_UPDATE)
    private Date updateTime;

    @TableLogic(value = "0", delval = "-1")
    @TableField(value = "delete_flag", fill = FieldFill.INSERT)
    private Integer deleteFlag;

    @Version
    @TableField(value = "version", fill = FieldFill.INSERT)
    private Integer version;
}

配置insert时候，version默认值赋1：

/**
 * 自动填充字段值得配置
 */
@Component
public class AutoFillFieldValueConfig implements MetaObjectHandler {

    @Override
    public void insertFill(MetaObject metaObject) {
        this.strictInsertFill(metaObject, "createTime", Date.class, new Date());
        this.strictInsertFill(metaObject, "updateTime", Date.class, new Date());
        this.strictInsertFill(metaObject, "deleteFlag", Integer.class, 0);
        this.strictInsertFill(metaObject, "version", Integer.class, 1);
    }

    @Override
    public void updateFill(MetaObject metaObject) {
        this.strictUpdateFill(metaObject, "updateTime", Date.class, new Date());
    }
}

测试一下

1.测试新增记录

首先新增一条数据：

@Test
    public void testVersionInsert() {
        // 插入一个新的用户
        UserEntity newUser = new UserEntity();
        newUser.setId(12L);
        newUser.setName("Kelly");
        newUser.setAge(28);
        newUser.setEmail("Kelly@163.com");
        userMapper.insert(newUser);
    }

控制台日志：

==> Preparing: INSERT INTO tb_user ( id, name, age, email, create_time, update_time, delete_flag, version ) VALUES ( ?, ?, ?, ?, ?, ?, ?, ? )
==> Parameters: 12(Long), Kelly(String), 28(Integer), Kelly@163.com(String), 2021-09-25 00:14:23.894(Timestamp), 2021-09-25 00:14:23.896(Timestamp), 0(Integer), 1(Integer)
<== Updates: 1

数据库数据：

可以看到，新增记录时，version默认赋值为1。

2.测试更新记录

下面，来测试一下更新记录，看看version的变化。

   @Test
    public void testVersionUpdate() {
        // 查询用户记录
        UserEntity updateUser = userMapper.selectById(12L);
        // 更新用户记录
        updateUser.setId(12L);
        updateUser.setAge(30);
        userMapper.updateById(updateUser);
    }

注意：这里有一个坑！

一定要先查询出这条数据，再更新，乐观锁才会生效！！！

控制台打印的日志：

==> Preparing: SELECT id,name,age,email,create_time,update_time,delete_flag,version FROM tb_user WHERE id=? AND delete_flag=0
==> Parameters: 12(Long)
<==    Columns: id, name, age, email, create_time, update_time, delete_flag, version
<==        Row: 12, Kelly, 30, Kelly@163.com, 2021-09-25 00:14:24, 2021-09-25 00:20:24, 0, 1
<==      Total: 1

......

==> Preparing: UPDATE tb_user SET name=?, age=?, email=?, create_time=?, update_time=?, version=? WHERE id=? AND version=? AND delete_flag=0
==> Parameters: Kelly(String), 30(Integer), Kelly@163.com(String), 2021-09-25 00:14:24.0(Timestamp), 2021-09-25 00:20:24.0(Timestamp), 2(Integer), 12(Long), 1(Integer)
<==    Updates: 1

数据库数据：