Jenkins脚本如何处理构建失败通知

wen 实用脚本 2026-07-14 3

本文目录导读：

Jenkins脚本如何处理构建失败通知

核心思路：post 块
发送邮件通知（最常用）
发送即时通讯通知（Slack / 钉钉 / 企业微信）
处理失败重试（自愈机制）
根据不同失败原因执行不同逻辑
全局默认通知（减少重复代码）
最佳实践与注意事项

在Jenkins中,处理构建失败通知有多种方式，从简单的邮件通知到复杂的多渠道告警（如钉钉、Slack、企业微信等），以下是几种常见的处理方案及其在Jenkins Pipeline脚本（Declarative 或 Scripted）中的实现方式。

核心思路：`post` 块

在Declarative Pipeline中，最推荐的方式是使用 post 块，它能在构建的各个阶段（如成功、失败、不稳定）自动触发相应逻辑。

示例：基础邮件通知

pipeline {
    agent any
    stages {
        stage('Build') {
            steps {
                echo '执行构建...'
                // 假设这里有一个会失败的步骤
                // sh 'exit 1'
            }
        }
    }
    post {
        failure {
            // 构建失败时执行
            script {
                // 方式一：发送标准邮件
                mail to: 'team@example.com',
                     subject: "构建失败: ${env.JOB_NAME} - ${env.BUILD_NUMBER}",
                     body: "项目 ${env.JOB_NAME} 构建失败。\n\n请查看：${env.BUILD_URL}"
            }
        }
        success {
            echo '构建成功！'
        }
        always {
            // 无论成功或失败都执行
            cleanWs() // 清理工作空间
        }
    }
}

发送邮件通知（最常用）

Jenkins内置了邮件插件（Jenkins Mail Plugin）和Email Extension Plugin（推荐）。

使用Email Extension Plugin（更灵活）：

需要先在“系统管理” -> “系统配置”中配置SMTP服务器和默认发件人。

pipeline {
    // ... 其他配置
    post {
        failure {
            emailext(
                to: 'admin@example.com, developer@example.com',
                subject: "构建失败: ${env.JOB_NAME} - ${env.BUILD_NUMBER}",
                body: """
                    <h2>❌ 构建失败通知</h2>
                    <p>项目: ${env.JOB_NAME}</p>
                    <p>构建编号: ${env.BUILD_NUMBER}</p>
                    <p>构建日志: <a href="${env.BUILD_URL}console">点击查看</a></p>
                    <p>变更集: ${env.CHANGE_URL}</p>
                    <hr>
                    <p>请相关开发人员及时处理。</p>
                """,
                mimeType: 'text/html',
                attachLog: true // 是否附加构建日志
            )
        }
    }
}

发送即时通讯通知（Slack / 钉钉 / 企业微信）

这些通常通过第三方插件或HTTP API实现。

示例：Slack 通知（需要安装 Slack Plugin）

pipeline {
    // ...
    post {
        failure {
            slackSend(
                channel: '#jenkins-alerts',
                color: 'danger',
                message: "构建失败: ${env.JOB_NAME} #${env.BUILD_NUMBER}\n<${env.BUILD_URL}|查看构建详情>"
            )
        }
    }
}

示例：钉钉/企业微信（通过 `httpRequest` 插件或 `curl`）

post {
    failure {
        script {
            def webhookUrl = 'https://oapi.dingtalk.com/robot/send?access_token=YOUR_TOKEN'
            def message = "构建失败: ${env.JOB_NAME} #${env.BUILD_NUMBER}\n请查看: ${env.BUILD_URL}"
            httpRequest(
                url: webhookUrl,
                contentType: 'APPLICATION_JSON',
                httpMode: 'POST',
                requestBody: groovy.json.JsonOutput.toJson(
                    msgtype: 'text',
                    text: [content: message]
                )
            )
        }
    }
}

处理失败重试（自愈机制）

有时失败是临时的（如网络超时），可以在脚本中自动重试。

pipeline {
    agent any
    stages {
        stage('Deploy') {
            retry(3) { // 最多重试3次
                sh './deploy.sh'
            }
        }
    }
    post {
        failure {
            echo "部署步骤在重试后仍然失败"
            // 发送严重告警
        }
    }
}

根据不同失败原因执行不同逻辑

通过 catchError 或 script 块内的异常捕获，实现精细化通知。

stage('Test') {
    steps {
        script {
            try {
                sh './run_tests.sh'
            } catch (Exception e) {
                // 获取具体错误信息
                currentBuild.result = 'FAILURE'
                echo "测试失败原因: ${e.message}"
                // 根据失败类型发送不同通知
                if (e.message.contains('timeout')) {
                    slackSend(channel: '#infra', message: "测试超时，请检查服务器负载。")
                } else {
                    slackSend(channel: '#dev-team', message: "单元测试失败。")
                }
                error("Test failed: ${e.message}") // 继续向上传播失败状态
            }
        }
    }
}

全局默认通知（减少重复代码）

如果每个流水线都要写通知逻辑,可以使用共享库或全局变量。

示例：vars/sendNotification.groovy

// 在 vars/sendNotification.groovy 中
def call(String status) {
    if (status == 'FAILURE') {
        emailext(
            to: 'admin@example.com',
            subject: "构建失败: ${env.JOB_NAME} - #${env.BUILD_NUMBER}",
            body: "请检查: ${env.BUILD_URL}"
        )
    }
}

然后在Pipeline中只需：

post {
    failure { sendNotification('FAILURE') }
    success { sendNotification('SUCCESS') }
}

最佳实践与注意事项

关注点	建议
凭证安全	不要在脚本中硬编码Token、密码，使用Jenkins Credentials Binding插件（`withCredentials`）。
通知频率	结合 `when` 条件控制通知（例如仅在分支 `main` 或 `release` 失败时发告警）。
日志冗余	防止大量失败导致重复告警淹没收件箱，可以考虑设置“静默期”或基于时间窗口的聚合通知。
测试	使用 `snippet generator`（Pipeline Syntax）生成 `emailext` 或 `httpRequest` 的代码片段。