公共欄位自動填入之 Mybatis Plus

這篇文章主要介紹了SpringBoot Mybatis Plus公共字段自動填充功能的相關資料,需要的朋友可以參考下

一.應用場景

##平常在建立物件表的時候都會有最後修改時間，最後修改人這兩個字段，對於這些大部分錶都有的字段，每次在新增和修改的時候都要考慮到這幾個字段有沒有傳進去，很麻煩。 mybatisPlus有一個很好的解決方案。也就是公共欄位自動填充的功能。一般滿足下面條件的欄位就可以使用此功能：

這個欄位是大部分錶都會有的。

這個欄位的值是固定的，或則欄位值是可以在後台動態取得的。

常用的就是last_update_time，last_update_name這兩個欄位。

二.設定MybatisPlus

導包：只需要注意的一點就是，mybatisPlus是在2.0.6版本才支援的

更新資料公共欄位自動填充，之前都是只支援新增資料的時候可以使用。

如果是先前配置過MybatisPlus的同學只需要加入以下幾個步驟：

#繼承IMetaObjectHandler抽象類別，實作insertFill()新增加資料時需要填入的欄位設定和updateFill()更新資料的時候需要填入的欄位設定這兩個方法：

package io.z77z.util;
import java.util.Date;
import org.apache.ibatis.reflection.MetaObject;
import org.apache.shiro.SecurityUtils;
import org.springframework.stereotype.Component;
import com.baomidou.mybatisplus.mapper.MetaObjectHandler;
import io.z77z.entity.SysUser;
/** mybatisplus自定义填充公共字段 ,即没有传的字段自动填充*/
@Component
public class MyMetaObjectHandler extends MetaObjectHandler {
  //新增填充
  @Override
  public void insertFill(MetaObject metaObject) {
    Object lastUpdateNameId = metaObject.getValue("lastUpdateNameId");
    Object lastUpdateTime = metaObject.getValue("lastUpdateTime");
    //获取当前登录用户
    SysUser user = (SysUser)SecurityUtils.getSubject().getPrincipal();
    if (null == lastUpdateNameId) {
      metaObject.setValue("lastUpdateNameId", user.getId());
    }
    if (null == lastUpdateTime) {
      metaObject.setValue("lastUpdateTime", new Date());
    }
  }
  //更新填充
  @Override
  public void updateFill(MetaObject metaObject) {
    insertFill(metaObject);
  }
}

注意：getValue()方法的參數是pojo類別裡面的

變數（駝峰的命名方式）。

在mybatisplus的設定檔中公用欄位產生類別的bean：

// MP 全局配置，更多内容进入类看注释
GlobalConfiguration globalConfig = new GlobalConfiguration();
//配置公共字段自动填写
globalConfig.setMetaObjectHandler(new MyMetaObjectHandler());

也就是將剛剛寫的公用欄位填入的設定設定到MP全域配置的物件中。

填滿的欄位需要忽略驗證，在表格物件pojo類別的對應

屬性上加入下列註解：

/**
 * 最后修改人Id
 */
@TableField(value="last_update_id",validate=FieldStrategy.NOT_EMPTY)
private String lastUpdateNameId;
/**
 * 最后修改时间
 */
@TableField(value="last_update_time",validate=FieldStrategy.NOT_EMPTY)
private Date lastUpdateTime;

原因：因為呼叫更新和插入的方法時，會驗證你所傳的屬性是否為空，來判斷是否該更新和插入這個屬性，這個就和公共字段自動填充相衝突了，所以需要這個註解來標識此屬性不需要驗證。不然在插入的時候就會填滿失敗。

三.寫測試類別

//公共字段自动填充
//1.在mybatisplus的配置文件中公共字段生成类的bean
//2.实现IMetaObjectHandler类
//3.忽略对应字段的为空检测，在pojo类的属性上添加@TableField(value="last_update_name_id",validate=FieldStrategy.IGNORED)
@Test
public void publicTest(){
  SysUser user = new SysUser();
  user.setEmail("1093615728@qq.com");
  user.setNickname("z77z");
  user.setPswd("123123");
  user.setStatus("1");
  sysUserService.insert(user);
  sysUserService.selectById(user.getId());
  SysUser user1 = new SysUser();
  user1.setPswd("123");
  user1.setId(user.getId());
  sysUserService.updateById(user1);
  sysUserService.selectById(user.getId());
}

四.測試日誌

2017/04/23-19:35:26 [main] DEBUG io.z77z.dao.SysUserMapper.insert- ==>  Preparing: INSERT INTO sys_user ( id, nickname, email, pswd, `statdus_last_upatenameate , last_update_time ) VALUES ( ?, ?, ?, ?, ?,?, ? )

2017/04/23-19:35:26 [main] DEBUG io.z77z.dao.SysUserMapper.insert- ==> ; Parameters: 6634923de4a14b6ca3bac5fdf31563a8(String), z77z(String), 1093615728@qq.com(String), 123123(String), 1(String), 123(String), 123123(String), 1(String), 123(String), 123123(String), 1(String), 123(3), 62013, 62023:502523:5062023), 62023:5062923:5062025:504025:24-2025:5062025:5062523:20-2023:502523:0062523232523:20-2023:0025): 62523:506202323220.
2017/04/23-19:35:26 [main] DEBUG io.z77z.dao.SysUserMapper.insert- 2017/04/23-19:35:26 [ main] DEBUG io.z77z.dao.SysUserMapper.selectById- ==>  Preparing: SELECT id,nickname,email,pswd,last_login_time AS lastLoginTime,`status`,last_update_name_id lastUpdate, ASate_create_pate_p AS createTime FROM sys_user WHERE id=?
2017/04/23-19:35:26 [main] DEBUG io.z77z.dao.SysUserMapper.selectById- ==> Parameters: 6634923de4a14b66F 04/23-19:35:26 [main] DEBUG io.z77z.dao.SysUserMapper.selectById- 2017/04/23-19:35:26 [main] DEBUG #2017/04/23-19:35:26 [main] DEBUG . z77z.dao.SysUserMapper.updateById- ==>  Preparing: UPDATE sys_user SET pswd=?, last_update_name_id=?, last_update_time=? WHERE id=?
2017/04/23-16 io.z77z.dao.SysUserMapper.updateById- ==> Parameters: 123(String), 123(String), 2017-04-23 19:35:26.637(Timestamp), 6634923de4a14 /23-19:35:26 [main] DEBUG io.z77z.dao.SysUserMapper.updateById- 2017/04/23-19:35:26 [main] DEBUG io.z777 .dao.SysUserMapper.selectById- ==>  Preparing: SELECT id,nickname,email,pswd,last_login_time AS lastLoginTime,`status`,last_update_name_id AS lastUpdateNameId,create_name_iduser create_name_iduser_create_ HERE id= ?
2017/04/23-19:35:26 [main] DEBUG io.z77z.dao.SysUserMapper.selectById- ==> Parameters: 6634923de4a14b6ca3bac5fdf; Parameters: 6634923de4a14b6ca3bac5fdf31563a8( 35:26 [main] DEBUG io.z77z.dao.SysUserMapper.selectById-


五.總結

本來是打算創建人和創建時間，也使用這種方法處理的，最後發現，如果將這兩個字段也忽略為空的判斷，也就是加上validate=FieldStrategy.NOT_EMPTY，在更新數據的時候會將創建人和創建時間一起更新了，不傳的話就會更新為空。所以我覺得這個mybatisPlus這個公用欄位自動填入功能是不錯，但是在正真用的上的需求上面使用的時候還不夠完善。

【相關推薦】

1. Java免費影片教學

#2. 全面解析Java註解

#3. 阿里巴巴Java開發手冊

以上是公共欄位自動填入之 Mybatis Plus的詳細內容。更多資訊請關注PHP中文網其他相關文章！