如何在Jenkinsfile中获取Java类抛出的真实异常并控制流水线状态

问题描述 #

我在Jenkins流水线中调用一个Java主类，希望根据主类抛出的异常决定流水线的成功或失败状态。尝试了以下代码：

script{
 try{
  sh ' mvn exec:java -Dexec.mainClass="com.test.Deployer" -Dexec.args="qal"'
 }catch (Exception e) {
  echo 'exception::' + e.toString()
  echo 'message::' + e.getMessage()
  echo 'cause::' + e.getCause()
  if (e.toString().contains("NoChangeDetectedException")) {
   currentBuild.result = 'SUCCESS'
   return
  }
 }
}

但从Jenkins日志中发现，Java类抛出的原始异常并未被传递过来，日志显示：

An exception occured while executing the Java class. null: InvocationTargetException:
exception:: hudson.AbortException: script returned exit code 1
message:: script returned exit code 1
cause:: null

请问是否可以在Jenkinsfile中获取到Java类抛出的真实异常消息？注：我们的流水线不允许使用getStackTrace方法。

解决方案 #

问题出在Jenkins的sh步骤行为上：当Maven命令返回非0退出码时，sh会抛出hudson.AbortException，这个异常只携带了退出码信息，不会包含Java主类抛出的真实异常细节——这些细节其实在Maven命令的控制台输出里。

要获取真实异常信息，你需要调整两个地方：让Maven输出完整的异常内容，然后在流水线中捕获并解析这个输出。

完整实现代码

script {
    def exitCode
    def mvnOutput

    // 执行Maven命令，同时捕获输出和退出码
    // 添加-e参数让Maven强制输出完整的异常堆栈信息
    mvnOutput = sh(
        script: 'mvn exec:java -Dexec.mainClass="com.test.Deployer" -Dexec.args="qal" -e',
        returnStdout: true,
        returnStatus: true
    )

    // 从输出中提取异常信息（这里直接检查是否包含目标异常类名）
    if (mvnOutput.contains("NoChangeDetectedException")) {
        currentBuild.result = 'SUCCESS'
        echo "检测到预期的NoChangeDetectedException，标记构建为成功"
    } else if (exitCode != 0) {
        // 其他非预期的失败，标记构建为失败并抛出错误终止流水线
        currentBuild.result = 'FAILURE'
        error "Maven执行失败，详细输出：${mvnOutput}"
    } else {
        // 执行成功，保持默认的SUCCESS状态
        currentBuild.result = 'SUCCESS'
    }
}

关键说明

1. Maven参数-e：这个参数会强制Maven在执行失败时输出完整的异常堆栈信息，确保Java主类抛出的异常类名和消息会被打印到控制台。
2. Jenkins sh步骤参数：
   • returnStdout: true：让sh步骤返回命令的控制台输出内容，方便我们自己解析异常信息。
   • returnStatus: true：让sh步骤返回命令的退出码，而不是抛出异常——这样我们可以完全控制失败后的处理逻辑，避免被AbortException打断。
3. 解析输出：直接检查输出字符串中是否包含目标异常类名（比如NoChangeDetectedException），因为Maven会把Java抛出的异常完整打印在输出里，这样就能准确识别出我们预期的异常类型。

这样处理后，你就能精准捕获Java主类抛出的真实异常信息，进而正确设置流水线的状态了。

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