深入了解：MyBatisPlus中使用 @TableField完成字段自动填充

r囧r小猫 2024-02-25 00:58 70阅读 0赞

**目录**

引言

@TableField注解简介

使用方法

1. 在实体类中添加字段

2. 配置字段填充处理器

3. 配置MyBatisPlus的自动填充

4. 测试自动填充功能

总结

--------------------

### 引言 ###

MyBatisPlus是一款强大的Java持久层框架，它在MyBatis的基础上进行了功能扩展和优化。其中，自动填充字段是一个常见的需求，可以通过使用MyBatisPlus的注解@TableField来实现。本文将介绍如何使用@TableField注解完成字段自动填充的功能。

### @TableField注解简介 ###

@TableField注解是MyBatisPlus提供的用于实体类字段的注解，用于配置字段的属性和行为。其中，我们可以通过设置fill属性来实现字段自动填充的功能。

### 使用方法 ###

下面是使用@TableField注解完成字段自动填充的步骤：

#### 1. 在实体类中添加字段 ####

首先，在实体类中添加需要自动填充的字段。例如，我们在User实体类中添加createTime和updateTime字段，用于记录创建时间和更新时间。

javaCopy codepublic class User {
        private Long id;
        private String name;
        @TableField(fill = FieldFill.INSERT)
        private Date createTime;
        @TableField(fill = FieldFill.INSERT_UPDATE)
        private Date updateTime;
        // 省略getter和setter方法
    }

#### 2. 配置字段填充处理器 ####

接下来，我们需要配置字段填充的处理器。在MyBatisPlus中，我们可以通过实现MetaObjectHandler接口来自定义填充处理器。

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

在上述代码中，我们实现了insertFill和updateFill两个方法，分别用于在插入和更新操作时自动填充字段的值。

#### 3. 配置MyBatisPlus的自动填充 ####

最后，我们需要在MyBatisPlus的配置文件中进行配置，以启用自动填充功能。

javaCopy code@Configuration
    public class MyBatisPlusConfig {
        @Autowired
        private MyMetaObjectHandler myMetaObjectHandler;
        @Bean
        public MybatisPlusInterceptor mybatisPlusInterceptor() {
            MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
            interceptor.addInnerInterceptor(new MetaObjectHandlerInterceptor(myMetaObjectHandler));
            return interceptor;
        }
    }

在上述代码中，我们将自定义的填充处理器MyMetaObjectHandler添加到MybatisPlusInterceptor中，并将其作为一个内部拦截器。

#### 4. 测试自动填充功能 ####

现在，我们可以进行测试，看看自动填充功能是否生效。

javaCopy codeUser user = new User();
    user.setName("John");
    userService.save(user);

在上述代码中，我们创建了一个User对象，并设置了name属性的值为"John"。当调用userService的save方法保存对象时，createTime和updateTime字段将会被自动填充为当前的时间。

以下是一个示例代码，演示了如何使用@TableField注解完成字段自动填充的功能：

javaCopy code// User.java
    public class User {
        private Long id;
        private String name;
        @TableField(fill = FieldFill.INSERT)
        private Date createTime;
        @TableField(fill = FieldFill.INSERT_UPDATE)
        private Date updateTime;
        // 省略getter和setter方法
    }
    // MyMetaObjectHandler.java
    @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());
        }
    }
    // MyBatisPlusConfig.java
    @Configuration
    public class MyBatisPlusConfig {
        @Autowired
        private MyMetaObjectHandler myMetaObjectHandler;
        @Bean
        public MybatisPlusInterceptor mybatisPlusInterceptor() {
            MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
            interceptor.addInnerInterceptor(new MetaObjectHandlerInterceptor(myMetaObjectHandler));
            return interceptor;
        }
    }
    // UserService.java
    @Service
    public class UserService {
        @Autowired
        private UserMapper userMapper;
        
        public void save(User user) {
            userMapper.insert(user);
        }
    }
    // UserController.java
    @RestController
    public class UserController {
        @Autowired
        private UserService userService;
        
        @PostMapping("/users")
        public void createUser(@RequestBody User user) {
            userService.save(user);
        }
    }

在上述示例代码中，我们定义了一个User实体类，其中包含了需要自动填充的createTime和updateTime字段。我们使用@TableField注解来标记这两个字段，通过设置fill属性为FieldFill.INSERT和FieldFill.INSERT\_UPDATE来指定字段自动填充的时机。 我们还定义了一个MyMetaObjectHandler类，实现了MetaObjectHandler接口，并重写了insertFill和updateFill方法来实现具体的字段填充逻辑。 在MyBatisPlusConfig类中，我们将自定义的填充处理器MyMetaObjectHandler添加到MybatisPlusInterceptor中，并作为一个内部拦截器。 最后，在UserController中，我们通过调用userService的save方法来保存用户对象。当保存操作触发时，createTime和updateTime字段将会被自动填充为当前的时间。 请根据实际需求，修改代码中的参数和逻辑以适应你的项目。

一个实际的应用场景是，在用户注册时，自动为用户生成一个唯一的邀请码，并将邀请码存储到用户表中。以下是一个示例代码：

javaCopy code// User.java
    public class User {
        private Long id;
        private String name;
        @TableField(fill = FieldFill.INSERT)
        private Date createTime;
        @TableField(fill = FieldFill.INSERT_UPDATE)
        private Date updateTime;
        @TableField(fill = FieldFill.INSERT)
        private String inviteCode;
        // 省略getter和setter方法
    }
    // MyMetaObjectHandler.java
    @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());
            this.strictInsertFill(metaObject, "inviteCode", String.class, generateInviteCode());
        }
        
        @Override
        public void updateFill(MetaObject metaObject) {
            this.strictUpdateFill(metaObject, "updateTime", Date.class, new Date());
        }
        
        private String generateInviteCode() {
            // 生成唯一的邀请码逻辑
            // 可以使用UUID、随机字符串等方式生成唯一的邀请码
            // 这里只是一个示例，实际应用中需要根据具体需求进行处理
            return UUID.randomUUID().toString().replace("-", "");
        }
    }
    // MyBatisPlusConfig.java
    @Configuration
    public class MyBatisPlusConfig {
        @Autowired
        private MyMetaObjectHandler myMetaObjectHandler;
        
        @Bean
        public MybatisPlusInterceptor mybatisPlusInterceptor() {
            MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
            interceptor.addInnerInterceptor(new MetaObjectHandlerInterceptor(myMetaObjectHandler));
            return interceptor;
        }
    }
    // UserService.java
    @Service
    public class UserService {
        @Autowired
        private UserMapper userMapper;
        
        public void save(User user) {
            userMapper.insert(user);
        }
    }
    // UserController.java
    @RestController
    public class UserController {
        @Autowired
        private UserService userService;
        
        @PostMapping("/users")
        public void createUser(@RequestBody User user) {
            userService.save(user);
        }
    }

在上述示例代码中，我们新增了一个inviteCode字段，并使用@TableField注解将其标记为需要自动填充的字段。在MyMetaObjectHandler类的insertFill方法中，我们通过调用generateInviteCode方法生成一个唯一的邀请码，并将其填充到inviteCode字段中。generateInviteCode方法中使用UUID来生成一个唯一的字符串作为邀请码，然后去掉其中的"-"字符。 当用户注册时，会调用UserController中的createUser方法，该方法会调用userService的save方法保存用户对象。在保存操作触发时，createTime、updateTime和inviteCode字段将会被自动填充。inviteCode字段的值将会是一个唯一的邀请码。 请根据你的实际需求，修改代码中的参数和逻辑以适应你的项目。

### 总结 ###

通过使用@TableField注解和自定义的MetaObjectHandler填充处理器，我们可以很方便地实现字段的自动填充功能。在MyBatisPlus中，这个功能可以简化我们的开发工作，提高代码的可维护性和可读性。希望本文对大家在使用MyBatisPlus进行开发时有所帮助！