MyBatis-Plus代码生成器对SpringDoc注解的支持优化

背景介绍

MyBatis-Plus作为MyBatis的增强工具，其代码生成器功能广受开发者喜爱。在API文档生成方面，传统上我们使用SpringFox的Swagger注解，但随着SpringDoc的兴起，越来越多的项目开始迁移到SpringDoc方案。

新旧注解对比

在SpringFox时代，我们常用的Swagger注解是：

• @ApiModel：用于类级别的模型描述
• @ApiModelProperty：用于字段级别的属性描述

而在SpringDoc规范中，这些注解被统一为：

• @Schema：既可用于类级别也可用于字段级别

MyBatis-Plus的解决方案

MyBatis-Plus代码生成器已经提供了对SpringDoc注解的支持。开发者可以通过调用enableSpringdoc()方法来生成符合SpringDoc规范的注解，而不是默认的Swagger注解。

使用示例

// 配置代码生成器
new AutoGenerator()
    .setGlobalConfig(globalConfig)
    .setDataSource(dataSourceConfig)
    .setPackageInfo(packageConfig)
    .setStrategy(strategyConfig)
    .setTemplateEngine(new FreemarkerTemplateEngine())
    .execute();
    
// 启用SpringDoc支持
strategyConfig.enableSpringdoc();

生成效果对比

传统Swagger注解生成结果：

@ApiModel(value = "Dept对象", description = "部门表")
public class Dept implements Serializable {
    
    @ApiModelProperty("主键ID")
    @TableId(value = "id", type = IdType.AUTO)
    private Integer id;
}

启用SpringDoc后的生成结果：

@Schema(name= "Dept对象", description = "部门表")
public class Dept implements Serializable {

    @Schema(description ="主键ID")
    @TableId(value = "id", type = IdType.AUTO)
    private Integer id;
}

迁移建议

对于正在从SpringFox迁移到SpringDoc的项目，MyBatis-Plus的这一特性可以大大简化迁移工作。开发者只需在代码生成配置中启用SpringDoc支持，即可自动生成符合新规范的注解，无需手动修改生成的代码。

最佳实践

1. 对于新项目，建议直接使用enableSpringdoc()方法
2. 对于迁移项目，可以批量替换现有注解，或重新生成代码
3. 注意SpringDoc和SpringFox不要同时存在于项目中，以免造成冲突

MyBatis-Plus对SpringDoc的支持体现了框架与时俱进的特点，为开发者提供了更加现代化的API文档生成方案。这一改进不仅简化了开发流程，也帮助项目保持技术栈的先进性。