Kotlin项目中jooq-codegen-gradle配置及生成文件类路径问题咨询

问题背景 #

jOOQ官方文档仅提及需将生成文件「确保其在类路径中」，但未给出具体配置指引。在全新Kotlin项目中使用jooq-codegen-gradle插件生成代码后，项目因无法识别生成的类而编译失败。通过手动配置sourceSets可解决问题，但需确认是否为最优方案。

现有方案评估 #

手动配置sourceSets确实能让Gradle识别生成的源码目录，但并非最贴合插件设计的方式——jooq-codegen-gradle插件本身提供了内置配置，可自动关联生成目录与项目源码集，无需手动修改sourceSets。

最优Gradle配置建议 #

使用插件内置的generateSchemaSourceOnCompilation配置，让插件自动管理生成目录的源码集关联，示例Gradle Kotlin DSL配置如下：

plugins {
    kotlin("jvm") version "1.9.20"
    id("org.jooq.jooq-codegen-gradle") version "3.19.8"
}

repositories {
    mavenCentral()
}

dependencies {
    implementation(kotlin("stdlib"))
    implementation("org.jooq:jooq:3.19.8")
    // 按需添加数据库驱动，以H2为例
    runtimeOnly("com.h2database:h2:2.2.224")
}

jooq {
    configurations {
        create("main") {
            // 开启编译时自动生成代码
            generateSchemaSourceOnCompilation.set(true)
            
            generator {
                database {
                    name = "org.jooq.meta.h2.H2Database"
                    url = "jdbc:h2:~/your-database-path"
                    user = "sa"
                    password = ""
                    includes = ".*" // 匹配所有表
                }
                target {
                    packageName = "com.yourpackage.generated"
                    // 默认生成路径，插件会自动将此目录加入源码集
                    directory = "build/generated/sources/jooq/main"
                }
            }
        }
    }
}

关键说明 #

1. generateSchemaSourceOnCompilation.set(true)：启用后，插件会自动将生成目录添加到sourceSets.main.kotlin.srcDirs，无需手动配置sourceSets
2. 保持target.directory为插件默认路径（build/generated/sources/jooq/main），符合Gradle的构建产物存放约定，避免自定义路径带来的额外配置

替代实现方式 #

若因特殊需求需手动管理生成目录，除了sourceSets外，还可通过显式声明任务依赖，确保代码生成在编译前执行（插件已默认处理此依赖，此为可选补充）：

tasks.compileKotlin {
    dependsOn(tasks.jooqCodegenMain)
}

但此方式仍需配合sourceSets添加生成目录，因此优先推荐插件内置的自动配置方案。

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