mybatis plus CU自動填充 和 軟刪除自動填充的實現(xiàn)方法
說明
CU 是 CRUD 中的創(chuàng)建和修改
本文實現(xiàn)以下需求效果
- 創(chuàng)建數(shù)據(jù)時自動填充
createTime - 更新數(shù)據(jù)時自動填充
updateTime(每次修改都自動填充新的updateTime值) - 軟刪除數(shù)據(jù)時自動填充
deleteUserId和deleteTime
創(chuàng)建
實體類
為實體類(DO)的 createTime 字段配置以下 Annotation，代表標記在插入(insert into)時自動填充字段值
@TableField(fill = FieldFill.INSERT) private Date createTime;
實現(xiàn) MetaObjectHandler
如果實體(DO)中配置了上面的注解，就會執(zhí)行這個 handler。這里在 insert 時自動填充 createTime 字段的值
public class MybatisPlusMetaObjectHandler implements MetaObjectHandler {
private static final String createTime = "createTime";
@Override
public void insertFill(MetaObject metaObject) {
this.strictInsertFill(metaObject, createTime, Date::new, Date.class);
// 關于 is_delete 字段，這里不提供默認值，因為官方推薦設置數(shù)據(jù)庫中列的默認值
}
@Override
public void updateFill(MetaObject metaObject) {}
}
配置
注入 IOC 容器。
在 MybatisPlusMetaObjectHandler 類上配置 @Configuration 注解也可以達到同樣目的。
@Configuration
public class MybatisPlusConfig {
@Bean
public MybatisPlusMetaObjectHandler mybatisPlusCommonDateFieldValueFillHandler(){
return new MybatisPlusMetaObjectHandler();
}
}
更新
實體類
在實體類(DO)上配置注解
@TableField(fill = FieldFill.UPDATE) private Date updateTime;
實現(xiàn) MetaObjectHandler
如果實體(DO)中配置了上面的注解，就會執(zhí)行這個 handler。這里在 update 時自動填充 updateTime 字段的值
特別注意，這里需要重寫 strictFillStrategy 方法，因為默認的行為不會按照預期執(zhí)行（每次更新數(shù)據(jù)時都更新 updateTime)
public class MybatisPlusMetaObjectHandler implements MetaObjectHandler {
private static final String updateTime = "updateTime";
@Override
public void insertFill(MetaObject metaObject) {}
@Override
public void updateFill(MetaObject metaObject) {
this.strictUpdateFill(metaObject, updateTime, Date::new, Date.class);
}
/**
* 嚴格模式填充策略,默認有值不覆蓋,如果提供的值為null也不填充
*
* @param metaObject metaObject meta object parameter
* @param fieldName java bean property name
* @param fieldVal java bean property value of Supplier
* @return this
* @since 3.3.0
*/
@Override
public MetaObjectHandler strictFillStrategy(MetaObject metaObject, String fieldName, Supplier<?> fieldVal) {
// 但當自動填充字段為 updateTime 時，始終更新它
if (fieldName.equals(updateTime)) {
Object obj = fieldVal.get();
metaObject.setValue(fieldName, obj);
} else if (metaObject.getValue(fieldName) == null) { // 這個 if 是源碼中的
Object obj = fieldVal.get();
if (Objects.nonNull(obj)) {
metaObject.setValue(fieldName, obj);
}
}
return this;
}
}
配置
參考創(chuàng)建章節(jié)中的配置，如果已經(jīng)配置了就不需要再配置了
軟刪除
配置 application.yml
mybatis-plus:
global-config:
db-config:
logic-delete-field: is_delete # 邏輯刪除屬性名稱（為數(shù)據(jù)庫中的字段名稱）
logic-delete-value: 1 # 代表已刪除的值
logic-not-delete-value: 0 # 代表未刪除的值
實體類
在實體類(DO)中對以下字段配置注解。
標識 isDelete 字段作為邏輯刪除的標識，然后有兩個需要自動填充值的字段。
/** * 邏輯刪除標識 * * \@TableLogic\ 注解標記邏輯刪除屬性 */ @TableLogic private Boolean isDelete; @TableField(fill = FieldFill.UPDATE) private Integer deleteUserId; @TableField(fill = FieldFill.UPDATE) private Date deleteTime;
重寫 DefaultSqlInjector
如果需要在軟刪除時自動填充其他字段的值，才需要重寫這個 DefaultSqlInjector，否則忽略本小節(jié)。
這里配置了邏輯刪除時填充其他字段值的 SqlInjector
public class MybatisPlusSqlInjector extends DefaultSqlInjector {
@Override
public List<AbstractMethod> getMethodList(Class<?> mapperClass) {
final List<AbstractMethod> methods = super.getMethodList(mapperClass);
methods.add(new LogicDeleteByIdWithFill());
return methods;
}
}
實現(xiàn) MetaObjectHandler
由于 mybatis plus 的 @TableField 注解枚舉字段 fill 的值沒有我們想要的 Delete，所以 Update 和 Delete 實際上都是走的 updateFill 函數(shù)，在函數(shù)內(nèi)部我們需要區(qū)分出到底是更新還是軟刪除，才能繼續(xù)下一步即自動填充不同行為下字段的值
public class MybatisPlusMetaObjectHandler implements MetaObjectHandler {
private static final String deleteUserId = "deleteUserId";
private static final String updateTime = "updateTime";
private static final String deleteTime = "deleteTime";
@Override
public void insertFill(MetaObject metaObject) {}
@Override
public void updateFill(MetaObject metaObject) {
// 有這兩個字段并且也已經(jīng) deleteUserId 有值(外面必須為實體類設置 deleteUserId 字段的值)，deleteTime 外面不給值
if (metaObject.hasGetter(deleteUserId)
&& metaObject.hasGetter(deleteTime)
&& !ObjectUtil.isNull(metaObject.getValue(deleteUserId))
&& ObjectUtil.isNull(metaObject.getValue(deleteTime))) {
this.strictUpdateFill(metaObject, deleteUserId, () -> (Integer) metaObject.getValue(deleteUserId), Integer.class);
this.strictUpdateFill(metaObject, deleteTime, Date::new, Date.class);
} else {
this.strictUpdateFill(metaObject, updateTime, Date::new, Date.class);
}
}
/**
* 嚴格模式填充策略,默認有值不覆蓋,如果提供的值為null也不填充
*
* @param metaObject metaObject meta object parameter
* @param fieldName java bean property name
* @param fieldVal java bean property value of Supplier
* @return this
* @since 3.3.0
*/
@Override
public MetaObjectHandler strictFillStrategy(MetaObject metaObject, String fieldName, Supplier<?> fieldVal) {
// 但當自動填充字段為 updateTime 時，始終更新它
if (fieldName.equals(updateTime)) {
Object obj = fieldVal.get();
metaObject.setValue(fieldName, obj);
} else if (metaObject.getValue(fieldName) == null) { // 這個 if 是源碼中的
Object obj = fieldVal.get();
if (Objects.nonNull(obj)) {
metaObject.setValue(fieldName, obj);
}
}
return this;
}
}
配置(注入到 IOC)
我們需要將上面寫的 MybatisPlusSqlInjector 注入 IOC 容器。
同樣的，這兩個 Bean 的配置，與在 MybatisPlusSqlInjector 和 MybatisPlusMetaObjectHandler 上配置 @Configuration 注解的效果一樣。
@Configuration
public class MybatisPlusConfig {
@Bean
public MybatisPlusSqlInjector mybatisPlusSqlInjector(){
return new MybatisPlusSqlInjector();
}
@Bean
public MybatisPlusMetaObjectHandler mybatisPlusCommonDateFieldValueFillHandler(){
return new MybatisPlusMetaObjectHandler();
}
}
創(chuàng)建 MyBaseRepository
我這里將 Mapper 稱為 Repository。因為我用到了 MapStruct 庫，個人感覺它更適合被稱為 Mapper。
我們需要自己定義一個 MyBaseMapper 繼承自 BaseMapper(mybatis plus 的)，然后添加一個如下的方法簽名，必須跟下面示例代碼一樣，因為我猜測內(nèi)部是通過反射來調(diào)用的這個函數(shù)，所以方法簽名必須一致，否則無法被 mybatis plus 庫調(diào)用哦。
public interface MyBaseMapper<Entity> extends BaseMapper<Entity> {
/**
* 邏輯刪除填充其他字段的值
*
* @param entity 要刪除的實體對象
* @return 受影響記錄數(shù)量
*/
int deleteByIdWithFill(Entity entity);
}
我們原來的 Repository 繼承自 mybatis plus 的 BaseMapper，現(xiàn)在我們需要修改為繼承自上面新寫的 MyBaseMapper。
創(chuàng)建 MyBaseService
因為我希望 XXXService 中也有 deleteByIdWithFill 函數(shù)，所以這里我還自定義了 Service 的基類，如果不需要的話可以忽略本小節(jié)。
自定義的 MyBaseService 繼承自 mybatis plus 的 IService<> 接口，然后添加如下方法簽名，注意方法簽名中的返回值是 boolean 而不是 int，因為寫 Service 需要方便外部使用。
public interface MyBaseService<Entity> extends IService<Entity> {
/**
* 邏輯刪除填充其他字段的值
*
* @param entity 要刪除的實體對象
* @return 受影響記錄數(shù)量
*/
boolean deleteByIdWithFill(Entity entity);
}
然后我們寫一個 MyBaseService 的實現(xiàn)類。
注意這里我們需要繼承自 mybatis plus 的 ServiceImpl 實現(xiàn)，減少我們自己實現(xiàn)的代碼量，同時還需要實現(xiàn)我們的 MyBaseService 接口，然后內(nèi)部寫的巴巴適適的😋
public class MyBaseServiceImpl<EntityRepository extends MyBaseMapper<Entity>, Entity>
extends ServiceImpl<EntityRepository, Entity>
implements MyBaseService<Entity> {
/**
* 邏輯刪除填充其他字段的值
*
* @param entity 要刪除的實體對象
* @return 受影響記錄數(shù)量
*/
@Override
public boolean deleteByIdWithFill(Entity entity) {
return SqlHelper.retBool(getBaseMapper().deleteByIdWithFill(entity));
}
}
最后，原來的 XXXService 修改為繼承自新寫的 MyBaseService，XXXServiceImpl 修改為繼承自新寫的 MyBaseServiceImpl
public interface TestService extends MyBaseService<Test> {}
@Service
public class TestServiceImpl extends MyBaseServiceImpl<TestRepository, Test>
implements TestService{}
食用🍜
在 Controller 中的使用方法
@PostMapping("delete")
public ResponseEntity<?> delete(@Valid @NotNull(message = CommonRule.error.whenParamNull) @RequestBody TestTestDeleteBodyVo body) {
final Test test = testService.getById(body.getId());
if (test == null) {
return ResponseEntity.ok().build();
}
test.setDeleteUserId(StpUtil.getLoginIdAsInt()); // 必須在軟刪之前設置 deleteUserId 字段的值
testService.deleteByIdWithFill(test); // 軟刪除必須是這樣刪除
return ResponseEntity.ok().build();
}
到此這篇關于mybatis plus CU自動填充 和 軟刪除自動填充的文章就介紹到這了,更多相關mybatis plus自動填充內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家！
相關文章
這篇文章主要介紹了Java實現(xiàn)微信公眾平臺朋友圈分享功能詳細代碼，小編覺得挺不錯的，這里分享給大家，供需要的朋友參考。2017-11-11
本篇文章主要介紹了idea如何設置類頭注釋和方法注釋(圖文)，小編覺得挺不錯的，現(xiàn)在分享給大家，也給大家做個參考。一起跟隨小編過來看看吧2017-12-12
Kaptcha是一個強大而靈活的Java驗證碼生成庫,通過合理的配置和使用,它可以有效地提高web應用的安全性,防止自動化程序的濫用,這篇文章主要介紹了SpringBoot集成Kaptcha驗證碼,需要的朋友可以參考下2024-07-07
線性表是其組成元素間具有線性關系的一種數(shù)據(jù)結構，對線性表的基本操作主要有，獲取元素，設置元素值，遍歷，插入，刪除，查找，替換，排序等。而線性表可以采用順序儲存結構和鏈式儲存結構，本節(jié)主要講解順序表、單鏈表以及雙鏈表的各種基本操作。2017-03-03
今天小編就為大家分享一篇關于eclipse連接不到genymotion問題的解決方案，小編覺得內(nèi)容挺不錯的，現(xiàn)在分享給大家，具有很好的參考價值，需要的朋友一起跟隨小編來看看吧2019-03-03
解決spring cloud zuul與nginx的域名轉(zhuǎn)發(fā)問題
這篇文章主要介紹了spring cloud zuul與nginx的域名轉(zhuǎn)發(fā)問題，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2021-07-07
這篇文章主要介紹了SpringBoot停止啟動時測試檢查rabbitmq操作，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2021-09-09
這篇文章主要介紹了如何在Spring中自定義scope的方法示例，小編覺得挺不錯的，現(xiàn)在分享給大家，也給大家做個參考。一起跟隨小編過來看看吧2019-02-02
Java面試題之HashMap 的 hash 方法原理是什么
那天，小二去蔚來面試，面試官老王一上來就問他：HashMap 的 hash 方法的原理是什么？當時就把裸面的小二給蚌埠住了，這篇文章將詳細解答該題目2021-11-11
Java微信二次開發(fā)（一） Java微信請求驗證功能
這篇文章主要為大家詳細介紹了Java微信二次開發(fā)第一篇，Java微信請求驗證功能，具有一定的參考價值，感興趣的小伙伴們可以參考一下2017-04-04