MyBatis-Plus Generator 注解排序问题分析与解决方案

问题背景

MyBatis-Plus Generator 作为 MyBatis-Plus 生态中的代码生成工具，在 3.5.10.1 版本升级后出现了一个值得注意的行为变化：实体类字段上的注解顺序变得不一致。这个问题在开发团队协作和版本控制中可能会带来一些困扰。

问题现象

在升级到 3.5.10.1 版本后，生成的实体类字段注解顺序出现了以下变化：

1. 旧版本(3.5.9)生成的代码中，注解顺序固定为 @Schema 在前，@TableField 在后
2. 新版本生成的代码中，这两个注解的顺序变得不一致，有时 @Schema 在前，有时 @TableField 在前

这种不一致性会导致 Git 版本控制系统中出现大量看似"修改"但实际上只是注解顺序变化的提交记录，给代码审查和版本管理带来不便。

技术分析

通过分析源代码，我们发现这个问题源于注解排序策略的变化。当前版本的排序逻辑是基于整行注解代码的长度进行的，这种排序方式存在以下问题：

1. 非确定性：当注解参数内容长度变化时，排序结果也会变化
2. 不可预测：开发者难以直观理解排序规则
3. 版本控制干扰：微小的参数变化可能导致注解顺序重排

解决方案探讨

针对这个问题，社区提出了几种更合理的排序方案：

方案一：按注解名称首字母排序

按照注解名称的第一个字母(A-Z)进行排序，例如：

• @Schema (S)
• @TableField (T)

这种方案排序结果稳定，易于理解，且与Java编码习惯一致。

方案二：按注解名称长度排序

按照注解名称(不包含参数部分)的长度排序，例如：

• @Schema (6个字符)
• @TableField (10个字符)

这种方案也能保证稳定的排序结果，且短名称的注解会排在前面，代码可读性较好。

自定义排序策略

MyBatis-Plus 提供了通过配置自定义排序策略的能力，开发者可以使用以下代码实现自定义排序：

entityBuilder()
    .annotationAttributesFunction(annotationAttributes -> annotationAttributes.stream()
        .sorted(Comparator.comparingInt((AnnotationAttributes c) -> c.getDisplayName().charAt(1)))
        .collect(Collectors.toList()))

这种方式提供了最大的灵活性，允许开发者根据项目需求实现任何排序逻辑。

最佳实践建议

对于大多数项目，我们推荐采用以下实践：

1. 统一排序标准：团队内部约定使用一种固定的排序策略
2. 版本升级注意：升级 Generator 版本时检查注解排序变化
3. 代码审查：将注解顺序纳入代码审查标准
4. 文档记录：在项目文档中记录采用的排序策略

总结

MyBatis-Plus Generator 的注解排序问题虽然看似微小，但在团队协作和版本控制中可能带来不小的影响。理解排序机制并采用合理的排序策略，可以保持代码的一致性和可维护性。开发者可以根据项目需求选择内置排序策略或实现自定义排序逻辑，确保生成的代码符合团队规范。