MyBatis-Plus Generator Repository层代码生成完全指南：从配置到实战

在企业级项目开发中，数据访问层的设计往往面临两难选择：既要保持代码的规范性和一致性，又要避免重复劳动。许多团队采用Repository模式来统一数据访问接口，但使用MyBatis-Plus自动生成代码时，默认的Service层结构与Repository模式的要求存在差异，导致开发人员不得不手动调整代码结构，既耗时又容易出错。本文将详细介绍如何通过MyBatis-Plus Generator实现Repository层代码的自动生成，帮助团队快速构建规范的数据访问层。

定制包结构指向

在默认配置下，MyBatis-Plus Generator会生成Service层代码，但我们需要将其替换为Repository层。通过调整包路径配置，可以让生成器直接将代码输出到指定的Repository目录中。

核心配置参数

generator.packageInfo(packageConfig()
    .parent("com.example")
    .service("repository")     // 将Service接口包指向repository
    .serviceImpl("repository.impl") // 将ServiceImpl包指向repository.impl
    .build());

配置对比表

配置项	默认值	自定义值	说明
service	service	repository	接口包名
serviceImpl	service.impl	repository.impl	实现类包名

💡 提示：包路径配置需要与项目的整体架构保持一致，建议在项目初始化时就确定好包结构，避免后期调整带来的麻烦。

定制命名规则

Repository模式有其特定的命名规范，通常接口以"I"开头并以"Repository"结尾，实现类则直接以"Repository"结尾。通过配置命名转换规则，可以让生成的代码自动符合这些规范。

核心配置参数

generator.strategy(
    strategyConfig()
        .serviceBuilder()
            .convertServiceFileName(entityName -> "I" + entityName + "Repository")
            .convertServiceImplFileName(entityName -> entityName + "Repository")
        .build());

构建基础框架

为了让生成的Repository层代码具有统一的功能和风格，需要定义基础的Repository接口和实现类，并让生成的代码继承这些基础类。

核心配置参数

generator.strategy(
    strategyConfig()
        .serviceBuilder()
            .superServiceClass(IRepository.class)
            .superServiceImplClass(CrudRepository.class)
        .build());

💡 提示：基础类需要提前创建，确保包含项目通用的数据库操作方法，如分页查询、条件查询等。

实战案例演示

以下是一个完整的配置示例，展示如何将上述三个核心技术点整合起来：

AutoGenerator generator = new AutoGenerator(DATA_SOURCE_CONFIG);

// 包结构配置
generator.packageInfo(packageConfig()
    .parent("com.example")
    .entity("domain")
    .mapper("dao")
    .service("repository")
    .serviceImpl("repository.impl")
    .build());

// 策略配置
generator.strategy(
    strategyConfig()
        .serviceBuilder()
            .convertServiceFileName(entityName -> "I" + entityName + "Repository")
            .convertServiceImplFileName(entityName -> entityName + "Repository")
            .superServiceClass(IRepository.class)
            .superServiceImplClass(CrudRepository.class)
        .entityBuilder()
            .enableLombok()
            .enableChainModel()
        .build());

// 全局配置
generator.global(globalConfig()
    .author("Developer")
    .outputDir(System.getProperty("user.dir") + "/src/main/java")
    .build());

generator.execute();

执行上述配置后，将生成如下目录结构：

src/main/java/com/example/
├── domain
│   └── User.java
├── dao
│   └── UserMapper.java
└── repository
    ├── IUserRepository.java
    └── impl
        └── UserRepository.java

扩展应用

常见配置错误排查

1. 基础类找不到：确保superServiceClass和superServiceImplClass配置的类全路径正确，并且这些类已经存在于项目中。

2. 命名规则不生效：检查convertServiceFileName和convertServiceImplFileName的lambda表达式是否正确，确保参数和返回值符合要求。

3. 包路径不正确：确认packageInfo中的各个包路径配置正确，特别是parent包路径是否准确。

配置模板复用

为了在多个项目中复用Repository层的生成配置，可以将配置封装成一个独立的工具类：

public class RepositoryGenerator {
    public static void generate(String parentPackage, String outputDir) {
        // 配置代码...
    }
}

在不同项目中只需调用该工具类并传入相应参数即可。

代码生成方案对比

方案	优点	缺点
手动编写	完全自定义，灵活度高	耗时，易出错，一致性差
默认Service生成	快速，无需额外配置	不符合Repository模式规范
自定义Repository生成	规范，高效，一致性好	需要额外配置，有一定学习成本

注意事项

1. 确保项目中已存在IRepository和CrudRepository基础类，并且这些类包含了必要的方法定义。

2. 在生成代码前，建议先备份已有代码，避免生成过程中覆盖重要文件。

3. 对于复杂的业务场景，可能需要在生成的代码基础上进行手动调整，但应尽量减少手动修改，保持自动生成的优势。

通过本文介绍的配置方法，开发团队可以快速实现符合Repository模式的代码自动生成，提高开发效率，同时保持代码的规范性和一致性。MyBatis-Plus作为一款优秀的MyBatis增强工具，不仅简化了CRUD操作，还通过灵活的配置机制满足了不同项目的个性化需求。希望本文的内容能够帮助开发人员更好地利用MyBatis-Plus Generator，构建高质量的数据访问层。