MyBatis-Plus 自动赋值实体字段-CSDN博客

本文链接：https://blog.csdn.net/sjdgehi/article/details/149565654

MyBatis-Plus 自动赋值实体字段：深度解析与应用

1. MyBatis-Plus 自动赋值概述

MyBatis-Plus（简称 MP）是 MyBatis 的增强工具包，提供了很多便利的功能，其中 自动赋值实体字段 是开发中非常常见的需求。本文将深入探讨 MyBatis-Plus 的自动赋值机制，并通过详细的 Java 代码和表格进行对比和解释，帮助大家更好地掌握这个功能。

1. MyBatis-Plus 自动赋值概述

MyBatis-Plus 提供了一种便捷的方式来自动填充实体对象中的字段，尤其是在处理一些常见的数据库操作时（如创建时间、更新时间等）。在进行数据插入、更新操作时，常常需要对某些字段进行自动填充，减少手动赋值的工作量，提升开发效率。

1.1 适用场景

时间戳自动填充：如 createTime, updateTime 等字段通常需要在插入或更新时自动填充为当前时间。
用户信息填充：如 createBy, updateBy 等字段通常需要在操作时自动填充当前操作用户。
逻辑删除标识：如 isDeleted 字段，插入时自动填充 0，更新时填充 1 表示删除。

1.2 自动填充的原理

MyBatis-Plus 的自动赋值字段主要通过 @TableField 注解与填充策略来实现。它通过配置特定的填充规则，使得在执行插入、更新操作时，某些字段能够自动填充。

1.3 填充策略

MyBatis-Plus 提供了四种常见的填充策略：

FieldFill.INSERT：在插入时填充
FieldFill.UPDATE：在更新时填充
FieldFill.INSERT_UPDATE：在插入和更新时都填充
FieldFill.DEFAULT：不指定填充策略，使用默认填充规则

2. 关键注解与配置

MyBatis-Plus 提供了两个关键注解用于自动赋值字段的配置：@TableField 和 @TableId。

2.1 `@TableField` 注解

@TableField 注解用于标识实体类中的字段，配合 fill 属性来定义自动填充的行为。通过 fill 属性，我们可以为字段指定填充策略。

示例：

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

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

createTime 字段在插入时自动填充。
updateTime 字段在插入和更新时自动填充。

2.2 `@TableId` 注解

@TableId 注解用于指定实体类中的主键字段。在某些情况下，我们也可能需要对主键字段进行自动赋值。通常来说，MyBatis-Plus 会自动处理主键生成策略（如自增、UUID 等）。

示例：

@TableId(type = IdType.AUTO)
private Long id;

该配置表示主键 id 使用数据库自增。

2.3 配置填充策略

为了实现自动赋值，我们需要配置填充策略。填充策略可以在 Mapper 层通过实现 MetaObjectHandler 接口来指定。

@Component
public class MyMetaObjectHandler implements MetaObjectHandler {
    
    @Override
    public void insertFill(MetaObject metaObject) {
        this.strictInsertFill(metaObject, "createTime", Date.class, new Date()); // 插入时填充 createTime
        this.strictInsertFill(metaObject, "createBy", String.class, "admin");   // 插入时填充 createBy
    }

    @Override
    public void updateFill(MetaObject metaObject) {
        this.strictUpdateFill(metaObject, "updateTime", Date.class, new Date()); // 更新时填充 updateTime
        this.strictUpdateFill(metaObject, "updateBy", String.class, "admin");   // 更新时填充 updateBy
    }
}

MetaObjectHandler 是 MyBatis-Plus 提供的接口，用于处理自动填充的逻辑。通过实现该接口，我们可以在插入和更新时自定义字段的自动填充行为。

3. 使用实例与代码解析

3.1 实体类示例

假设我们有一个 User 实体类，包含 id, username, createTime, updateTime 等字段，并希望在进行插入和更新时自动填充时间戳。

@Data
public class User {
    @TableId(type = IdType.AUTO)
    private Long id;

    private String username;

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

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

3.2 Mapper 示例

在 Mapper 接口中，我们可以直接使用 MyBatis-Plus 提供的 updateById, insert 等方法。

@Mapper
public interface UserMapper extends BaseMapper<User> {
    // 自定义的数据库操作方法
}

3.3 自动赋值操作示例

@Service
public class UserService {

    @Autowired
    private UserMapper userMapper;

    public void addUser(User user) {
        // 自动填充的字段会被 MyBatis-Plus 处理
        userMapper.insert(user);
    }

    public void updateUser(User user) {
        // 自动填充的字段会被 MyBatis-Plus 处理
        userMapper.updateById(user);
    }
}

在上述示例中，createTime 和 updateTime 会在插入和更新时自动填充。

4. 表格对比：不同填充策略行为

字段类型	`FieldFill.INSERT`	`FieldFill.UPDATE`	`FieldFill.INSERT_UPDATE`	`FieldFill.DEFAULT`
`createTime`	仅在插入时填充	不会填充	会在插入和更新时填充	根据默认策略，通常是 `INSERT`
`updateTime`	不会填充	仅在更新时填充	会在插入和更新时填充	根据默认策略，通常是 `INSERT`

通过表格，我们可以看到不同填充策略的行为区别。开发者可以根据业务需求来选择合适的填充策略。

5. 总结与最佳实践

5.1 自动赋值的优势

减少重复代码：自动填充时间戳和用户信息等常见字段，避免手动赋值。
提高代码可读性：通过注解和配置清晰表达字段填充逻辑，简化代码。
保证数据一致性：自动填充保证了字段值的一致性，减少人为错误。

5.2 常见问题与解决方案

填充不生效：请确保已正确配置 MetaObjectHandler，并且 @TableField(fill = FieldFill.xxx) 注解已加在正确的字段上。
更新时覆盖：修改配置类MyMetaObjectHandler
strictUpdateFill(): 保留更新实体对象的原有值，只在字段为空时才会进行填充。
setFieldValByName(): 会强制覆盖实体对象字段的原有值，不论字段是否为空。
主键策略问题：在使用 @TableId 注解时，需要明确指定主键生成策略（如 IdType.AUTO）。