Jenkins 进阶：流水线基础语法

用心去追梦

于 2024-05-24 10:22:01 发布

阅读量250

点赞数 3

文章标签：自动化部署 java

本文链接：https://blog.csdn.net/qq_33240556/article/details/139167909

版权

Jenkins 是一个广泛使用的持续集成和持续交付（CI/CD）工具，它的流水线（Pipeline）特性允许用户定义代码的方式来实现自动化构建、测试和部署的过程。Jenkins Pipeline 通过一套称为Jenkinsfile的脚本定义，使用 Groovy 语言编写。这里简要介绍一些 Jenkins Pipeline 的基础语法元素，帮助你进阶掌握 Jenkins 流水线的编写。

1. 定义 Pipeline

一个基本的 Jenkins Pipeline 可以直接在 Jenkins UI 中创建，但推荐的方式是将 Pipeline 定义在项目的源代码仓库中，通常是名为 Jenkinsfile 的文件。

2. Pipeline 语法结构

Jenkins Pipeline 脚本主要分为两种语法风格：声明式 和 脚本化。现代实践中更倾向于使用声明式，因为它更易读且易于维护。

声明式示例：

pipeline {
    agent any // 指定运行环境，默认任何可用节点
    stages { // 定义阶段
        stage('Build') { // 阶段名称
            steps { // 步骤
                echo 'Building...'
                sh 'mvn clean install' // 执行shell命令
            }
        }
        stage('Test') {
            steps {
                echo 'Testing...'
                junit 'target/surefire-reports/*.xml' // 发布测试结果
            }
        }
        stage('Deploy') {
            steps {
                echo 'Deploying...'
                // 部署逻辑
            }
        }
    }
    post { // 阶段后操作
        always { // 无论成功或失败都会执行
            echo 'This will always run'
        }
        success { 
            mail to: 'dev-team@example.com', subject: 'Jenkins Build Succeeded' 
        }
    }
}

3. 关键元素解释

pipeline: 标记 Pipeline 的开始。
agent: 指定执行 Pipeline 的环境，如 any 表示任何可用节点，none 表示无代理执行，或指定特定标签的节点如 label 'my-node'。
stages: 包含一系列的阶段（stage），每个阶段代表 CI/CD 流程中的一个步骤。
stage: 定义单个阶段，需要给阶段命名，并包含步骤（steps）。
steps: 在某个阶段内执行的一系列命令或操作。
echo: 输出信息到日志。
sh: 执行 shell 命令。
post: 定义在 Pipeline 结束后的动作，可包含多个条件分支，如 success, failure, always 等。
mail: 发送邮件通知。

4. 参数化 Pipeline

可以通过 parameters 在 Pipeline 开头定义参数，使 Pipeline 变得更加灵活和可配置。

parameters {
    string(name: 'BRANCH', defaultValue: 'master', description: 'Branch to build')
    booleanParam(name: 'DEPLOY_TO_PROD', defaultValue: false, description: 'Deploy to production environment')
}

然后在 Pipeline 内部使用 ${params.BRANCH} 或 ${params.DEPLOY_TO_PROD} 引用这些参数。

5. 使用共享库

为了复用 Pipeline 脚本和促进更好的代码管理，Jenkins 支持使用共享库（Shared Libraries）。你可以创建一个包含常用函数和 Pipeline 模块的 Git 仓库，并在 Jenkins 中配置引用它。

@Library('my-shared-library') _
pipeline {
    // ...
    stages {
        stage('Custom Step') {
            steps {
                myCustomStep()
            }
        }
    }
}