如何编写兼容有无AnsiColor插件环境的Jenkinsfile

实现逻辑 #

运行时动态检测当前Jenkins主机是否安装AnsiColor插件：

• 插件存在时，正常使用ansiColor步骤包裹流水线逻辑，启用xterm格式彩色输出
• 插件缺失时，直接执行原有流水线逻辑，不触发ansiColor相关调用，避免抛出NoSuchMethodError错误

推荐实现（无额外权限要求） #

使用闭包封装包装逻辑，通过异常捕获实现自动降级，不需要管理员修改脚本安全审批配置，跨主机兼容性最好：

// 定义兼容包装方法
def withAnsiColorIfSupported(String colorConfig = 'xterm', Closure pipelineLogic) {
    try {
        // 插件已安装时正常启用彩色输出
        ansiColor(colorConfig) {
            pipelineLogic.call()
        }
    } catch (NoSuchMethodError ignore) {
        // 插件不存在时直接执行业务逻辑，打印提示
        echo "[提示] 当前主机未安装AnsiColor插件，跳过彩色控制台输出配置"
        pipelineLogic.call()
    }
}

// 原有流水线逻辑，用自定义包装方法替换直接的ansiColor调用
withAnsiColorIfSupported('xterm') {
    withFolderProperties{
        env.getEnvironment()

        def nodelabel
        try{ nodelabel="${env.CCEBUILD_NODE}" } catch (e) { }
        if (nodelabel == "null" || nodelabel == null) { nodelabel = "devts" }

        // 原有业务逻辑省略

        node("${nodelabel}") {

            stage('Info') {
                dir("${applroot}") {
                    callAnt(antbaseparameters, "info")
                }
            }

            // 原有阶段逻辑省略

        } // node("${nodelabel}")

    } // withFolderProperties
}

可选实现（提前判断插件状态） #

如果持有Jenkins管理员权限，可以调整脚本安全配置，提前检测插件安装状态，避免异常捕获的开销：

1. 先在Jenkins管理后台「脚本安全」页面，放行以下方法签名：
   • jenkins.model.Jenkins getInstance
   • hudson.PluginManager getPlugin java.lang.String
2. 使用如下包装逻辑：

def withAnsiColorIfSupported(String colorConfig = 'xterm', Closure pipelineLogic) {
    def ansiColorPlugin = Jenkins.instance.pluginManager.getPlugin('ansicolor')
    if (ansiColorPlugin && ansiColorPlugin.isActive()) {
        ansiColor(colorConfig) {
            pipelineLogic.call()
        }
    } else {
        echo "[提示] 当前主机未安装或未启用AnsiColor插件，跳过彩色控制台输出配置"
        pipelineLogic.call()
    }
}

// 后续流水线逻辑和上述示例完全一致

注意事项 #

• 禁止在流水线顶层直接调用ansiColor方法：Jenkins在解析流水线脚本阶段就会校验DSL方法是否存在，直接调用会在脚本解析阶段直接报错，无法走到后续判断逻辑
• 异常捕获的实现方案适配所有权限场景，不需要修改Jenkins全局配置，是多主机构建场景下的首选方案

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