MyBatis-Plus Generator 自定义生成 Repository 层代码实践

MyBatis-Plus 作为 MyBatis 的增强工具，其代码生成器模块能够显著提升开发效率。在实际企业级开发中，我们经常需要生成符合特定规范的 Repository 层接口。本文将详细介绍如何通过 MyBatis-Plus Generator 配置来自动生成符合 Spring Data JPA 风格的 Repository 接口。

传统代码生成器的局限性

标准的 MyBatis-Plus Generator 默认会生成 Service 层和 Mapper 层代码，但在某些项目中，特别是需要与 Spring Data JPA 风格保持一致的场景下，我们更希望生成 Repository 层接口而非传统的 Service 层。这种需求在微服务架构或需要统一数据访问层的项目中尤为常见。

自定义 Repository 生成配置

通过以下配置，我们可以将 MyBatis-Plus Generator 的输出调整为 Repository 风格：

AutoGenerator generator = new AutoGenerator(DATA_SOURCE_CONFIG);

// 配置包路径
generator.packageInfo(
    new PackageConfig.Builder()
        .service("repository")        // 将service包改为repository包
        .serviceImpl("repository.impl") // 实现类放在repository.impl包
        .build()
);

// 配置生成策略
generator.strategy(
    new StrategyConfig.Builder()
        .serviceBuilder()
            .convertServiceFileName(entityName -> "I" + entityName + "Repository") // 接口命名规则
            .superServiceClass(IRepository.class)  // 基础接口
            .convertServiceImplFileName(entityName -> entityName + "Repository") // 实现类命名规则
            .superServiceImplClass(CrudRepository.class) // 基础实现类
        .build()
);

generator.global(new GlobalConfig.Builder().build());
generator.execute();

配置详解

1. 包路径配置：

   • 将传统的 service 包名改为 repository
   • 实现类放在 repository.impl 子包中
   • 这种包结构更符合 JPA 项目的组织方式

2. 命名规则配置：

   • 接口名称添加 I 前缀和 Repository 后缀（如 IUserRepository）
   • 实现类名称添加 Repository 后缀（如 UserRepository）
   • 这种命名方式既保持了与 Spring Data JPA 的相似性，又体现了接口与实现的关系

3. 基类配置：

   • 接口继承自定义的 IRepository 接口
   • 实现类继承 CrudRepository 类
   • 这种继承关系为 Repository 层提供了统一的 CRUD 操作基础

实际应用场景

这种配置特别适合以下场景：

1. 项目迁移：从 Spring Data JPA 迁移到 MyBatis-Plus 时，保持接口命名一致性
2. 统一规范：在混合使用 JPA 和 MyBatis 的项目中，统一数据访问层接口
3. 团队协作：当团队成员熟悉 JPA 风格时，降低学习成本

高级定制建议

对于更复杂的需求，还可以考虑：

1. 自定义模板文件，完全控制生成的代码结构
2. 通过继承 ServiceImpl 来实现更丰富的基类功能
3. 结合自定义注解，为生成的 Repository 添加特定功能标记
4. 集成 Lombok 等工具简化代码

总结

通过合理配置 MyBatis-Plus Generator，我们能够生成符合项目规范的 Repository 层代码，既保持了 MyBatis-Plus 的高效特性，又满足了项目架构的统一性要求。这种灵活的配置方式体现了 MyBatis-Plus 作为现代化 ORM 框架的强大适应能力，能够满足各种企业级开发场景的需求。