MyBatis-Plus 自动赋值实体字段最佳实践指南_Java

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）。