MP(MyBatis-Plus)實現樂觀鎖更新功能

實現步驟

step1:添加樂觀鎖攔截器

MP的其他攔截器功能可以參考官網

@Bean
public MybatisPlusInterceptor mybatisPlusInterceptor() {
    MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
    interceptor.addInnerInterceptor(new OptimisticLockerInnerInterceptor());
    return interceptor;
}

step2:配置Entity

@TableField(fill = FieldFill.UPDATE)
@Version
private Date updateTime;

用更新字段充當版本號。

  • 上面的配置需要注意的是:updateTime既配置自動填充,又配置了樂觀鎖功能。MP在進行處理時會先進行樂觀鎖處理,然後再進行自動填充。
  • 問題:前端送了id和一些需要更新的字段過來,每次需要從數據庫中查出version,然後再進行更新(要麼前端將版本號傳過來);
  • 支持的數據類型只有:int,Integer,long,Long,Date,Timestamp,LocalDateTime;
  • 僅支持 updateById(id) 與 update(entity, wrapper) 方法,在 update(entity, wrapper) 方法下, wrapper 不能復用!!!
  • 對於updateTime這個字段,在數據庫中建議設置成時區不相關的時間戳類型。

多說一點

使用updateTime作為版本號可能會存在一些問題。

我們通常需要將updateTime返回給前端頁面,假如我們不做任何設置,返回前端的數據大概是下面的樣子:

{
  "userId": 367,
  "address": "上海市自由之路xxxxxx...",
  "workUnit": "XXXX",
  "createTime": "2020-12-22T00:00:00.000+08:00",
  "updateTime": "2021-01-08T17:28:14.782+08:00"
}

這種時間格式可能不是前端頁面需要的,這是我們可以進行如下設置;

spring:
  jackson:
    default-property-inclusion: non_null
    time-zone: GMT+8
    date-format: yyyy-MM-dd HH:mm:ss

返回的數據

{
 "userId": 367,
 "address": "上海市自由之路xxxxxx...",
 "workUnit": "XXXX",
 "createTime":"2020-12-22 00:00:00",
 "updateTime":"2021-01-08 17:28:14"
}

經過這個配置後,就可以得到可讀性比較好的時間格式了。但是我們需要注意的時候,這個時間的精度其實已經丟失了,當前提交修改數據到後端,這個值和數據庫中的值已經不相等了。所以永遠不能將數據更新成功。

所以這種情況下使用updateTime來進行樂觀鎖更新就不太適合了。可以考慮在表中另外加一個字段version來進行樂觀鎖更新。

但其實還是有比較好的解決辦法的。

首先,我們不要對返回的時間格式進行全局話配置。

spring:
  jackson:
    default-property-inclusion: non_null
    time-zone: GMT+8
    # date-format: yyyy-MM-dd HH:mm:ss

然後,添加一個updateTime的備份字段updateTimeSimpleFormat,並對這個字段進行單獨的時間格式化。

private Date updateTime;

@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
private Date updateTimeSimpleFormat;

updateTimeSimpleFormat不要生成get和set方法,在updateTime的set方法中對updateTimeSimpleFormat進行賦值。

public void setUpdateTime(Date updateTime) {
      this.updateTime = updateTime;
      this.updateTimeSimpleFormat = updateTime;
  }

這樣就既能滿足前端返回格式化的時間,後端又能獲取到樂觀鎖的版本號。

但是,這個方法比較不好的地方,就是必須對每個時間格式進行@JsonFormat註解配置,不能進行全局配置,比較繁瑣。

總結:使用updateTime作為樂觀鎖的優點就是不需要再新加字段,比較簡潔。但是帶來的問題上面已經講的很清楚了。還是印證了那個真理:沒有完美的技術,只有適合的技術。