SpringBoot-Mybatis_Plus學習記錄之公共字段自動填充

一.應用場景

---

平時在建對象表的時候都會有最後修改時間，最後修改人這兩個字段，對於這些大部分表都有的字段，每次在新增和修改的時候都要考慮到這幾個字段有沒有傳進去，很麻煩。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…

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