1. 概述
Jenkins 流水线（Pipeline）已成为自动化软件交付流程中不可或缺的工具。在传统的 Jenkins 流水线中，我们通常定义的是静态阶段（stage），这些阶段在每次构建中保持不变。但随着项目复杂度的提升，我们常常需要流水线能根据不同的构建上下文动态调整结构和行为。
动态阶段（Dynamic Stages）允许我们根据 Git 分支、配置文件甚至外部输入等条件，在运行时动态生成阶段。这使得流水线更加灵活、可复用和易于维护。
在本文中，我们将学习如何在 Jenkins 流水线中实现动态阶段。
2. Jenkins 流水线基础
在深入了解动态阶段之前，我们先来回顾一下 Jenkins 流水线的基本结构和概念。
2.1. 基本结构
Jenkins 流水线通常定义在一个名为 Jenkinsfile 的文件中，这个文件一般存放在项目的源码仓库中。它基于 Groovy 语言的 DSL（领域特定语言）编写。
一个最基础的流水线结构如下所示：
pipeline {
agent any
stages {
stage('Build') {
steps {
echo 'Building the project...'
}
}
stage('Test') {
steps {
echo 'Running tests...'
}
}
stage('Deploy') {
steps {
echo 'Deploying the application...'
}
}
}
}
上面的示例中定义了三个阶段：
- Build
- Test
- Deploy
每个阶段只有一个 echo 步骤，用于输出信息。
2.2. 静态阶段 vs 动态阶段
- 静态阶段：在流水线运行前就已定义好，结构固定，适用于流程简单、变化少的场景。
- 动态阶段：在运行时根据条件或输入动态生成，具备更高的灵活性和可维护性。
例如，我们可以根据当前 Git 分支、测试类型或部署环境动态生成阶段。
3. 环境准备
在开始编写动态阶段之前，我们需要确保 Jenkins 环境已正确配置。
3.1. Jenkins 安装与配置
首先，确保 Jenkins 已安装并运行。如果没有安装，可以从 Jenkins 官网下载并根据操作系统安装指南进行部署。
安装完成后，访问 Jenkins 控制台，并使用管理员账号或具有足够权限的用户登录。
3.2. 必要插件
为了支持动态阶段的开发，需要安装以下插件：
- Pipeline
- Pipeline: Stage View
- Git（如果使用 Git 仓库）
进入 Jenkins 控制台 ➔ Manage Jenkins ➔ Manage Plugins ➔ Available 标签页，搜索并安装上述插件。安装完成后重启 Jenkins。
3.3. 验证安装
创建一个简单的流水线项目，配置如下内容：
pipeline {
agent any
stages {
stage('Test Setup') {
steps {
echo 'Our Jenkins pipeline setup is working!'
}
}
}
}
执行后如果能看到成功输出，则说明环境配置正确。
4. 创建动态阶段
动态阶段的核心思想是：在运行时根据条件或输入动态生成流水线结构。
4.1. 使用 Groovy 脚本生成阶段
Groovy 提供了强大的脚本能力，我们可以基于列表、条件判断等方式动态生成阶段。
示例：根据环境列表动态生成部署阶段：
def environments = ['dev', 'qa', 'staging', 'production']
pipeline {
agent any
stages {
stage('Dynamic Deployment') {
steps {
script {
environments.each { env ->
stage("Deploy to ${env}") {
echo "Deploying to ${env} environment"
}
}
}
}
}
}
}
上面代码中，我们遍历 environments 列表，为每个环境生成一个 stage。这样，后续只需修改列表即可增删部署环境，无需修改 pipeline 结构。
4.2. 使用 Jenkins DSL 动态生成并行阶段
Jenkins 提供了 parallel 语法用于并行执行多个 stage。我们也可以结合 Groovy 脚本动态生成这些并行阶段。
示例：读取配置文件动态生成测试阶段：
def testTypes = readYaml file: 'test-config.yaml'
pipeline {
agent any
stages {
stage('Parallel Tests') {
steps {
script {
def parallelStages = [:]
testTypes.each { test ->
parallelStages["${test.name}"] = {
echo "Running ${test.name}..."
// Add actual test execution here
}
}
parallel parallelStages
}
}
}
}
}
其中 test-config.yaml 文件内容如下：
- name: Unit Tests
- name: Integration Tests
- name: UI Tests
这样，我们就可以根据配置文件动态生成并行执行的测试阶段。
5. 常见使用场景
接下来我们通过几个实际场景来演示动态阶段的典型应用。
5.1. 根据 Git 分支生成阶段
不同分支（如 main、feature/xxx、hotfix/xxx）通常对应不同的构建流程。我们可以根据当前分支动态生成阶段。
pipeline {
agent any
stages {
stage('Determine Build Type') {
steps {
script {
if (env.BRANCH_NAME == 'main') {
stage('Production Build') {
echo 'Building for production...'
}
stage('Deploy to Production') {
echo 'Deploying to production...'
}
} else if (env.BRANCH_NAME.startsWith('feature/')) {
stage('Feature Build') {
echo 'Building feature...'
}
stage('Deploy to Dev') {
echo 'Deploying to dev environment...'
}
} else if (env.BRANCH_NAME.startsWith('hotfix/')) {
stage('Hotfix Build') {
echo 'Building hotfix...'
}
stage('Deploy to Staging') {
echo 'Deploying to staging for urgent testing...'
}
}
}
}
}
}
}
✅ 踩坑提醒：记得使用 env.BRANCH_NAME 获取分支名，而不是 env.GIT_BRANCH，后者可能包含远程分支前缀如 origin/。
5.2. 从配置文件生成阶段
将阶段信息放在外部配置文件中，可以避免频繁修改 Jenkinsfile，也便于非开发人员调整流程。
例如，build-config.yaml：
steps:
- name: Compile
command: mvn compile
- name: Test
command: mvn test
- name: Package
command: mvn package
Jenkinsfile 动态读取并生成阶段：
def buildConfig = readYaml file: 'build-config.yaml'
pipeline {
agent any
stages {
stage('Build') {
steps {
script {
buildConfig.steps.each { step ->
stage(step.name) {
sh step.command
}
}
}
}
}
}
}
这种方式非常适合需要频繁调整构建步骤的场景。
5.3. 动态并行阶段
当多个测试套件或任务可以并行执行时，动态生成并行阶段可以显著提升构建效率。
示例：
def testSuites = ['unit', 'integration', 'e2e']
pipeline {
agent any
stages {
stage('Parallel Tests') {
steps {
script {
def parallelStages = testSuites.collectEntries {
["${it.capitalize()} Tests" : {
stage("Running ${it} tests") {
echo "Executing ${it} test suite..."
// Add actual test execution here
}
}]
}
parallel parallelStages
}
}
}
}
}
该示例动态生成三个并行测试阶段，便于后续扩展。
6. 小结
本文介绍了 Jenkins 流水线中动态阶段的概念和实现方式：
- 通过 Groovy 脚本动态生成阶段，实现灵活的构建流程
- 利用 Jenkins DSL 结合 Groovy 实现并行阶段
- 结合实际场景，如 Git 分支识别、配置文件驱动、并行测试等，展示了动态阶段的强大能力
通过合理使用动态阶段，我们可以让 Jenkins 流水线更加灵活、可维护，并适应复杂多变的项目需求。