MyBatis-Plus——自动填充功能实现

MyBatis-Plus——自动填充功能

1、什么是自动填充

有些表中会有更新时间update_time、创建时间create_time、更新人或者创建人这些字段。

每次对数据进行新增、删除、修改时都需要对这些字段进行设置。传统的做法是在进行这些操作前，对实体的字段进行set设置，然后再进行操作。这种做法不仅容易忘记导致出错、而且代码会显得特别冗余。

虽然新增时间和修改时间可以使用数据库的时间，但是新增人和修改人就不能使用这样的功能。

所以 MyBatis-Plus 就提供自动填充的功能，帮助自定设置这些字段的值，提升开发效率，代码也会显得特别优雅。

自动填充有两种实现方式，一种数据库层面实现，一种编程实现

2、数据库层面实现

表结构如下：设置默认值 CURRENT_TIMESTAMP，并把修改时间设为自动更新。

实体类：

@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
    private Long id;
    private String name;
    private Integer age;
    private String email;
    private Date createTime;
    private Date updateTime;
}

插入一条数据：

@Test
void insertTest(){
    User user = new User();
    user.setAge(20);
    user.setName("shuhaoming");
    user.setEmail("[email protected]");
    int insert = userMapper.insert(user);
    System.out.println(insert);
}

修改刚刚插入的数据：

@Test
void update(){
    User user = new User();
    user.setId(1474275229328146434L);
    user.setName("shuhaoming123");
    //根据id修改用户，但是参数是一个对象
    userMapper.updateById(user);
}

这个日期更新操作都是MyBatis-Plus自动帮我们做的。

3、编程实现（推荐）

表结构如下：

实体类：

@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
    @TableId(type = IdType.AUTO) //主键生成策略：自增
    private Long id;
    private String name;
    private Integer age;
    private String email;
    private Date createTime;
    private Date updateTime;
}

在实体类字段上添加注解

@TableField(fill = FieldFill.INSERT) //插入时填充字段
private Date createTime;
@TableField(fill = FieldFill.INSERT_UPDATE)//插入和修改时填充字段
private Date updateTime;

编写处理器处理注解：

@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);
    }
}

测试：先插入一条数据

@Test
void insertTest(){
    User user = new User();
    user.setAge(20);
    user.setName("shuhaoming");
    user.setEmail("[email protected]");
    userMapper.insert(user);
}

此时创建时间和修改时间相同：

再进行修改：

@Test
void update(){
    User user = new User();
    user.setId(11L);
    user.setName("shuhaoming123");
    userMapper.updateById(user);
}

修改时间发生变化：

注意事项：

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