mybatis 对 createTime 和 updateTime 实现自动填充

提示:jdk是17,数据库是mysql。


前言

java 中在对数据进行建模时,如果存在 createTime 和 updateTime 字段,在执行保存和修改 sql 时,如果用类似拦截器的工具去在执行 insert 和 update 时填充这两个字段,就会很方便。


提示:以下是本篇文章正文内容,下面案例可供参考

一、依赖

为了方便大家抄作业,我直接将所需依赖都方这里,需要注意的是我用的是 jdk17,如果大家jdk 还是 8 或者 11,需要自行去降级 mybatis 以及其他所需依赖的版本哈。

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>3.1.3</version>
        <relativePath/>
    </parent>

    <groupId>com.demo</groupId>
    <artifactId>demo1</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>demo1</name>
    <description>demo1</description>


    <properties>
        <java.version>17</java.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-devtools</artifactId>
            <scope>runtime</scope>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>com.mysql</groupId>
            <artifactId>mysql-connector-j</artifactId>
            <scope>runtime</scope>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <!--mybatis-plus-->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>3.5.5</version>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <scope>provided</scope>
        </dependency>
        <dependency>
            <groupId>jakarta.persistence</groupId>
            <artifactId>jakarta.persistence-api</artifactId>
            <version>3.1.0</version>
        </dependency>

        <dependency>
            <groupId>com.fasterxml.jackson.core</groupId>
            <artifactId>jackson-databind</artifactId>
            <version>2.17.2</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-dependencies</artifactId>
            <version>3.1.1</version>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>

二、代码部分

1.字段改动

代码如下(示例):

package com.demo.demo1.core;

import com.baomidou.mybatisplus.annotation.FieldFill;
import com.baomidou.mybatisplus.annotation.TableField;
import com.demo.demo1.utils.JsonFormatType;
import com.fasterxml.jackson.annotation.JsonFormat;
import jakarta.persistence.Temporal;
import jakarta.persistence.TemporalType;
import lombok.Getter;
import lombok.Setter;

import java.io.Serializable;
import java.util.Date;

@Getter
@Setter
public class BaseEntity implements Serializable {
  
  @TableField(value = "create_by")
  private String createBy;

  @TableField(value = "create_time",fill = FieldFill.INSERT)
  @Temporal(TemporalType.TIMESTAMP)
  @JsonFormat(pattern = JsonFormatType.DATE_TIME)
  private Date createTime;

  @TableField(value = "update_by")
  private String updateBy;

  @TableField(value = "update_time",fill = FieldFill.INSERT_UPDATE)
  @Temporal(TemporalType.TIMESTAMP)
  @JsonFormat(pattern = JsonFormatType.DATE_TIME)
  private Date updateTime;

  @TableField(value = "remark")
  private String remark;

}

最重要的是 @TableField(value = “create_time”,fill = FieldFill.INSERT),自己写的话别忘了。

因为我是将一些基础字段抽取出来做基类,然后其他实体类继承这个基类,这样所有的实体类就会省略这部分代码的编写。大家也可以将我的基类直接粘贴作为自己的基类,前提是一些注解的依赖需要加进来,如果是按照我给的直接粘贴就好

这个类记得加上

package com.demo.demo1.utils;

public class JsonFormatType {
  public static final String DATE = "yyyy-MM-dd";
  public static final String SHORT_DATE = "MM-dd";
  public static final String DATE_TIME = "yyyy-MM-dd HH:mm:ss";
  public static final String TIME = "HH:mm:ss";
  public static final String SHORT_TIME = "HH:mm";

  private JsonFormatType() {
  }
}

2.拦截后塞值

代码如下(示例):

package com.demo.demo1.handler;

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

import java.util.Date;

@Slf4j
@Component
public class AutoFillTimeHandler implements MetaObjectHandler {

  @Override
  public void insertFill(MetaObject metaObject) {
    log.info("开始插入填充...");
    metaObject.setValue("createTime", new Date());
    metaObject.setValue("updateTime", new Date());
  }

  @Override
  public void updateFill(MetaObject metaObject) {
    log.info("开始更新填充...");
    metaObject.setValue("updateTime", new Date());
  }
}

这里是在给 createTime 和 updateTime 填充当前时间。

3.接口测试

package com.demo.demo1.controller;

import com.demo.demo1.entity.User;
import com.demo.demo1.mapper.UserMapper;
import jakarta.annotation.Resource;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("/user")
public class UserController {

  @Resource
  private UserMapper userMapper;

  @PostMapping
  public String test(){
    User user = new User();
    user.setNickname("zhangsan");
    userMapper.insert(user);
    return "OK";
  }
}

使用 apifox 发起接口请求:

在这里插入图片描述
数据库保存成功!

在这里插入图片描述

最后贴下代码组成部分:
在这里插入图片描述
额外建议,因为作者一开始用 pg 的数据库,绕了很多弯路,所以建议大家最好开启 sql 的日志打印,防止不知道哪里出问题了。

不清楚咋开起的直接抄配置文件就行

spring:
  application:
   name: demo1
  datasource:
   url: jdbc:mysql://127.0.0.1:3306/demo?useSSL=false&allowPublicKeyRetrieval=true&characterEncoding=UTF-8&serverTimezone=GMT%2B8
   username: root
   password: root

#mybatis plus 设置
mybatis-plus:
  mapper-locations: classpath*:mapper/*Mapper.xml
  global-config:
    # 关闭MP3.0自带的banner
    banner: false
    db-config:
      #主键类型  0:"数据库ID自增",1:"该类型为未设置主键类型", 2:"用户输入ID",3:"全局唯一ID (数字类型唯一ID)", 4:"全局唯一ID UUID",5:"字符串全局唯一ID (idWorker 的字符串表示)";
      id-type: 0
      # 默认数据库表下划线命名
      table-underline: true
  configuration:
    # 这个配置会将执行的sql打印出来,在开发或测试的时候可以用
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl

但是别忘了数据库配置改成自己本地的!!!

总结部分

因为一开始使用 pg 的数据库,但是通过日志看,都没有填充成功,所以我在换了 mysql 数据库后,才发现生效。所以如果数据库是非 mysql 的兄弟,需要写完自己测试下是否有效!!!
其次,文章因为是讲明白如何使用,所以会稍微啰嗦点,方便大家上手。文档如有笔误,还望大家多多指正,3Q~

### 启用 MyBatis-Plus 的自动填充功能 #### 数据库设计调整 为了支持自动填充功能,需先在数据库表结构中增加 `createTime` `updateTime` 字段[^2]。这两个字段通常用于记录数据的创建时间最后更新时间。 #### 创建自定义处理器 需要编写一个类来实现 `MetaObjectHandler` 接口,并重写其中的方法以完成具体的逻辑处理。该接口提供了两个核心方法: - **insertFill**:当执行插入操作时调用此方法。 - **updateFill**:当执行更新操作时调用此方法。 以下是具体代码示例: ```java import com.baomidou.mybatisplus.core.handlers.MetaObjectHandler; import org.apache.ibatis.reflection.MetaObject; import java.util.Date; public class CustomMetaObjectHandler implements MetaObjectHandler { @Override public void insertFill(MetaObject metaObject) { this.strictInsertFill(metaObject, "createTime", Date.class, new Date()); // 插入时填充 createTime this.strictInsertFill(metaObject, "updateTime", Date.class, new Date()); // 插入时也填充 updateTime } @Override public void updateFill(MetaObject metaObject) { this.strictUpdateFill(metaObject, "updateTime", Date.class, new Date()); // 更新时仅填充 updateTime } } ``` 上述代码实现了在插入更新操作时分别设置 `createTime` `updateTime` 属性的值为当前时间戳[^1]。 #### 注册处理器到 Spring 容器 为了让 MyBatis-Plus 使用这个自定义处理器,需要将其注册到 Spring 应用上下文中。可以通过配置文件或者 Java 配置类的方式完成这一过程。 如果采用 XML 方式,则可以在 mybatis-plus.xml 中加入如下内容: ```xml <bean id="metaObjectHandler" class="com.example.CustomMetaObjectHandler"/> ``` 如果是基于注解方式,则可以直接标注组件扫描路径下的 handler 类型 bean: ```java @Component public class CustomMetaObjectHandler implements MetaObjectHandler { ... } ``` #### 实体类属性声明 对于希望被自动填充的时间戳字段,在实体类中应加上相应的注解说明其行为模式。例如: ```java @Data @TableName("your_table_name") public class YourEntity { private Long id; @TableField(fill = FieldFill.INSERT) private Date createTime; @TableField(fill = FieldFill.UPDATE) private Date updateTime; ... } ``` 这里通过 `@TableField` 注解指定不同场景下哪些字段参与自动赋值。 至此完成了整个流程介绍,包括从基础概念理解到实际项目落地应用的所有环节[^3]。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值