Gradle中OpenAPI生成代码无法识别，如何避免代码检查插件干扰？

核心思路 #

Gradle自带的annotationProcessor源码目录，天生就是给MapStruct这类工具生成代码用的——IDE会自动识别它是生成代码，而且代码检查工具默认不会扫这里。我们只要把OpenAPI Generator的输出路径改成这个目录，就能同时解决识别和检查干扰的问题。

具体配置步骤 #

1. 修改OpenAPI Generator的输出路径 #

在build.gradle（或build.gradle.kts）里，把插件的生成目录指定为annotationProcessor的默认路径：

Groovy 写法

openApiGenerate {
    generatorName = "java" // 换成你实际用的生成器，比如spring、kotlin
    inputSpec = "$rootDir/src/main/resources/openapi.yaml".toString()
    outputDir = "$buildDir/generated/sources/annotationProcessor/java/main"
    // 这里加你原本的其他配置，比如apiPackage、modelPackage这些
}

Kotlin 写法

openApiGenerate {
    generatorName.set("java")
    inputSpec.set("$rootDir/src/main/resources/openapi.yaml")
    outputDir.set("$buildDir/generated/sources/annotationProcessor/java/main")
    // 其他自定义配置
}

2. 让生成任务在编译前执行 #

确保代码生成在编译之前完成，同时Gradle会自动把这个目录当成源码目录，不用手动加sourceSets：

Groovy 写法

compileJava.dependsOn(openApiGenerate)

Kotlin 写法

tasks.compileJava {
    dependsOn(tasks.openApiGenerate)
}

3. 兜底排除检查（可选） #

虽然默认不会扫这个目录，但如果你的检查插件有特殊配置，保险起见可以手动排除：

Checkstyle 配置（Groovy）

checkstyle {
    sourceSets = sourceSets.main - files("$buildDir/generated/sources/annotationProcessor")
}

Spotless 配置（Groovy）

spotless {
    java {
        exclude("**/generated/sources/annotationProcessor/**")
    }
}

为什么这么做？ #

Gradle的annotationProcessor源码目录是官方专门为生成代码设计的，IntelliJ这类IDE会自动识别它是生成的代码，不会把它当成你写的源码；同时Checkstyle、Spotless这类插件默认都会跳过这个目录，完美匹配你的需求。

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