MyBatis-Plus实现自动填充功能的示例代码_Java

01 引言

在数据库设计中，常常有一些字段每次都需要赋值，如创建时间、更新时间、操作人、删除标识等。很多时候，为了赶项目匆匆的赋值了一些业务字段，而漏掉了这些字段，导致查询问题的时候，时间点或者操作人对不上，加大了定位问题的难度。

有没有框架级的技术，全局处理这样的统一字段呢？当然有。

mybatis-plus自动填充技术帮我们解决问题。

02 自动填充实现

使用mybtis-plus之前，我们需要简单的搭建环境。

2.1 mybatis-plus 简单搭建

maven

<dependency>
    <groupid>com.baomidou</groupid>
    <artifactid>mybatis-plus-boot-starter</artifactid>
    <version>${mybatis-plus.version}</version>
</dependency>
<dependency>
    <groupid>com.mysql</groupid>
    <artifactid>mysql-connector-j</artifactid>
    <scope>runtime</scope>
</dependency>

配置

# 数据源
spring.datasource.driver-class-name=com.mysql.cj.jdbc.driver
spring.datasource.url=jdbc:mysql://127.0.0.1:3306/test
spring.datasource.username=root
spring.datasource.password=root

# 日志实现
mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.stdoutimpl
# 开启驼峰匹配
mybatis-plus.configuration.map-underscore-to-camel-case=true
# 配置全局数据库主键
mybatis-plus.global-config.db-config.id-type=auto

启动类增加mapper扫描

@mapperscan("com.simonking.boot.mybaits.mapper")

实体

@data
@tablename("user_info")
public class userinfo {
    
    /**
     * 主键id
     **/
    @tableid
    private integer id;

    /**
     * 姓名
     **/
    private string name;

    /**
     * 年龄
     **/
    private integer age;


    /**
     * 性别
     **/
    private string sex;

    /**
     * 工作
     **/
    private string job;

    /**
     * 生日
     **/
    private localdatetime birthday;

    /**
     * 创建时间
     **/
    private localdatetime createdtime;

    /**
     * 更新时间
     **/
    private localdatetime updatetime;
}

继承basemapper

public interface userinfomapper extends basemapper<userinfo> {

}

到这里，mybatis-plus就搭建好了，可以注解注入xxxmapper调用方法了。

2.2 标记自动填充的字段

在实体类中，你需要使用 @tablefield 注解来标记哪些字段需要自动填充，并指定填充的策略。

@data
@tablename("user_info")
public class userinfo {
    
    // 其他字段...

    /**
     * 创建时间
     **/
    @tablefield(fill = fieldfill.insert)
    private localdatetime createdtime;

    /**
     * 更新时间
     **/
    @tablefield(fill = fieldfill.insert_update)
    private localdatetime updatetime;
}

fieldfill填充的枚举：

public enum fieldfill {
    default,       // 默认不处理
    insert,        // 插入填充字段
    update,        // 更新填充字段
    insert_update  // 插入和更新填充字段
}

2.3 实现metaobjecthandler

创建一个类来实现 metaobjecthandler 接口，并重写 insertfill 和 updatefill 方法。并确保实现类被spring管理，可以通过 @component 或 @bean 注解来实现。

@slf4j
@component
public class autofillmetaobjecthandler implements metaobjecthandler {
    @override
    public void insertfill(metaobject metaobject) {
        log.info("insertfill 开始自动填充......");
        this.strictinsertfill(metaobject, "createdtime", localdatetime.class, localdatetime.now());
        this.strictinsertfill(metaobject, "updatetime", localdatetime.class, localdatetime.now());
    }

    @override
    public void updatefill(metaobject metaobject) {
        log.info("updatefill 开始自动填充......");
        this.strictupdatefill(metaobject, "updatetime", localdatetime.class, localdatetime.now());
    }
}

2.4 测试

 @test
void contextloads01() {
    userinfo userinfo = new userinfo();
    userinfo.setname("test");
    userinfo.setage(18);
    userinfomapper.insert(userinfo);
}

从运行结果来看，cteated_time和update_time已经被赋值了。

2.5 思考

这种全局的自动填充有什么问题呢？

先看截图：

这里填充的时候，需要指定字段的名称。但是如果因为开发人员定义错字段，如update_time -> updated_time等，这里就需要穷举所有的字段。

有人可能说是开发规范的问题，的确是。但是这种问题确实有点别扭。

能不能通过注解字段指定别名，统一自动赋值的字段呢？官方暂时不支持这种方式。

03 实现原理

自动赋值的的触发机制是如何实现的呢？第一反应，应该是使用了mybatis的拦截器插件，细看了之后，并不是。我们一起来看看。

mybatis-plus自动填充调用metaobjecthandler,涉及了两个的类：

com.baomidou.mybatisplus.core.mybatisparameterhandler

3.1 mybatisparameterhandler

com.baomidou.mybatisplus.core.mybatisparameterhandler是对mybaits原生的org.apache.ibatis.scripting.defaults.defaultparameterhandler的增强。defaultparameterhandler是mybatis处理sql参数的核心类，负责：