使用Mybatis-Plus實現(xiàn)對象屬性自動填充功能
案例場景:在設(shè)計一張數(shù)據(jù)庫表的時候,通常會包含下列信息:createBy(創(chuàng)建人)、createTime(創(chuàng)建時間)、updateBy(修改人)、updateTime(修改時間)、otherinfo(其它屬性信息)。
在一般的業(yè)務(wù)邏輯編寫過程中,絕大多數(shù)的開發(fā)工程師都選擇根據(jù)操作類型(insert/update)來依次調(diào)用對應(yīng)的setXXX方法來設(shè)置值。使用setXXX并不是不能達到預(yù)期,只是代碼實現(xiàn)起來不叫臃腫,而這些字段幾乎是通用的字段,是否有統(tǒng)一的方式進行設(shè)置呢?
下面以實例的方式告訴大家,如何基于Mybatis-Plus實現(xiàn)固定列自動填充,讓你的工作效率提升。
1、引用Mybatis-plus
<dependencies> <dependency> <groupId>com.baomidou</groupId> <artifactId>mybatis-plus-boot-starter</artifactId> <version>3.0.6</version> </dependency> <dependency> <groupId>com.h2database</groupId> <artifactId>h2</artifactId> <scope>runtime</scope> </dependency> </dependencies>
2、自定義自己的原對象屬性填充器,自定義類實現(xiàn)MetaObjectHandler,代碼如下:
/** * Copyright ? 2019 DBRG. All rights reserved. * * @Title: DbrgMetaObjectHandler.java * @Prject: syswms * @Package: com.dbrg.project.handler * @version: V1.0 */ package com.dbrg.project.handler; import org.apache.ibatis.reflection.MetaObject; import org.springframework.stereotype.Component; import com.baomidou.mybatisplus.core.handlers.MetaObjectHandler; import com.dbrg.common.utils.DateUtils; import com.dbrg.common.utils.security.ShiroUtils; /** * @ClassName: DbrgMetaObjectHandler * @Description:元對象自動填充處理器 * @author: yelangking * @date: 2019年3月4日 上午9:14:18 */ @Component public class DbrgMetaObjectHandler implements MetaObjectHandler{ private static final String CREATE_BY_FIELD_NAME = "createBy"; private static final String CREATE_TIME_FIELD_NAME = "createTime"; private static final String UPDATE_BY_FIELD_NAME = "updateBy"; private static final String UPDATE_TIME_FIELD_NAME = "updateTime"; /* (non Javadoc) * @Title: insertFill * @Description: {簡單描述} * @param arg0 * @see com.baomidou.mybatisplus.core.handlers.MetaObjectHandler#insertFill(org.apache.ibatis.reflection.MetaObject) */ @Override public void insertFill(MetaObject metaObject) { //1、自動設(shè)置創(chuàng)建人信息,當外部接口調(diào)用時,用戶可能為空 if(null != ShiroUtils.getSysUser()){ this.setFieldValByName(CREATE_BY_FIELD_NAME,ShiroUtils.getUserId(),metaObject); } //2、自動設(shè)置創(chuàng)建時間 this.setFieldValByName(CREATE_TIME_FIELD_NAME, DateUtils.getNowDate(), metaObject); //3、自動設(shè)置更新人信息,當外部接口調(diào)用時,用戶可能為空 if(null != ShiroUtils.getSysUser()){ this.setFieldValByName(UPDATE_BY_FIELD_NAME,ShiroUtils.getUserId(),metaObject); } //4、自動設(shè)置更新時間 this.setFieldValByName(UPDATE_TIME_FIELD_NAME, DateUtils.getNowDate(), metaObject); } /* (non Javadoc) * @Title: updateFill * @Description: {簡單描述} * @param arg0 * @see com.baomidou.mybatisplus.core.handlers.MetaObjectHandler#updateFill(org.apache.ibatis.reflection.MetaObject) */ @Override public void updateFill(MetaObject metaObject) { //1、自動設(shè)置更新人信息,當外部接口調(diào)用時,用戶可能為空 if(null != ShiroUtils.getSysUser()){ this.setFieldValByName(UPDATE_BY_FIELD_NAME,ShiroUtils.getUserId(),metaObject); } //2、自動設(shè)置更新時間 this.setFieldValByName(UPDATE_TIME_FIELD_NAME, DateUtils.getNowDate(), metaObject); } }
以上代碼實現(xiàn)了自定義的設(shè)置入口,分別定義了在insert和update時設(shè)置哪些屬性的值,程序?qū)嶋H運行時會根據(jù)不同的操作類型設(shè)置相應(yīng)的值。
3、在實體類上注入設(shè)置填充規(guī)則,代碼如下:
/** * Copyright ? 2019 DBRG. All rights reserved. * * @Title: MpBaseEntity.java * @Prject: syswms * @Package: com.dbrg.framework.web.domain * @version: V1.0 */ package com.dbrg.framework.web.domain; import java.io.Serializable; import java.util.Date; import com.baomidou.mybatisplus.annotation.FieldFill; import com.baomidou.mybatisplus.annotation.TableField; import com.fasterxml.jackson.annotation.JsonFormat; import lombok.AllArgsConstructor; import lombok.Getter; import lombok.NoArgsConstructor; import lombok.Setter; /** * @ClassName: MpBaseEntity * @Description:mybatis plus 自動注入基類,結(jié)合FieledFill策略類一起使用, * 默認包含創(chuàng)建人、創(chuàng)建時間、更新人、更新時間信息,業(yè)務(wù)表單中包含此字段的集成本類即可。如無明確要求,可不做任何處理。 * @author: yelangking * @date: 2019年3月4日 上午9:03:12 */ @Setter @Getter @NoArgsConstructor @AllArgsConstructor public class MpBaseEntity implements Serializable{ private static final long serialVersionUID = 2234596156219712753L; /** * 創(chuàng)建人 */ @TableField(value="create_by",fill=FieldFill.INSERT) private Long createBy; /** 創(chuàng)建時間 */ @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss") @TableField(value="create_time",fill=FieldFill.INSERT) private Date createTime; /** * 更新人 */ @TableField(value="update_by",fill=FieldFill.INSERT_UPDATE) private Long updateBy; /** * 更新時間 */ @TableField(value="update_time",fill=FieldFill.INSERT_UPDATE) @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss") private Date updateTime; }
關(guān)鍵代碼:
@TableField(value="update_time",fill=FieldFill.INSERT_UPDATE),在對象的屬性上設(shè)置填充規(guī)則即可。
4、運行效果,參考官網(wǎng)運行結(jié)果。
c.b.samples.metainfo.AutoFillTest : Started AutoFillTest in 9.239 seconds (JVM running for 17.064) c.b.s.m.handler.MyMetaObjectHandler: start insert fill .... c.b.s.metainfo.mapper.UserMapper.insert: ==> Preparing: INSERT INTO user ( ID, NAME, AGE, EMAIL, OPERATOR ) VALUES ( ?, ?, ?, ?, ? ) c.b.s.metainfo.mapper.UserMapper.insert: ==> Parameters: 1381223322590720001(Long), Tom(String), 1(Integer), tom@qq.com(String), Jetty(String) c.b.s.metainfo.mapper.UserMapper.insert: <== Updates: 1 c.b.s.m.mapper.UserMapper.selectById: ==> Preparing: SELECT ID,NAME,AGE,EMAIL,OPERATOR FROM user WHERE ID=? c.b.s.m.mapper.UserMapper.selectById: ==> Parameters: 1381223322590720001(Long) c.b.s.m.mapper.UserMapper.selectById: <== Total: 1 c.b.samples.metainfo.AutoFillTest: query user:User(id=1381223322590720001, name=Tom, age=1, email=tom@qq.com, operator=Jetty) c.b.s.m.mapper.UserMapper.selectById: ==> Preparing: SELECT ID,NAME,AGE,EMAIL,OPERATOR FROM user WHERE ID=? c.b.s.m.mapper.UserMapper.selectById: ==> Parameters: 1(Long) c.b.s.m.mapper.UserMapper.selectById: <== Total: 1 c.b.samples.metainfo.AutoFillTest: before user:User(id=1, name=Jone, age=18, email=test1@baomidou.com, operator=test) c.b.s.m.handler.MyMetaObjectHandler : start update fill .... c.b.s.m.mapper.UserMapper.updateById: ==> Preparing: UPDATE user SET NAME=?, AGE=?, EMAIL=?, OPERATOR=? WHERE ID=? c.b.s.m.mapper.UserMapper.updateById: ==> Parameters: Jone(String), 12(Integer), test1@baomidou.com(String), test(String), 1(Long) c.b.s.m.mapper.UserMapper.updateById: <== Updates: 1
5、綜上所述,使用mybatis-plus可以方便快速的進行屬性自動填充,最大量的減輕大家的工作量,在你的項目中大膽采用吧,提升開發(fā)效率。歡迎添加公眾號交流。
以上就是使用Mybatis-Plus實現(xiàn)對象屬性自動填充功能的詳細內(nèi)容,更多關(guān)于Mybatis-Plus對象屬性自動填充的資料請關(guān)注腳本之家其它相關(guān)文章!
相關(guān)文章
詳解Spring數(shù)據(jù)緩存注解@Cacheable、@CachePut、@CacheEvict
這篇文章主要介紹了詳解Spring數(shù)據(jù)緩存注解@Cacheable、CachePut、@CacheEvict,當以一組參數(shù)第一次調(diào)用某個方法時,返回值會被保存在緩存中,如果這個方法再次以相同的參數(shù)進行調(diào)用時,這個返回值會從緩存中查詢獲取,需要的朋友可以參考下2023-07-07Spring模塊詳解之Spring ORM和Spring Transaction詳解
Spring ORM 是 Spring 框架的模塊之一,旨在簡化與 JPA、Hibernate、JDO 等 ORM 工具的集成,通過提供統(tǒng)一的 API 和模板類,如 HibernateTemplate 和 JpaTemplate,Spring ORM 使開發(fā)者可以更便捷地執(zhí)行數(shù)據(jù)庫操作,感興趣的朋友跟隨小編一起看看吧2024-09-09深扒Java中POJO、VO、DO、DTO、PO、BO、AO、DAO的概念和區(qū)別以及如何應(yīng)用
po vo bo dto dao 和 pojo 是軟件開發(fā)中經(jīng)常使用的一些概念,用于設(shè)計和實現(xiàn)對象模型,下面將分別解釋這些概念的含義及其在開發(fā)中的應(yīng)用,這篇文章主要給大家介紹了關(guān)于Java中POJO、VO、DO、DTO、PO、BO、AO、DAO的概念和區(qū)別以及如何應(yīng)用的相關(guān)資料,需要的朋友可以參考下2024-08-08Java線程狀態(tài)及切換、關(guān)閉線程的正確姿勢分享
這篇文章主要給大家介紹了關(guān)于Java線程狀態(tài)及切換、關(guān)閉線程的正確姿勢,文中通過示例代碼介紹的非常詳細,對大家的學習或者使用Java具有一定的參考學習價值,需要的朋友們下面來一起學習學習吧2019-10-10