Mybatis-Plus怎么使用@TableField实现自动填充日期

引言

在开发过程中，我们经常需要在数据库表中记录数据的创建时间和更新时间。手动在每次插入或更新数据时设置这些字段不仅繁琐，而且容易出错。Mybatis-Plus 提供了 @TableField 注解，结合自动填充功能，可以轻松实现这些字段的自动填充。本文将详细介绍如何使用 Mybatis-Plus 的 @TableField 注解实现自动填充日期。

1. Mybatis-Plus 简介

Mybatis-Plus 是 MyBatis 的增强工具，在 MyBatis 的基础上只做增强不做改变，简化开发、提高效率。它提供了许多实用的功能，如自动生成代码、分页插件、性能分析插件等。其中，自动填充功能是一个非常实用的特性，可以帮助我们自动填充某些字段的值，如创建时间、更新时间等。

2. 自动填充功能概述

Mybatis-Plus 的自动填充功能允许我们在插入或更新数据时，自动填充某些字段的值。这些字段的值可以通过自定义的填充策略来生成。常见的应用场景包括：

• 自动填充创建时间（create_time）
• 自动填充更新时间（update_time）
• 自动填充操作人（operator）

3. 使用 @TableField 实现自动填充

3.1 添加 @TableField 注解

首先，我们需要在实体类中为需要自动填充的字段添加 @TableField 注解，并指定 fill 属性。fill 属性用于指定字段的填充策略，常用的策略包括：

• FieldFill.DEFAULT：默认策略，不自动填充
• FieldFill.INSERT：插入时自动填充
• FieldFill.UPDATE：更新时自动填充
• FieldFill.INSERT_UPDATE：插入和更新时自动填充

例如，我们有一个 User 实体类，其中包含 createTime 和 updateTime 两个字段，我们希望在这两个字段上实现自动填充：

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

import java.util.Date;

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

    private Long id;

    private String name;

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

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

3.2 实现 MetaObjectHandler 接口

接下来，我们需要实现 MetaObjectHandler 接口，并在其中定义字段的填充逻辑。MetaObjectHandler 接口有两个方法需要实现：

• insertFill(MetaObject metaObject)：在插入数据时调用
• updateFill(MetaObject metaObject)：在更新数据时调用

我们可以在这些方法中为需要自动填充的字段设置值。例如，我们可以创建一个 MyMetaObjectHandler 类来实现 MetaObjectHandler 接口：

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

import java.util.Date;

@Component
public class MyMetaObjectHandler implements MetaObjectHandler {

    @Override
    public void insertFill(MetaObject metaObject) {
        this.strictInsertFill(metaObject, "createTime", Date.class, new Date());
        this.strictInsertFill(metaObject, "updateTime", Date.class, new Date());
    }

    @Override
    public void updateFill(MetaObject metaObject) {
        this.strictUpdateFill(metaObject, "updateTime", Date.class, new Date());
    }
}

在上面的代码中，我们使用 strictInsertFill 和 strictUpdateFill 方法来设置字段的值。这些方法会检查字段是否已经存在值，如果字段已经有值，则不会覆盖它。

3.3 配置 Mybatis-Plus

最后，我们需要确保 Mybatis-Plus 能够识别我们的 MetaObjectHandler 实现类。通常情况下，Spring Boot 会自动扫描并注册 @Component 注解的类，因此我们不需要额外的配置。

如果你使用的是非 Spring Boot 项目，或者需要手动配置 Mybatis-Plus，可以在配置文件中添加以下配置：

<bean id="myMetaObjectHandler" class="com.example.MyMetaObjectHandler"/>

或者在 Java 配置类中手动注册：

@Bean
public MetaObjectHandler metaObjectHandler() {
    return new MyMetaObjectHandler();
}

4. 测试自动填充功能

完成上述步骤后，我们可以通过插入和更新数据来测试自动填充功能是否正常工作。

4.1 插入数据

当我们插入一条新的 User 记录时，createTime 和 updateTime 字段应该被自动填充为当前时间：

User user = new User();
user.setName("John Doe");
userMapper.insert(user);

执行上述代码后，数据库中的 user 表应该会有一条新记录，createTime 和 updateTime 字段的值均为当前时间。

4.2 更新数据

当我们更新一条 User 记录时，updateTime 字段应该被自动更新为当前时间：

User user = userMapper.selectById(1L);
user.setName("Jane Doe");
userMapper.updateById(user);

执行上述代码后，数据库中的 user 表的 updateTime 字段应该被更新为当前时间，而 createTime 字段保持不变。

5. 注意事项

在使用 @TableField 实现自动填充时，需要注意以下几点：

• 字段类型：自动填充的字段类型必须与填充值的类型一致。例如，如果字段类型为 Date，则填充值也必须是 Date 类型。
• 字段名称：在 MetaObjectHandler 中设置字段值时，字段名称必须与实体类中的字段名称一致。
• 字段值覆盖：如果字段已经有值，strictInsertFill 和 strictUpdateFill 方法不会覆盖它。如果需要强制覆盖，可以使用 setFieldValByName 方法。

6. 总结

通过 Mybatis-Plus 的 @TableField 注解和 MetaObjectHandler 接口，我们可以轻松实现字段的自动填充功能。这不仅简化了代码，还减少了出错的可能性。在实际开发中，自动填充功能可以广泛应用于创建时间、更新时间、操作人等字段的自动管理。

希望本文能帮助你更好地理解和使用 Mybatis-Plus 的自动填充功能。如果你有任何问题或建议，欢迎在评论区留言讨论。

7. 参考文档

• Mybatis-Plus 官方文档
• Mybatis-Plus GitHub 仓库

作者: [Your Name]
日期: [2023-10-01]
版权: 本文采用 CC BY-NC-SA 4.0 协议进行许可。