前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
圈层
工具
发布
首页
学习
活动
专区
圈层
工具
社区首页 >专栏 >MybatisPlus自动填充功能

MybatisPlus自动填充功能

作者头像
别团等shy哥发育
发布2023-02-25 16:06:50
发布2023-02-25 16:06:50
1.6K00
代码可运行
举报
运行总次数:0
代码可运行

文章目录

1、实体类@TableField注解添加fill属性

我下面设置的是在插入和更新时自动填充

代码语言:javascript
代码运行次数:0
运行
复制
@TableField(fill = FieldFill.INSERT_UPDATE)

FieldFill是个枚举类,可以设置的值如下所示:

代码语言:javascript
代码运行次数:0
运行
复制
public enum FieldFill {
    /**
     * 默认不处理
     */
    DEFAULT,
    /**
     * 插入填充字段
     */
    INSERT,
    /**
     * 更新填充字段
     */
    UPDATE,
    /**
     * 插入和更新填充字段
     */
    INSERT_UPDATE
}

User.java

代码语言:javascript
代码运行次数:0
运行
复制
package com.baomidou.mybatisplus.beans;

import com.baomidou.mybatisplus.annotation.FieldFill;
import com.baomidou.mybatisplus.annotation.TableField;
import com.baomidou.mybatisplus.annotation.TableLogic;
import com.baomidou.mybatisplus.annotation.TableName;
import lombok.Data;

@Data
@TableName("tbl_user")
public class User {

    private Integer id;
    //插入和更新操作都会进行字段填充
    @TableField(fill = FieldFill.INSERT_UPDATE)
    private String name;

    @TableLogic(value = "1",delval = "-1") //逻辑删除字段
    private Integer logicFlag;
}

2、自定义实现类 MyMetaObjectHandler

我的配置:

代码语言:javascript
代码运行次数:0
运行
复制
package com.baomidou.mybatisplus.metaObjectHandler;

import com.baomidou.mybatisplus.core.handlers.MetaObjectHandler;
import lombok.extern.slf4j.Slf4j;
import org.apache.ibatis.reflection.MetaObject;
import org.springframework.stereotype.Component;

/**
 * 自定义的公共字段填充处理器
 */
@Slf4j
@Component
public class MyMetaObjectHandler implements MetaObjectHandler {
    /**
     * 插入字段 自动填充
     * @param metaObject
     */
    @Override
    public void insertFill(MetaObject metaObject) {
        log.info("start insert fill ....");
        //获取到需要被填充的字段的值
        Object fieldValue=getFieldValByName("name",metaObject);
        if(fieldValue==null){
            System.out.println("=====插入操作满足填充条件=====");
            setFieldValByName("name","weiyunhui",metaObject);
        }
    }

    /**
     * 修改操作 自动填充
     * @param metaObject
     */
    @Override
    public void updateFill(MetaObject metaObject) {
        log.info("start update fill ....");
        Object fieldValue=getFieldValByName("name",metaObject);
        if(fieldValue==null){
            System.out.println("=====更新操作满足填充条件=====");
            setFieldValByName("name","weiyh",metaObject);
        }
    }
}

注意事项:

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

    @Override
    public void insertFill(MetaObject metaObject) {
        log.info("start insert fill ....");
        this.strictInsertFill(metaObject, "createTime", LocalDateTime.class, LocalDateTime.now()); // 起始版本 3.3.0(推荐使用)
        // 或者
        this.strictInsertFill(metaObject, "createTime", () -> LocalDateTime.now(), LocalDateTime.class); // 起始版本 3.3.3(推荐)
        // 或者
        this.fillStrategy(metaObject, "createTime", LocalDateTime.now()); // 也可以使用(3.3.0 该方法有bug)
    }

    @Override
    public void updateFill(MetaObject metaObject) {
        log.info("start update fill ....");
        this.strictUpdateFill(metaObject, "updateTime", LocalDateTime.class, LocalDateTime.now()); // 起始版本 3.3.0(推荐)
        // 或者
        this.strictUpdateFill(metaObject, "updateTime", () -> LocalDateTime.now(), LocalDateTime.class); // 起始版本 3.3.3(推荐)
        // 或者
        this.fillStrategy(metaObject, "updateTime", LocalDateTime.now()); // 也可以使用(3.3.0 该方法有bug)
    }
}

3、测试公共字段填充 插入

代码语言:javascript
代码运行次数:0
运行
复制
  @Test
    public void testMetaObjectHandler(){
        User user=new User();
        user.setLogicFlag(1);

        int result = userMapper.insert(user);
        System.out.println(result);
    }

控制台可以看到,确实对name字段进行了填充

4、测试公共字段填充 修改

代码语言:javascript
代码运行次数:0
运行
复制
   @Test
    public void testMetaObjectHandler1(){
        User user=new User();
//        user.setName("Tom");
        user.setId(7);
        user.setLogicFlag(1);
        int result = userMapper.updateById(user);
        System.out.println(result);
    }

可以看到,更新时也进行了填充。

本文参与 腾讯云自媒体同步曝光计划,分享自作者个人站点/博客。
原始发表:2022-04-13,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 作者个人站点/博客 前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体同步曝光计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • 文章目录
  • 1、实体类@TableField注解添加fill属性
  • 2、自定义实现类 MyMetaObjectHandler
  • 3、测试公共字段填充 插入
  • 4、测试公共字段填充 修改
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档