MyBatis-Plus自定义PostInitTableInfoHandler实现指南

概述

在使用MyBatis-Plus进行开发时，有时我们需要在实体类初始化阶段动态添加自定义属性。MyBatis-Plus提供了PostInitTableInfoHandler接口来实现这一需求，但很多开发者在使用过程中会遇到配置问题。本文将详细介绍如何正确实现自定义的PostInitTableInfoHandler。

问题背景

开发者尝试通过application.properties配置文件来指定自定义的PostInitTableInfoHandler实现类：

mybatis-plus.global-config.post-init-table-info-handler=cc.kuaida.common.config.KuaidaPostInitTableInfoHandler

但系统报错提示无法将字符串转换为PostInitTableInfoHandler类型，这是因为PostInitTableInfoHandler不能通过配置文件直接指定类名来注入。

正确实现方式

1. 实现PostInitTableInfoHandler接口

首先需要创建一个实现PostInitTableInfoHandler接口的类：

public class KuaidaPostInitTableInfoHandler implements PostInitTableInfoHandler {
    @Override
    public void postTableInfo(TableInfo tableInfo, Class<?> entityClass) {
        // 在这里实现自定义逻辑
        // 例如动态添加字段
        if (entityClass.isAssignableFrom(User.class)) {
            tableInfo.getFieldList().add(new TableFieldInfo(
                tableInfo, 
                "customField", 
                "custom_field", 
                null, 
                null, 
                null, 
                null, 
                null, 
                null, 
                null, 
                null, 
                null, 
                null, 
                null, 
                null, 
                null, 
                null, 
                null, 
                null
            ));
        }
    }
}

2. 通过Spring Bean方式注册

在Spring Boot应用中，需要通过@Bean注解将自定义处理器注册到容器中：

@Configuration
public class MybatisPlusConfig {
    
    @Bean
    public PostInitTableInfoHandler postInitTableInfoHandler() {
        return new KuaidaPostInitTableInfoHandler();
    }
}

3. 高级用法：条件化注册

如果需要根据条件动态决定是否注册处理器，可以使用条件注解：

@Configuration
public class MybatisPlusConfig {
    
    @Bean
    @ConditionalOnProperty(name = "mybatis-plus.custom-handler.enabled", havingValue = "true")
    public PostInitTableInfoHandler postInitTableInfoHandler() {
        return new KuaidaPostInitTableInfoHandler();
    }
}

使用场景

PostInitTableInfoHandler特别适用于以下场景：

1. 动态字段添加：根据运行环境或配置动态向实体类添加字段
2. 字段元数据修改：修改字段的数据库映射关系或其他元数据
3. 多租户处理：根据租户信息动态调整表结构
4. 环境适配：针对不同数据库类型调整字段类型

注意事项

1. 处理器会在MyBatis-Plus初始化表信息后被调用
2. 修改TableInfo时要确保线程安全
3. 避免在处理器中执行耗时操作，以免影响启动速度
4. 确保处理逻辑不会破坏原有的表结构关系

总结

通过实现PostInitTableInfoHandler接口，我们可以灵活地干预MyBatis-Plus的实体初始化过程。与直接修改实体类相比，这种方式更加动态和灵活，特别适合需要根据运行环境调整实体映射关系的场景。记住关键点是通过Spring Bean方式注册处理器，而不是通过配置文件指定类名。