Gradle环境下MapStruct结合Groovy类使用时映射器实现类未生成的配置咨询

是的，MapStruct完全支持与Groovy类配合使用，但Groovy编译器的注解处理逻辑和Java有差异，直接沿用Java项目的配置会导致映射器实现类无法生成。下面是针对Gradle环境的正确配置步骤：

1. 调整依赖配置 #

首先确保你的依赖中包含Groovy核心库和正确的MapStruct依赖：

dependencies {
    // 引入Groovy依赖（根据项目实际使用的Groovy版本调整）
    implementation 'org.codehaus.groovy:groovy-all:3.0.17'
    
    // MapStruct核心依赖
    implementation 'org.mapstruct:mapstruct:1.4.2.Final'
    
    // MapStruct注解处理器（用于编译期生成实现类）
    annotationProcessor 'org.mapstruct:mapstruct-processor:1.4.2.Final'
    
    // 测试代码中使用MapStruct时需要的注解处理器
    testAnnotationProcessor 'org.mapstruct:mapstruct-processor:1.4.2.Final'
    
    // 测试相关依赖
    testImplementation 'org.codehaus.groovy:groovy-test:3.0.17'
}

2. 配置Groovy编译任务 #

Groovy编译器默认不启用注解处理，这是你之前配置失效的核心原因。需要在compileGroovy任务中明确开启注解处理，并配置生成源文件的目录：

compileGroovy {
    // 关键：启用注解处理功能
    options.annotationProcessing = true
    
    // 指定注解处理器的依赖路径
    options.annotationProcessorPath = configurations.annotationProcessor
    
    // 传递MapStruct的自定义参数（比如组件模型，按需配置）
    options.compilerArgs << "-Amapstruct.defaultComponentModel=default"
    
    // 设置生成的映射器实现类的存放目录
    def generatedGroovyDir = file("$projectDir/src/main/generated/groovy")
    options.setAnnotationProcessorGeneratedSourcesDirectory(generatedGroovyDir)
    
    // 将生成目录加入源集，确保Gradle能识别并编译这些生成类
    sourceSets.main.groovy.srcDirs += generatedGroovyDir
    
    // 提前创建目录，避免编译时报错
    generatedGroovyDir.mkdirs()
}

3. （可选）测试代码中的MapStruct配置 #

如果你的测试代码也用到了MapStruct，需要对compileTestGroovy任务做类似配置：

compileTestGroovy {
    options.annotationProcessing = true
    options.annotationProcessorPath = configurations.testAnnotationProcessor
    
    def testGeneratedDir = file("$projectDir/src/test/generated/groovy")
    options.setAnnotationProcessorGeneratedSourcesDirectory(testGeneratedDir)
    sourceSets.test.groovy.srcDirs += testGeneratedDir
    testGeneratedDir.mkdirs()
}

关键注意事项 #

• 注解处理开关：必须设置options.annotationProcessing = true，否则Groovy编译器会忽略所有注解处理器，包括MapStruct。
• 生成目录加入源集：如果不把生成目录添加到sourceSets，Gradle不会编译这些自动生成的映射器类，导致运行时找不到实现。
• 版本兼容性：确保Groovy版本和MapStruct版本兼容，比如Groovy 3.x搭配MapStruct 1.4+是稳定的组合，建议优先使用最新稳定版的MapStruct。

内容的提问来源于stack exchange，提问作者Tobias Kraft