如何用KSP生成GraalVM反射配置等非源码文件？

核心思路 #

KSP的CodeGenerator虽默认用于生成源码，但可通过指定带resources/META-INF的路径生成资源文件，再配合Gradle自动将KSP生成的资源目录纳入项目资源集，最终让文件打包进Jar的正确位置，且无需库使用者手动操作Gradle配置。

具体实现步骤 #

1. 在KSP处理器中指定资源路径生成文件 #

在你的KSP处理器类里，不要直接生成到源码目录，而是指定包含resources/META-INF的完整路径（符合GraalVM配置文件的标准存放结构）。示例代码如下：

class GraalVmReflectConfigProcessor : SymbolProcessor {
    override fun process(resolver: SymbolProcessorResolver): List<KSAnnotated> {
        val codeGenerator = environment.codeGenerator
        // 生成到resources/META-INF下的GraalVM标准路径
        val configFile = codeGenerator.createNewFile(
            dependencies = Dependencies(false),
            packageName = "", // 空包名避免生成到源码包目录
            fileName = "resources/META-INF/native-image/your.group.id/your-module-name/reflect-config.json"
        )
        // 写入反射配置内容
        configFile.bufferedWriter().use { writer ->
            writer.write("""
                [
                    {
                        "name": "com.your.package.TargetClass",
                        "allDeclaredConstructors": true,
                        "allPublicMethods": true,
                        "allDeclaredFields": true
                    }
                ]
            """.trimIndent())
        }
        return emptyList()
    }
}

2. 配置Gradle自动识别KSP生成的资源 #

在你的库模块的build.gradle.kts中添加以下配置，让Gradle自动把KSP生成的resources目录纳入项目资源集，确保打包时文件被放到Jar的根目录META-INF下：

plugins {
    kotlin("jvm")
    id("com.google.devtools.ksp")
}

sourceSets.main {
    // 将KSP生成的资源目录加入资源源集
    resources.srcDir(layout.buildDirectory.dir("generated/ksp/main/resources"))
}

// 确保KSP生成任务在资源处理前执行
tasks.processResources {
    dependsOn(tasks.kspKotlin)
}

3. 验证结果 #

执行./gradlew jar后，打开生成的Jar包，就能看到META-INF/native-image/your.group.id/your-module-name/reflect-config.json已处于正确位置，库使用者仅需正常依赖你的库即可，无需额外配置。

方案优势 #

• 所有配置逻辑封装在库的构建脚本与KSP处理器中，对使用者完全透明
• 基于KSP和Gradle的原生构建流程实现，而非临时hack方案
• 生成路径严格遵循GraalVM的配置文件规范，无需手动调整文件位置

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