广告
返回顶部
首页 > 资讯 > 后端开发 > Python >MyBatis-Plus实现字段自动填充功能的示例
  • 340
分享到

MyBatis-Plus实现字段自动填充功能的示例

2024-04-02 19:04:59 340人浏览 薄情痞子

Python 官方文档:入门教程 => 点击学习

摘要

目录一、前言二、实现1. 实体类2. 公用字段 - 使用注解填充字段3. 自定义MyMetaObjectHandler字段自动填充处理类继承MetaObjectHandler一、前言

一、前言

项目中,我们有一些公共的字段需要做修改

如:

  • gmt_create:创建时间
  • creator_id:创建人
  • gmt_modified:修改时间
  • modifier_id:修改人

这时候我们可以采用 mybatis-Plus 中的字段自动填充功能去实现

思路:抽取公用字段封装到BaseEntity类中,再将使用到此公共字段的类继承基类,最后由 MyBatis-Plus 帮我们实现自动填充,这样我们便可以在service服务类中减少一定代码重复量!

二、实现

1. 实体类


@Data
@TableName("t_user")
public class User extends BaseEntity<User> {

    private static final long serialVersionUID = 1L;

    @TableId(value = "id", type = IdType.AUTO)
    private Integer id;
 
    @TableField("username")
    private String username;
    
    @Override
    protected Serializable pkVal() {
        return this.id;
    }
}

2. 公用字段 - 使用注解填充字段

如:@TableField(fill = FieldFill.INSERT)


@Getter
@Setter
public abstract class BaseEntity<T extends Model> extends Model {
    
    @TableField(value = "gmt_create", fill = FieldFill.INSERT)
    private Date gmtCreate;
	
    @TableField(value = "gmt_modified", fill = FieldFill.INSERT_UPDATE)
    private Date gmtModified;
}

Ctrl 选中FieldFill进入源码可查看相应字段填充策略枚举类,如下:


public enum FieldFill {
    DEFAULT(0, "默认不处理"),
    INSERT(1, "插入填充字段"),
    UPDATE(2, "更新填充字段"),
    INSERT_UPDATE(3, "插入和更新填充字段");
    
    private final int key;
    
    private final String desc;
    FieldFill(final int key, final String desc) {
        this.key = key;
        this.desc = desc;
    }
    public static FieldFill getIgnore(int key) {
        FieldFill[] fis = FieldFill.values();
        for (FieldFill fi : fis) {
            if (fi.geTKEy() == key) {
                return fi;
            }
        }
        return FieldFill.DEFAULT;
    }
    public int getKey() {
        return this.key;
    }
    public String getDesc() {
        return this.desc;
    }
}

3. 自定义MyMetaObjectHandler字段自动填充处理类继承MetaObjectHandler

注:在 Spring Boot 中需要声明@Component 注入



@Component
public class MyMetaObjectHandler extends MetaObjectHandler {

    private static final Logger LOG = LoggerFactory.getLogger(MyMetaObjectHandler.class);

    
    @Override
    public void insertFill(MetaObject metaObject) {
        LOG.info(" -------------------- start insert fill ...  --------------------");
        if (metaObject.hasGetter("gmtCreate") && metaObject.hasGetter("gmtModified")) {
            setFieldValByName("gmtCreate", new Date(), metaObject);
            setFieldValByName("gmtModified", new Date(), metaObject);
        }
    }

    
    @Override
    public void updateFill(MetaObject metaObject) {
        LOG.info(" -------------------- start update fill ...  --------------------");
        if (metaObject.hasGetter("et.gmtModified")) {
            setFieldValByName("gmtModified", new Date(), metaObject);
        }
    }
    
}

温馨小提示:

我们在更新字段的时候要使用 et.字段名 或者 param1.字段 才会生效!

原因:我们可以debug模式查看metaObject中的属性发现多了et

在这里插入图片描述

或者 查看继承的BaseMapper类源码,我们也可以发现更新的方法中都有et

在这里插入图片描述

而插入的方法并没有et

在这里插入图片描述

另外一个注意点就是,自动填充是在执行完插入或更新方法之后,也就是说,MyBatis-Plus会在方法之后判断@TableField注解的字段有没有被手动更新,如果没有才会走自定义的实现类MyMetaObjectHandler

到此这篇关于MyBatis-Plus实现字段自动填充功能的示例的文章就介绍到这了,更多相关MyBatis-Plus 字段自动填充内容请搜索编程网以前的文章或继续浏览下面的相关文章希望大家以后多多支持编程网!

--结束END--

本文标题: MyBatis-Plus实现字段自动填充功能的示例

本文链接: https://www.lsjlt.com/news/156813.html(转载时请注明来源链接)

有问题或投稿请发送至: 邮箱/279061341@qq.com    QQ/279061341

本篇文章演示代码以及资料文档资料下载

下载Word文档到电脑,方便收藏和打印~

下载Word文档
猜你喜欢
软考高级职称资格查询
编程网,编程工程师的家园,是目前国内优秀的开源技术社区之一,形成了由开源软件库、代码分享、资讯、协作翻译、讨论区和博客等几大频道内容,为IT开发者提供了一个发现、使用、并交流开源技术的平台。
  • 官方手机版

  • 微信公众号

  • 商务合作