MyBatis-Flex 代码生成器配置主键生成策略详解

在使用 MyBatis-Flex 的代码生成器时，正确配置主键生成策略是一个常见但容易被忽视的技术点。本文将深入解析如何通过 ColumnConfig 正确设置主键生成方式，避免配置不生效的问题。

问题背景

开发者在使用 MyBatis-Flex 代码生成器时，希望通过配置为实体类的主键字段添加特定的生成策略注解。例如，使用雪花算法(SnowFlake)作为ID生成器。初始配置如下：

ColumnConfig columnConfig = new ColumnConfig();
columnConfig.setKeyType(KeyType.Generator);
columnConfig.setKeyValue(KeyGenerators.snowFlakeId);

然而生成的实体类中，@Id 注解上并没有预期的生成策略配置：

@Id
private Long id;

问题原因分析

经过排查发现，问题出在 ColumnConfig 的配置方式上。关键点在于：

1. 未指定目标列名：ColumnConfig 必须通过 setColumnName() 方法明确指定要配置的列名，否则配置无法关联到具体字段。

2. 未将配置加入全局配置：创建好的 ColumnConfig 必须通过 globalConfig.setColumnConfig() 方法加入到全局配置中才会生效。

正确配置方式

正确的完整配置示例如下：

// 创建列配置
ColumnConfig columnConfig = new ColumnConfig();
// 指定要配置的列名
columnConfig.setColumnName("ID");
// 设置主键生成类型
columnConfig.setKeyType(KeyType.Generator);
// 设置具体的生成器
columnConfig.setKeyValue(KeyGenerators.snowFlakeId);
// 将列配置加入全局配置
globalConfig.setColumnConfig(columnConfig);

配置效果

应用上述正确配置后，生成的实体类将包含预期的主键生成策略注解：

@Id(keyType = KeyType.Generator, value = "snowFlakeId")
private Long id;

技术要点总结

1. 明确目标列：必须通过 setColumnName() 指定要配置的具体列名，这是配置生效的前提。

2. 配置完整性：除了设置 keyType 和 keyValue 外，必须将 ColumnConfig 实例加入到 GlobalConfig 中。

3. 生成策略选择：MyBatis-Flex 提供了多种内置的 KeyGenerators，开发者可以根据需求选择：

   • snowFlakeId：雪花算法ID
   • uuid：UUID生成器
   • 其他自定义生成器

4. 全局配置管理：所有列级配置都需要通过 GlobalConfig 进行统一管理，这是 MyBatis-Flex 代码生成器的核心设计理念。

最佳实践建议

1. 对于主键配置，建议在代码生成前仔细检查列名是否与数据库一致。

2. 可以结合表名进行更精确的配置，避免不同表的同名列产生冲突。

3. 对于复杂的项目，建议将配置代码模块化，提高可维护性。

4. 生成后检查实体类是否符合预期，特别是注解部分。

通过正确理解和应用这些配置技巧，开发者可以充分利用 MyBatis-Flex 代码生成器的能力，高效生成符合项目需求的实体类代码。