Jenkins Pipeline 语法：初学者的全面指南

Jenkins 是一个强大的开源自动化服务器，广泛用于持续集成和持续交付 (CI/CD) 工作流。 Jenkins 的核心是利用流水线来定义、调度和自动化复杂的软件交付流程。了解 Jenkins 流水线语法对于任何希望有效利用 Jenkins 来满足其 CI/CD 需求的人来说都至关重要。本指南为初学者提供了 Jenkins 流水线语法的入门介绍，涵盖了其基本组成部分、常见结构和最佳实践，以帮助您构建健壮高效的流水线。

本文旨在揭开 Jenkins 流水线语法的神秘面纱，提供清晰的解释和实际示例。我们将探讨两种主要语法——声明式 (Declarative) 和脚本式 (Scripted)，并指导您构建第一个流水线。完成本指南后，您将为在 Jenkins 中创建和管理 CI/CD 流程奠定坚实的基础。

理解 Jenkins 流水线

Jenkins 流水线是一套插件，支持将 CI/CD 流水线集成到 Jenkins 中。它允许您将构建、测试和部署流程定义为代码，使其可版本化、可重复且透明。流水线可能很复杂，涉及多个阶段、条件逻辑以及与各种工具的集成。用于定义这些流水线的语法对于其成功实施至关重要。

声明式 vs. 脚本式流水线

Jenkins 提供了两种主要的流水线定义语法：

声明式流水线 (Declarative Pipeline): 这是一种更结构化、更具指导性的语法，提供了更高级别的抽象。它提供了更简单、更易读、更易于维护的语法，尤其适用于常见的 CI/CD 用例。对于初学者，通常推荐使用声明式流水线。
脚本式流水线 (Scripted Pipeline): 这种语法更灵活、更强大，使用 Groovy 脚本。它提供了更大的控制力，并允许复杂的逻辑，但对于不熟悉 Groovy 或 Jenkins 流水线脚本的初学者来说，学习和维护可能更具挑战性。

本指南将主要关注声明式流水线语法，因为它易于使用且适合初学者，同时也会在相关时提及脚本式流水线概念。

声明式流水线语法要点

声明式流水线在您的 Jenkinsfile（一个定义流水线的，通常检入源代码控制存储库的文件）的 pipeline {} 块中定义。结构是分层的，易于理解。

`pipeline` 块

每个声明式流水线都以 pipeline {} 块开始。

pipeline {
    // 流水线配置在此处
}

`agent` 指令

agent 指令指定流水线或特定阶段将在何处执行。这可以是为整个流水线全局定义的代理，也可以是按阶段定义的。

agent any: 流水线可以在任何可用的 Jenkins 代理上运行。
agent { label 'my-agent-label' }: 流水线将在具有指定标签的代理上运行。
agent none: 没有全局代理被分配；必须在每个阶段指定代理。

示例:

pipeline {
    agent any
    stages {
        // ... 阶段将在此处
    }
}

`stages` 和 `stage` 块

stages 是一个或多个 stage 块的容器。每个 stage 代表流水线的一个独立部分，例如“构建”、“测试”或“部署”。一个 stage 必须至少包含一个 steps 块。

示例:

pipeline {
    agent any
    stages {
        stage('Build') {
            steps {
                // 构建步骤在此处
            }
        }
        stage('Test') {
            steps {
                // 测试步骤在此处
            }
        }
    }
}

`steps` 块

steps 块包含要执行的实际命令或操作。这些是您在阶段中的单个任务。

示例（在“Build”阶段内）：

steps {
    echo '正在编译应用程序...'
    sh 'mvn clean install'
}

此处，echo 显示消息，sh 执行 shell 命令（如 Maven 构建）。其他常用步骤包括 bat（用于 Windows 批处理命令）、git（用于 SCM 操作）和特定于插件的步骤。

`post` 操作

post 部分允许您定义流水线（或阶段）完成后要运行的操作，无论其成功与否。常见条件包括 always、success、failure、changed 和 unstable。

示例:

pipeline {
    agent any
    stages {
        stage('Build') {
            steps {
                echo '正在构建...'
            }
        }
    }
    post {
        always {
            echo '流水线已完成。'
        }
        success {
            echo '流水线成功！'
        }
        failure {
            echo '流水线失败。'
        }
    }
}

常见流水线结构和指令

除了基础知识之外，流水线通常还需要更高级的配置。

`environment` 变量

environment 指令设置可在流水线或阶段内使用的环境变量。

示例:

pipeline {
    agent any
    environment {
        APP_NAME = 'my-awesome-app'
        JAVA_HOME = '/usr/lib/jvm/java-11-openjdk-amd64'
    }
    stages {
        stage('Build') {
            steps {
                echo "正在构建 ${env.APP_NAME}"
                sh 'echo $JAVA_HOME'
            }
        }
    }
}

请注意，环境变量是如何使用 env. 前缀（例如 env.APP_NAME）访问的。

`options` 指令

options 指令允许您配置各种流水线特定设置，例如禁用 SCM 检出或设置超时。

示例:

pipeline {
    agent any
    options {
        timestamps()
        timeout(time: 1, unit: 'HOURS')
        disableConcurrentBuilds()
    }
    stages {
        // ...
    }
}

timestamps(): 在控制台输出中添加时间戳。
timeout(): 为整个流水线设置超时。
disableConcurrentBuilds(): 防止同一流水线的多个构建同时运行。

`parameters` 指令

此指令允许您定义用户在触发流水线运行时可以提供的参数，从而使您的流水线更加灵活。

示例:

pipeline {
    agent any
    parameters {
        string(name: 'BRANCH_NAME', defaultValue: 'main', description: '要构建的分支')
        booleanParam(name: 'TEST_ENABLED', defaultValue: true, description: '启用或禁用测试')
    }
    stages {
        stage('Checkout') {
            steps {
                echo "正在检出分支： ${params.BRANCH_NAME}"
                // checkout scm
            }
        }
        stage('Build') {
            when {
                expression { params.TEST_ENABLED == true }
            }
            steps {
                echo '正在运行启用测试的构建...'
                // build steps
            }
        }
    }
}

通过 params 对象访问参数（例如 params.BRANCH_NAME）。

`when` 指令

when 指令允许您根据各种条件有条件地执行阶段或步骤。

示例（使用分支名称）：

stage('Deploy to Staging') {
    when {
        branch 'develop'
    }
    steps {
        echo '正在部署到暂存环境...'
        // deployment script
    }
}

其他 when 条件包括 expression、changelog、equals、allOf、anyOf 和 noneOf。

脚本式流水线基础 (简述)

脚本式流水线使用 Groovy 编写，提供更命令式的编程风格。它们缺乏声明式流水线的严格结构，但提供了最大的灵活性。

示例:

node {
    stage('Build') {
        echo '正在构建...'
        sh 'mvn clean install'
    }
    stage('Test') {
        echo '正在测试...'
        sh 'mvn test'
    }
}

在此，node 类似于 agent，并且阶段是命令式定义的。脚本式流水线也可以通过在脚本块中使用 pipeline {} 来包含声明式语法功能，反之亦然。

Jenkins 流水线语法最佳实践

使用声明式以求简便: 对于大多数常见的 CI/CD 工作流，推荐使用声明式语法，因为它易于阅读和维护。
将流水线作为代码: 将您的 Jenkinsfile 与应用程序代码一起存储在您的源代码控制存储库中。
使用共享库: 对于复杂或重复的流水线逻辑，请考虑使用 Jenkins 共享库以促进可重用性和一致性。
模块化阶段: 将流水线分解为逻辑清晰、定义明确的阶段。
优雅地处理失败: 利用 post 操作确保即使流水线失败，清理或通知也能发生。
保护凭证: 使用 Jenkins 凭证管理敏感信息（密码、API 密钥），而不是将其硬编码。
明智地参数化: 对构建配置、部署目标或其他可能变化的变量使用参数。
版本控制一切: 将您的 Jenkinsfile 视为代码并进行版本控制。

结论

Jenkins 流水线语法，特别是声明式语法，提供了一种强大而灵活的方式来定义和自动化您的 CI/CD 流程。通过理解 pipeline、agent、stages、steps 和 post 操作等核心组件，您可以开始构建有效的流水线。随着您越来越熟悉，可以探索 environment、options、parameters 和 when 等指令来创建更复杂的工作流。记住要遵循最佳实践，以确保您的流水线健壮、可维护且安全。

祝您流水线愉快！