您好,登錄后才能下訂單哦!
本篇內(nèi)容主要講解“mybatis plus CU如何實(shí)現(xiàn)自動(dòng)填充和軟刪除自動(dòng)填充”,感興趣的朋友不妨來看看。本文介紹的方法操作簡單快捷,實(shí)用性強(qiáng)。下面就讓小編來帶大家學(xué)習(xí)“mybatis plus CU如何實(shí)現(xiàn)自動(dòng)填充和軟刪除自動(dòng)填充”吧!
CU 是 CRUD 中的創(chuàng)建和修改
本文實(shí)現(xiàn)以下需求效果
創(chuàng)建數(shù)據(jù)時(shí)自動(dòng)填充 createTime
更新數(shù)據(jù)時(shí)自動(dòng)填充 updateTime
(每次修改都自動(dòng)填充新的 updateTime
值)
軟刪除數(shù)據(jù)時(shí)自動(dòng)填充 deleteUserId
和 deleteTime
實(shí)體類
為實(shí)體類(DO)的 createTime
字段配置以下 Annotation,代表標(biāo)記在插入(insert into)時(shí)自動(dòng)填充字段值
@TableField(fill = FieldFill.INSERT) private Date createTime;
實(shí)現(xiàn) MetaObjectHandler
如果實(shí)體(DO)中配置了上面的注解,就會(huì)執(zhí)行這個(gè) handler。這里在 insert 時(shí)自動(dòng)填充 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); // 關(guān)于 is_delete 字段,這里不提供默認(rèn)值,因?yàn)楣俜酵扑]設(shè)置數(shù)據(jù)庫中列的默認(rèn)值 } @Override public void updateFill(MetaObject metaObject) {} }
注入 IOC 容器。
在 MybatisPlusMetaObjectHandler
類上配置 @Configuration
注解也可以達(dá)到同樣目的。
@Configuration public class MybatisPlusConfig { @Bean public MybatisPlusMetaObjectHandler mybatisPlusCommonDateFieldValueFillHandler(){ return new MybatisPlusMetaObjectHandler(); } }
實(shí)體類
在實(shí)體類(DO)上配置注解
@TableField(fill = FieldFill.UPDATE) private Date updateTime;
實(shí)現(xiàn) MetaObjectHandler
如果實(shí)體(DO)中配置了上面的注解,就會(huì)執(zhí)行這個(gè) handler。這里在 update 時(shí)自動(dòng)填充 updateTime
字段的值
特別注意,這里需要重寫 strictFillStrategy
方法,因?yàn)槟J(rèn)的行為不會(huì)按照預(yù)期執(zhí)行(每次更新數(shù)據(jù)時(shí)都更新 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); } /** * 嚴(yán)格模式填充策略,默認(rèn)有值不覆蓋,如果提供的值為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) { // 但當(dāng)自動(dòng)填充字段為 updateTime 時(shí),始終更新它 if (fieldName.equals(updateTime)) { Object obj = fieldVal.get(); metaObject.setValue(fieldName, obj); } else if (metaObject.getValue(fieldName) == null) { // 這個(gè) 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 # 代表未刪除的值
在實(shí)體類(DO)中對(duì)以下字段配置注解。
標(biāo)識(shí) isDelete
字段作為邏輯刪除的標(biāo)識(shí),然后有兩個(gè)需要自動(dòng)填充值的字段。
/** * 邏輯刪除標(biāo)識(shí) * * \@TableLogic\ 注解標(biāo)記邏輯刪除屬性 */ @TableLogic private Boolean isDelete; @TableField(fill = FieldFill.UPDATE) private Integer deleteUserId; @TableField(fill = FieldFill.UPDATE) private Date deleteTime;
如果需要在軟刪除時(shí)自動(dòng)填充其他字段的值,才需要重寫這個(gè) DefaultSqlInjector
,否則忽略本小節(jié)。
這里配置了邏輯刪除時(shí)填充其他字段值的 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; } }
實(shí)現(xiàn) MetaObjectHandler
由于 mybatis plus 的 @TableField
注解枚舉字段 fill
的值沒有我們想要的 Delete
,所以 Update
和 Delete
實(shí)際上都是走的 updateFill
函數(shù),在函數(shù)內(nèi)部我們需要區(qū)分出到底是更新還是軟刪除,才能繼續(xù)下一步即自動(dòng)填充不同行為下字段的值
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) { // 有這兩個(gè)字段并且也已經(jīng) deleteUserId 有值(外面必須為實(shí)體類設(shè)置 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); } } /** * 嚴(yán)格模式填充策略,默認(rèn)有值不覆蓋,如果提供的值為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) { // 但當(dāng)自動(dòng)填充字段為 updateTime 時(shí),始終更新它 if (fieldName.equals(updateTime)) { Object obj = fieldVal.get(); metaObject.setValue(fieldName, obj); } else if (metaObject.getValue(fieldName) == null) { // 這個(gè) if 是源碼中的 Object obj = fieldVal.get(); if (Objects.nonNull(obj)) { metaObject.setValue(fieldName, obj); } } return this; } }
我們需要將上面寫的 MybatisPlusSqlInjector
注入 IOC 容器。
同樣的,這兩個(gè) Bean 的配置,與在 MybatisPlusSqlInjector
和 MybatisPlusMetaObjectHandler
上配置 @Configuration
注解的效果一樣。
@Configuration public class MybatisPlusConfig { @Bean public MybatisPlusSqlInjector mybatisPlusSqlInjector(){ return new MybatisPlusSqlInjector(); } @Bean public MybatisPlusMetaObjectHandler mybatisPlusCommonDateFieldValueFillHandler(){ return new MybatisPlusMetaObjectHandler(); } }
我這里將 Mapper
稱為 Repository
。因?yàn)槲矣玫搅?MapStruct
庫,個(gè)人感覺它更適合被稱為 Mapper
。
我們需要自己定義一個(gè) MyBaseMapper 繼承自 BaseMapper(mybatis plus 的),然后添加一個(gè)如下的方法簽名,必須跟下面示例代碼一樣,因?yàn)槲也聹y內(nèi)部是通過反射來調(diào)用的這個(gè)函數(shù),所以方法簽名必須一致,否則無法被 mybatis plus 庫調(diào)用哦。
public interface MyBaseMapper<Entity> extends BaseMapper<Entity> { /** * 邏輯刪除填充其他字段的值 * * @param entity 要?jiǎng)h除的實(shí)體對(duì)象 * @return 受影響記錄數(shù)量 */ int deleteByIdWithFill(Entity entity); }
我們原來的 Repository
繼承自 mybatis plus 的 BaseMapper
,現(xiàn)在我們需要修改為繼承自上面新寫的 MyBaseMapper
。
因?yàn)槲蚁M?XXXService
中也有 deleteByIdWithFill
函數(shù),所以這里我還自定義了 Service 的基類,如果不需要的話可以忽略本小節(jié)。
自定義的 MyBaseService
繼承自 mybatis plus 的 IService<>
接口,然后添加如下方法簽名,注意方法簽名中的返回值是 boolean
而不是 int
,因?yàn)閷?Service 需要方便外部使用。
public interface MyBaseService<Entity> extends IService<Entity> { /** * 邏輯刪除填充其他字段的值 * * @param entity 要?jiǎng)h除的實(shí)體對(duì)象 * @return 受影響記錄數(shù)量 */ boolean deleteByIdWithFill(Entity entity); }
然后我們寫一個(gè) MyBaseService
的實(shí)現(xiàn)類。
注意這里我們需要繼承自 mybatis plus 的 ServiceImpl
實(shí)現(xiàn),減少我們自己實(shí)現(xiàn)的代碼量,同時(shí)還需要實(shí)現(xiàn)我們的 MyBaseService
接口,然后內(nèi)部寫的巴巴適適的?
public class MyBaseServiceImpl<EntityRepository extends MyBaseMapper<Entity>, Entity> extends ServiceImpl<EntityRepository, Entity> implements MyBaseService<Entity> { /** * 邏輯刪除填充其他字段的值 * * @param entity 要?jiǎng)h除的實(shí)體對(duì)象 * @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()); // 必須在軟刪之前設(shè)置 deleteUserId 字段的值 testService.deleteByIdWithFill(test); // 軟刪除必須是這樣刪除 return ResponseEntity.ok().build(); }
到此,相信大家對(duì)“mybatis plus CU如何實(shí)現(xiàn)自動(dòng)填充和軟刪除自動(dòng)填充”有了更深的了解,不妨來實(shí)際操作一番吧!這里是億速云網(wǎng)站,更多相關(guān)內(nèi)容可以進(jìn)入相關(guān)頻道進(jìn)行查詢,關(guān)注我們,繼續(xù)學(xué)習(xí)!
免責(zé)聲明:本站發(fā)布的內(nèi)容(圖片、視頻和文字)以原創(chuàng)、轉(zhuǎn)載和分享為主,文章觀點(diǎn)不代表本網(wǎng)站立場,如果涉及侵權(quán)請聯(lián)系站長郵箱:is@yisu.com進(jìn)行舉報(bào),并提供相關(guān)證據(jù),一經(jīng)查實(shí),將立刻刪除涉嫌侵權(quán)內(nèi)容。