快捷導(dǎo)航

MyBatis-Plus自動(dòng)填充字段的詳細(xì)教程

更新時(shí)間：2024年08月16日 08:40:29 作者：IT小輝同學(xué)

今天編寫一個(gè)詳細(xì)的教程來介紹如何在?Spring?Boot?項(xiàng)目中使用?MyBatis-Plus?實(shí)現(xiàn)自動(dòng)填充時(shí)間字段（如創(chuàng)建時(shí)間?createTime?和更新時(shí)間?updateTime）,可以分為以下幾個(gè)部分,這個(gè)教程將涵蓋從項(xiàng)目配置到自動(dòng)填充的完整過程,需要的朋友可以參考下

1. 項(xiàng)目環(huán)境配置

首先，需要確保項(xiàng)目中已經(jīng)集成了 Spring Boot 和 MyBatis-Plus。下面是一些基本的配置步驟：

1.1 引入必要的依賴

在 pom.xml 中添加 MyBatis-Plus 的依賴：

<dependencies>
    <!-- MyBatis-Plus -->
    <dependency>
        <groupId>com.baomidou</groupId>
        <artifactId>mybatis-plus-boot-starter</artifactId>
        <version>3.5.1</version>
    </dependency>

    <!-- 其他必要依賴 -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <!-- MySQL 驅(qū)動(dòng) -->
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <scope>runtime</scope>
    </dependency>
</dependencies>

1.2 配置數(shù)據(jù)源

在 application.yml 或 application.properties 文件中配置數(shù)據(jù)庫連接：

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/your_database?useUnicode=true&characterEncoding=UTF-8&serverTimezone=UTC
    username: your_username
    password: your_password
    driver-class-name: com.mysql.cj.jdbc.Driver

mybatis-plus:
  mapper-locations: classpath:/mapper/*.xml
  type-aliases-package: com.example.entity
  global-config:
    db-config:
      id-type: auto

2. 創(chuàng)建基礎(chǔ)實(shí)體類

為數(shù)據(jù)庫中的表創(chuàng)建一個(gè)基礎(chǔ)實(shí)體類 BaseEntity，在該類中定義創(chuàng)建時(shí)間和更新時(shí)間字段，并使用 MyBatis-Plus 的注解配置自動(dòng)填充。

package com.example.utils;

import com.baomidou.mybatisplus.annotation.FieldFill;
import com.baomidou.mybatisplus.annotation.TableField;
import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonInclude;
import lombok.Data;

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

@Data
public class BaseEntity implements Serializable {

    private static final long serialVersionUID = 1L;

    /**
     * 搜索值（暫時(shí)忽略）
     */
    @JsonIgnore
    @TableField(exist = false)
    private String searchValue;

    /**
     * 創(chuàng)建者
     */
    @TableField(fill = FieldFill.INSERT)
    private String createBy;

    /**
     * 創(chuàng)建時(shí)間
     */
    @TableField(fill = FieldFill.INSERT)
    private Date createTime;

    /**
     * 更新者
     */
    @TableField(fill = FieldFill.INSERT_UPDATE)
    private String updateBy;

    /**
     * 更新時(shí)間
     */
    @TableField(fill = FieldFill.INSERT_UPDATE)
    private Date updateTime;

    /**
     * 請求參數(shù)（暫時(shí)忽略）
     */
    @JsonInclude(JsonInclude.Include.NON_EMPTY)
    @TableField(exist = false)
    private Map<String, Object> params = new HashMap<>();

}

3. 實(shí)現(xiàn) MetaObjectHandler 接口

為了使 BaseEntity 中的自動(dòng)填充注解生效，我們需要實(shí)現(xiàn) MetaObjectHandler 接口，并將其配置為 Spring 的一個(gè) Bean。

3.1 創(chuàng)建 MyMetaObjectHandler 類

package com.example.config;

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) {
        // 填充創(chuàng)建時(shí)間和更新時(shí)間
        this.strictInsertFill(metaObject, "createTime", Date.class, new Date());
        this.strictInsertFill(metaObject, "updateTime", Date.class, new Date());
        // 可以根據(jù)業(yè)務(wù)需求獲取當(dāng)前用戶，填充創(chuàng)建者和更新者
        this.strictInsertFill(metaObject, "createBy", String.class, getCurrentUser());
        this.strictInsertFill(metaObject, "updateBy", String.class, getCurrentUser());
    }

    @Override
    public void updateFill(MetaObject metaObject) {
        // 更新時(shí)只填充更新時(shí)間和更新者
        this.strictUpdateFill(metaObject, "updateTime", Date.class, new Date());
        this.strictUpdateFill(metaObject, "updateBy", String.class, getCurrentUser());
    }

    // 示例方法：獲取當(dāng)前用戶信息
    private String getCurrentUser() {
        // 這里可以集成 Spring Security 或其他上下文獲取實(shí)際的當(dāng)前用戶
        return "system"; // 這是一個(gè)占位符，實(shí)際應(yīng)用中會(huì)替換為真實(shí)用戶信息
    }
}

3.2 配置生效

通過在 MyMetaObjectHandler 類上使用 @Component 注解，Spring 會(huì)自動(dòng)管理這個(gè)類，并在實(shí)體插入和更新時(shí)調(diào)用它來填充字段。

4. 實(shí)體類繼承 BaseEntity

現(xiàn)在，你的具體實(shí)體類可以繼承 BaseEntity，從而自動(dòng)獲得 createTime 和 updateTime 字段的自動(dòng)填充功能。

package com.example.entity;

import com.baomidou.mybatisplus.annotation.TableName;
import com.example.utils.BaseEntity;
import lombok.Data;

@Data
@TableName("your_table")
public class YourEntity extends BaseEntity {
    // 其他字段
    private String name;
    private Integer age;
}

5. 處理數(shù)據(jù)插入與更新

在 Service 或 Mapper 層，執(zhí)行插入或更新操作時(shí)，createTime 和 updateTime 字段會(huì)自動(dòng)填充。

5.1 Service 層示例

@Service
public class YourEntityService {

    @Autowired
    private YourEntityMapper yourEntityMapper;

    public void saveEntity(YourEntity entity) {
        yourEntityMapper.insert(entity);
    }

    public void updateEntity(YourEntity entity) {
        yourEntityMapper.updateById(entity);
    }
}

6. 驗(yàn)證自動(dòng)填充功能

通過簡單的單元測試或集成測試，驗(yàn)證 createTime 和 updateTime 字段在插入和更新時(shí)是否正確自動(dòng)填充。

7. 其他注意事項(xiàng)

字段類型： 確保數(shù)據(jù)庫中的 createTime 和 updateTime 字段類型與 Java 實(shí)體類中的類型相匹配（通常是 DATETIME 類型）。
時(shí)間格式： 如果需要統(tǒng)一時(shí)間格式，可以在配置文件中設(shè)置 Spring Boot 的全局時(shí)間格式，或使用 @JsonFormat 注解指定序列化時(shí)的格式。

spring:
  jackson:
    date-format: yyyy-MM-dd HH:mm:ss
    time-zone: GMT+8

總結(jié)

通過本文的教程，你可以輕松地在 Spring Boot 項(xiàng)目中使用 MyBatis-Plus 自動(dòng)填充創(chuàng)建時(shí)間和更新時(shí)間字段。該方法充分利用了 MyBatis-Plus 的自動(dòng)填充機(jī)制，并結(jié)合 Spring Boot 的優(yōu)勢，使開發(fā)過程更加簡潔高效。如果遇到問題，務(wù)必檢查 MetaObjectHandler 是否正確注冊，字段類型是否匹配，以及數(shù)據(jù)庫配置是否正確。

以上就是MyBatis-Plus自動(dòng)填充字段的詳細(xì)教程的詳細(xì)內(nèi)容，更多關(guān)于MyBatis-Plus自動(dòng)填充字段的資料請關(guān)注腳本之家其它相關(guān)文章！

您可能感興趣的文章: