MyBatis-Plus的自动填充功能

最新推荐文章于 2024-09-23 08:42:05 发布

Y7000也拯救不了我

最新推荐文章于 2024-09-23 08:42:05 发布

阅读量662

点赞数 2

分类专栏： MyBatis-Plus 文章标签： java mybatis spring

本文链接：https://blog.csdn.net/m0_44966138/article/details/119063806

版权

MyBatis-Plus 专栏收录该内容

1 篇文章 0 订阅

订阅专栏

本文详细介绍了如何使用MyBatisPlus的自动填充功能，以简化数据库操作，如记录创建时间和更新时间的设置。主要步骤包括：在数据库中新增字段，修改实体类添加注解，实现MetaObjectHandler接口并重写填充方法，以及测试验证。注意填充策略和注解的使用，确保字段正确入库。

摘要由CSDN通过智能技术生成

自动填充功能的简单实现

需求描述：

项目中经常会遇到一些数据，每次都使用相同的方式填充，例如记录的创建时间，更新时间等。

我们可以使用MyBatis Plus的自动填充功能，完成这些字段的赋值工作

1、数据库修改

在User表中添加datetime类型的新的字段 create_time、update_time

2、实体类修改

实体上增加字段并添加自动填充注解

package com.mfc.mybatis_plus.entity;

import com.baomidou.mybatisplus.annotation.FieldFill;
import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.annotation.TableField;
import com.baomidou.mybatisplus.annotation.TableId;
import lombok.*;

import java.util.Date;

@Builder
@Getter
@Setter
public class User {

    private Long id;
    private String name;
    private Integer age;
    private String email;

    @TableField(fill = FieldFill.INSERT)
    private Date createTime;

    @TableField(fill = FieldFill.INSERT_UPDATE)
    private Date updateTime;
}

@TableField 字段注解，该注解用于标识非主键的字段。将数据库列与 JavaBean 中的属性进行映射。

fill字段自动填充策略，默认为 FieldFill.DEFAULT。

FieldFill.INSERT插入填充字段
FieldFill.INSERT_UPDATE 插入和更新填充字段

3、实现元对象处理器接口

实现MetaObjectHandler接口，重写insertFill和updateFill方法

注意：不要忘记添加 @Component 注解

package com.mfc.mybatisplus.handler;
@Slf4j
@Component
public class MyMetaObjectHandler implements MetaObjectHandler {
    @Override
    public void insertFill(MetaObject metaObject) {
        log.info("start insert fill ....");
        this.setFieldValByName("createTime", new Date(), metaObject);
        this.setFieldValByName("updateTime", new Date(), metaObject);
    }
    @Override
    public void updateFill(MetaObject metaObject) {
        log.info("start update fill ....");
        this.setFieldValByName("updateTime", new Date(), metaObject);
    }
}

MetaObject数据对象，指的是当前实体类

setFieldValByName方法通过实体类的属性设置属性值。

4、测试

    @Test
    void test01(){
        User user = User.builder()
                .name("张三1")
                .age(18)
                .email("236070@com")
                .build();

        int i = userMapper.insert(user);
        // 受影响的行数
        System.out.println("影响行数："+i);
        System.out.println("user id:"+user.getId());

    }

插入时调用了MyMetaObjectHandler的insertFill方法
[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-ldimdbdb-1627131473736)(images/image-20210724204952772.png)]
插入的数据在这里插入图片描述

5、注意事项

官网地址

填充原理是直接给entity的属性设置值!!!
注解则是指定该属性在对应情况下必有值,如果无值则入库会是null
MetaObjectHandler提供的默认方法的策略均为:如果属性有值则不覆盖,如果填充值为null则不填充
字段必须声明TableField注解,属性fill选择对应策略,该声明告知Mybatis-Plus需要预留注入SQL字段
填充处理器MyMetaObjectHandler在 Spring Boot 中需要声明@Component或@Bean注入
要想根据注解FieldFill.xxx和字段名以及字段类型来区分必须使用父类的strictInsertFill或者strictUpdateFill方法
不需要根据任何来区分可以使用父类的fillStrategy方法