使用Gradle构建Ktor项目可执行JAR时主类找不到问题排查

嘿，我来帮你排查这个问题！你说Gradle打包JAR很顺利，但运行时一直报JAR file: cannot find main class routing.MainKt，结合你给出的配置、JAR内容和代码，咱们一步步来分析：

先看你提供的信息 #

Gradle配置 #

buildscript {
    ext.kotlin_version = '1.2.21'
    ext.ktorVersion = '0.9.0'
    repositories {
        mavenCentral()
    }
    dependencies {
        classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
    }
}
apply plugin: 'java'
apply plugin: 'kotlin'
sourceCompatibility = 1.8
compileKotlin {
    kotlinOptions.jvmTarget = "1.8"
}
compileTestKotlin {
    kotlinOptions.jvmTarget = "1.8"
}
kotlin {
    experimental {
        coroutines "enable"
    }
}
jar {
    manifest {
        attributes 'Main-Class': "routing.MainKt"
    }
    from { configurations.compile.collect { it.isDirectory() ? it : zipTree(it) } }
}
repositories {
    mavenCentral()
    jcenter()
    maven { url "https://dl.bintray.com/kotlin/kotlinx" }
    maven { url "https://dl.bintray.com/kotlin/ktor" }
    maven { url "http://repository.jetbrains.com/kotlin-nosql" }
    maven { url "https://oss.sonatype.org/content/repositories/snapshots" }
}
dependencies {
    //Core Ktor libs
    compile "org.jetbrains.kotlin:kotlin-stdlib-jdk8"
    compile "io.ktor:ktor-server-core:$ktorVersion"
    compile "io.ktor:ktor-server-netty:$ktorVersion"
    compile "io.ktor:ktor-freemarker:$ktorVersion"
    compile "io.ktor:ktor-locations:$ktorVersion"
    ...Other libs
}

JAR文件内容（jar tf命令输出） #

routing/MainKt$chartsxyzApplication$5.class
routing/MainKt$chartsxyzApplication$5$1.class
routing/MainKt$chartsxyzApplication$4.class
routing/MainKt$chartsxyzApplication$4$1.class
routing/MainKt.class
routing/MainKt$redirect$1.class
routing/MainKt$chartsxyzApplication$5$2.class
routing/MainKt$chartsxyzApplication$2.class
routing/MainKt$chartsxyzApplication$1.class
routing/MainKt$chartsxyzApplication$3.class
routing/MainKt$main$1.class

Main.kt核心代码 #

package routing
import io.ktor.application.*
...
@location("/")
class Index
...
A bunch of other locations
fun main(args: Array<String>) {
    embeddedServer(Netty, 8080, module = Application::chartsApplication).start()
}
fun Application.chartsApplication(){
    ...
}
suspend fun ApplicationCall.redirect(location: Any) {
    ...
}
fun ApplicationCall.refererHost() = request.header(HttpHeaders.Referrer)?.let { URI.create(it).host }

问题原因分析 #

从jar tf的输出能看到routing/MainKt.class确实存在，说明主类已经被打包进去了。问题大概率出在Gradle的jar任务配置上：

1. 你用了configurations.compile来收集依赖，但在Gradle 6.0+版本中，compile配置已经被废弃，取而代之的是implementation和runtimeOnly，configurations.compile可能无法正确获取所有运行时依赖，导致JAR运行时找不到必要的类，间接触发主类找不到的错误。
2. 直接用jar任务打包胖JAR的方式不够可靠，容易出现依赖重复、类路径冲突等问题。

解决方法 #

方案1：使用application+shadow插件（推荐） #

这是Ktor官方推荐的打包方式，能更稳妥地生成可执行胖JAR：

1. 修改buildscript，引入shadow插件：

buildscript {
    ext.kotlin_version = '1.2.21'
    ext.ktorVersion = '0.9.0'
    ext.shadow_version = '7.1.2' // 添加shadow版本
    repositories {
        mavenCentral()
    }
    dependencies {
        classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
        classpath "com.github.jengelman.gradle.plugins:shadow:$shadow_version" // 添加shadow插件依赖
    }
}

2. 应用application和shadow插件，并指定主类：

apply plugin: 'java'
apply plugin: 'kotlin'
apply plugin: 'application' // 应用application插件
apply plugin: 'com.github.johnrengelman.shadow' // 应用shadow插件

mainClassName = "routing.MainKt" // 指定主类路径

3. 移除原来的jar任务配置，用shadowJar任务代替（shadow插件会自动处理依赖打包）。

4. 执行打包命令：

./gradlew clean shadowJar

生成的可执行JAR会在build/libs目录下，文件名通常是[项目名]-all.jar，直接运行这个JAR即可：

java -jar build/libs/[项目名]-all.jar

方案2：修复原有jar任务配置 #

如果你不想引入新插件，可以修改jar任务的依赖收集逻辑，用configurations.runtimeClasspath代替configurations.compile：

jar {
    manifest {
        attributes 'Main-Class': "routing.MainKt"
    }
    // 替换为runtimeClasspath，包含所有运行时需要的依赖
    from { configurations.runtimeClasspath.collect { it.isDirectory() ? it : zipTree(it) } }
    // 避免重复打包META-INF文件
    duplicatesStrategy = DuplicatesStrategy.EXCLUDE
}

然后重新构建：

./gradlew clean build

运行生成的JAR文件测试。

验证步骤 #

1. 执行./gradlew clean build（或shadowJar）重新构建项目
2. 用jar tf build/libs/[你的JAR文件名].jar再次确认routing/MainKt.class存在
3. 执行java -jar build/libs/[你的JAR文件名].jar测试运行效果

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