当前位置：首页 > article >正文

Jenkins Pipeline 语法使用说明文档

article 2025/3/27 14:09:31

Pipeline 概述

Jenkins Pipeline 是一种通过代码定义 CI/CD 流程的框架，将构建、测试、部署等阶段以脚本形式描述。其核心特性包括：

代码即流程（Pipeline as Code）：流程定义存储在 Jenkinsfile 中，与项目代码一起版本化。
可扩展性：支持复杂的逻辑（如并行执行、条件分支）。
可视化：Jenkins 提供 Pipeline 运行状态的图形化展示。

Pipeline 语法类型

Jenkins Pipeline 支持两种语法风格：

声明式 Pipeline（Declarative Pipeline）

特点：结构化、易读，适合简单或标准化的流程。
语法规则：
- 必须包含 pipeline 块。
- 使用预定义的关键字（如 agent、stages、steps）。

脚本式 Pipeline（Scripted Pipeline）

特点：基于 Groovy 的动态编程，灵活性高，适合复杂逻辑。
语法规则：
- 使用 node 块定义执行节点。
- 允许直接调用 Groovy 函数和逻辑控制语句。

核心语法与结构

声明式 Pipeline 基础结构

pipeline {  
    agent any  // 指定执行节点（any、label、docker等）  
    options {  
        timeout(time: 1, unit: 'HOURS')  // 超时设置  
    }  
    environment {  
        VERSION = "1.0.0"                // 定义环境变量  
    }  
    stages {  
        stage('Build') {  
            steps {  
                sh 'mvn clean package'    // 执行 Shell 命令  
            }  
        }  
        stage('Test') {  
            steps {  
                junit 'target/surefire-reports/*.xml'  // 测试报告收集  
            }  
        }  
    }  
    post {  
        always {  
            cleanWs()  // 清理工作空间  
        }  
    }  
}

脚本式 Pipeline 基础结构

node('linux') {  
    stage('Build') {  
        sh 'make all'  
    }  
    stage('Test') {  
        if (env.BRANCH_NAME == 'main') {  
            sh 'make test'  
        } else {  
            echo '跳过测试'  
        }  
    }  
}

常用指令与步骤

通用指令

指令	说明
`agent`	指定任务运行的节点（如 `agent { label 'docker' }`）。
`environment`	定义环境变量（如 `API_KEY = credentials('my-api-key')`）。
`options`	配置任务选项（如超时、重试次数）。
`parameters`	定义用户输入参数（如 `string(name: 'VERSION', defaultValue: '1.0')`）。
`triggers`	设置触发条件（如定时构建、Git 事件）。

步骤（Steps）

步骤	说明
`sh` / `bat`	执行 Shell 或 Windows Batch 命令。
`script`	在声明式 Pipeline 中嵌入脚本式语法。
`parallel`	并行执行多个阶段（仅声明式 Pipeline 支持）。
`input`	暂停 Pipeline 等待用户确认。
`withCredentials`	安全使用 Jenkins 凭证（如密码、API 密钥）。

实际使用场景与示例

场景 1：多环境部署

需求：根据分支自动部署到测试/生产环境。

pipeline {  
    agent any  
    parameters {  
        choice(name: 'ENV', choices: ['dev', 'prod'], description: '选择部署环境')  
    }  
    stages {  
        stage('Deploy') {  
            steps {  
                script {  
                    if (params.ENV == 'prod') {  
                        withCredentials([string(credentialsId: 'prod-key', variable: 'API_KEY')]) {  
                            sh "./deploy.sh --env prod --key $API_KEY"  
                        }  
                    } else {  
                        sh "./deploy.sh --env dev"  
                    }  
                }  
            }  
        }  
    }  
}

场景 2：并行测试

需求：并行执行单元测试和集成测试。

pipeline {  
    agent any  
    stages {  
        stage('Test') {  
            parallel {  
                stage('Unit Test') {  
                    steps { sh 'mvn test' }  
                }  
                stage('Integration Test') {  
                    steps { sh 'mvn verify' }  
                }  
            }  
        }  
    }  
}

场景 3：动态选择节点

需求：根据任务类型选择不同的 Jenkins 节点。

pipeline {  
    agent none  
    stages {  
        stage('Build on Linux') {  
            agent { label 'linux' }  
            steps { sh 'make build' }  
        }  
        stage('Test on Windows') {  
            agent { label 'windows' }  
            steps { bat 'run-tests.bat' }  
        }  
    }  
}