SpringBoot-Mybatis_Plus學習記錄之公共欄位自動填充

z77z發表於2017-04-23
Spring BootMyBatis

一.應用場景

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

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

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

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

二.配置MybatisPlus

導包：只需要注意的一點就是，mybatisPlus是在2.0.6版本才支援的更新資料公共欄位自動填充，之前都是隻支援新增資料的時候可以使用。

如果是之前配置過MybatisPlus的同學只需要新增以下幾個步驟：

  1. 繼承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類裡面的變數（駝峰的命名方式）。

  1. 在mybatisplus的配置檔案中公共欄位生成類的bean：
// MP 全域性配置，更多內容進入類看註釋
GlobalConfiguration globalConfig = new GlobalConfiguration();
//配置公共欄位自動填寫
globalConfig.setMetaObjectHandler(new MyMetaObjectHandler());複製程式碼

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

  1. 填充的欄位需要忽略驗證，在表物件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;複製程式碼

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

如果之前沒有使用過MbatisPlus，可以出門左轉，連結：之前寫過的一個博文，裡面涉及到MybatisPlus的基礎使用配置

三.編寫測試類

//公共欄位自動填充
//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, `status`,last_update_name_id, 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), 2017-04-23 19:35:26.58(Timestamp)
2017/04/23-19:35:26 [main] DEBUG io.z77z.dao.SysUserMapper.insert- <==    Updates: 1
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 AS lastUpdateNameId,create_name_id AS createNameId,last_update_time AS lastUpdateTime,create_time AS createTime FROM sys_user WHERE id=? 
2017/04/23-19:35:26 [main] DEBUG io.z77z.dao.SysUserMapper.selectById- ==> Parameters: 6634923de4a14b6ca3bac5fdf31563a8(String)
2017/04/23-19:35:26 [main] DEBUG io.z77z.dao.SysUserMapper.selectById- <==      Total: 1
2017/04/23-19:35:26 [main] DEBUG io.z77z.dao.SysUserMapper.updateById- ==>  Preparing: UPDATE sys_user SET pswd=?, last_update_name_id=?, last_update_time=? WHERE id=? 
2017/04/23-19:35:26 [main] DEBUG io.z77z.dao.SysUserMapper.updateById- ==> Parameters: 123(String), 123(String), 2017-04-23 19:35:26.637(Timestamp), 6634923de4a14b6ca3bac5fdf31563a8(String)
2017/04/23-19:35:26 [main] DEBUG io.z77z.dao.SysUserMapper.updateById- <==    Updates: 1
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 AS lastUpdateNameId,create_name_id AS createNameId,last_update_time AS lastUpdateTime,create_time AS createTime FROM sys_user WHERE id=? 
2017/04/23-19:35:26 [main] DEBUG io.z77z.dao.SysUserMapper.selectById- ==> Parameters: 6634923de4a14b6ca3bac5fdf31563a8(String)
2017/04/23-19:35:26 [main] DEBUG io.z77z.dao.SysUserMapper.selectById- <==      Total: 1複製程式碼

五.總結

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

·······················································································································································

個人部落格：z77z.oschina.io/

此專案下載地址：git.oschina.net/z77z/spring…

·······················································································································································

相關文章