Skip to content

feat(generator): add table field meta info customizer#7041

Open
smf-h wants to merge 1 commit intobaomidou:3.0from
smf-h:feat/generator-meta-info-customizer
Open

feat(generator): add table field meta info customizer#7041
smf-h wants to merge 1 commit intobaomidou:3.0from
smf-h:feat/generator-meta-info-customizer

Conversation

@smf-h
Copy link
Copy Markdown

@smf-h smf-h commented Mar 12, 2026

变更说明

mybatis-plus-generator 增加一个小范围、向后兼容的扩展点,允许用户在字段初始类型转换完成后、模板渲染前,对最终字段元信息进行自定义调整。

背景

当前 ITypeConvertHandler 主要负责类型转换逻辑。
但是在类型转换完成后,到模板真正消费字段信息之间,缺少一个统一的后置处理入口。

这会让一些场景不太容易优雅处理,例如:

  • 特殊数据库类型需要在生成阶段二次修正 jdbcTypetypeName
  • 自定义 Java 类型映射后,还需要同步调整字段最终元信息
  • 在模板渲染前,需要补充字段级扩展属性或附加配置

本次改动

本 PR 新增一个扩展接口:

  • ITableFieldMetaInfoCustomizer

并通过 Entity.Builder 暴露配置入口:

  • addTableFieldMetaInfoCustomizers(ITableFieldMetaInfoCustomizer...)
  • addTableFieldMetaInfoCustomizers(List<ITableFieldMetaInfoCustomizer>)

该扩展点会在以下两条查询链路中执行:

  • DefaultQuery
  • SQLQuery

同时,为了支持后置调整,TableField.MetaInfo 增加了部分 setter 方法,用于修改可变元信息字段。

使用示例

strategyConfigBuilder.entityBuilder()
    .addTableFieldMetaInfoCustomizers((tableInfo, tableField) -> {
        if ("point".equalsIgnoreCase(tableField.getMetaInfo().getTypeName())) {
            tableField.getMetaInfo().setJdbcType(JdbcType.OTHER);
            tableField.setColumnType(DbColumnType.OBJECT);
        }
    });

兼容性说明

  • 未配置 customizer 时,默认行为保持不变
  • 改动范围仅限 mybatis-plus-generator
  • 不影响运行时模块行为

测试情况

已补充以下测试:

  • Builder 层配置 customizer 的保存测试
  • 查询阶段执行字段元信息自定义的测试

设计考虑

相比继续增加更多单点配置项,这种字段元信息后置扩展点更通用,也更容易复用,适用于后续类似场景,例如:

  • geometry / point
  • JSON / ARRAY
  • 自定义值对象映射
  • 模板渲染前的字段元信息调整

本次实现尽量保持改动面小,并避免修改现有默认生成行为。

Related to #7037

@smf-h smf-h marked this pull request as ready for review March 15, 2026 11:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant