Jenkins全链路教程——条件判断与流程控制
在Jenkins流水线(Pipeline)中,“动态控制流程”是实现灵活部署、精准测试的核心能力。无论是“仅生产环境执行部署”,还是“合并请求(PR)触发时跳过集成测试”,都需要用到条件判断与流程控制。
今天我们就来拆解Jenkins最常用的两种工具:声明式的when
指令和脚本式的script
块。
一、when与script的核心逻辑
Jenkins Pipeline支持两种主流语法:声明式(Declarative)和脚本式(Scripted)。对应的条件判断工具也不同:
•
when
是声明式Pipeline的“条件控制员”,语法简洁,适合简单规则;•
script
是脚本式Pipeline的“逻辑全能手”,支持复杂表达式,适合动态计算。
1.1when
指令:声明式的“条件开关”
when
是声明式Pipeline的专用条件块,直接写在stage
中,通过预定义的条件类型(如环境变量、分支名、参数值)控制当前阶段是否执行。
核心特点:
• 语法固定,仅支持Jenkins预定义的条件类型(如
environment
、branch
、expression
等);• 适合“是否执行某阶段”的简单判断(如“当分支是
main
时执行部署”);• 条件不满足时,阶段直接跳过(日志显示
Stage skipped
)。
1.2 script
块:脚本式的“逻辑引擎”
script
是脚本式Pipeline的核心语法,也可嵌入声明式Pipeline中,通过Groovy脚本实现复杂逻辑(如多条件组合、动态计算变量、调用API等)。
核心特点:
• 支持完整的Groovy语法(如
if-else
、循环、函数调用);• 适合“根据动态计算结果决定流程”的复杂场景(如“当测试通过率>90%时继续部署”);
• 需注意:在声明式Pipeline中,
script
需包裹在steps
里,避免语法错误。
二、从简单条件到复杂逻辑
🌰 场景1:用when
实现基础条件判断(声明式Pipeline)
假设我们有一个“前端项目发布”流水线,需要根据以下规则控制阶段执行:
• 仅
main
分支触发时,执行生产部署;• 非
main
分支(如开发分支)触发时,执行测试验证;• 参数
SKIP_TEST
为true
时,跳过测试阶段。
示例代码(可直接复制到Jenkins运行):
pipeline {agent anyparameters {booleanParam(name:'SKIP_TEST', defaultValue:false, description:'是否跳过测试?')}stages {// 通用构建阶段stage('代码构建') {steps {echo "🔧 开始构建项目..."echo '模拟:npm install && npm run build'// 伪命令}}// 条件部署阶段stage('生产部署') {when { branch 'main'// 仅 main 分支触发}steps {echo "🚀 触发生产环境部署!"echo '模拟:scp -r dist/* prod-server:/var/www'}}// 条件测试阶段stage('测试验证') {when { allOf { not { branch 'main' } // 非 main 分支expression { params.SKIP_TEST != true } // 未跳过测试}}steps {echo "🧪 执行测试验证..."echo '模拟:npm run test'}}}
}
关键说明:
•
branch 'main'
:匹配分支名为main
的触发;•
not { branch 'main' }
:反向匹配(非main
分支);•
allOf
:多条件“与”关系(需同时满足);•
environment
:匹配参数/环境变量值(SKIP_TEST
是参数,本质也是环境变量)。
不选择跳过测试,执行结果如下
选择跳过测试,执行结果如下
🌰 场景2:用script
实现复杂逻辑控制(声明式+脚本混合)
假设需要根据“测试用例通过率”动态决定是否继续部署(如通过率>90%才允许上线),这种需要动态计算的场景,script
是更合适的选择。
示例代码:
pipeline {agent anystages {stage('执行测试') {steps {script {// 模拟测试结果(实际从测试报告解析)def passRate = 95// 假设通过率95%env.TEST_PASS_RATE = passRate.toString() // 保存到环境变量echo "① 测试完成,通过率:${passRate}%"}}}stage('决定是否部署') {steps {script {if (env.TEST_PASS_RATE.toInteger() > 90) {echo "② 测试通过,准备部署~"// 执行部署操作(示例用echo代替)sh 'echo "开始部署..."'} else {error "③ 测试不通过(通过率仅${env.TEST_PASS_RATE}%),终止流水线!"}}}}}
}
关键说明:
•
script
块内使用Groovy语法(如if-else
、变量转换);•
error
函数会直接终止流水线,并标记为失败;• 可结合外部工具(如JUnit测试报告解析)获取真实通过率(需用
junit
步骤解析报告)。
例如:passRate = 95
例如:passRate = 85
🌰 场景3:when
与script
的混合使用
如果需要在声明式Pipeline中使用更灵活的条件(如动态计算的布尔值),可以用when
的expression
子句调用script
块。
示例代码:
pipeline {agent anystages {stage('动态条件判断') {when {expression {// 用script动态计算条件(如检查当前时间是否为工作日)def dayOfWeek = new Date().getDay() // 0=周日,1=周一...6=周六return dayOfWeek >= 1 && dayOfWeek <= 5// 1-5是工作日(周一到周五)}}steps {echo "① 当前是工作日,执行任务~"}}}
}
三、六大避坑指南 ⚠️
- 1.
when
时效性问题when
的条件在流水线启动时解析,无法获取steps
中动态生成的环境变量(如测试通过率)。这种情况需用script
在steps
内判断。// 错误示范:when 无法获取 steps 生成的变量 stage('动态变量') {when { environment name: 'DYNAMIC_VAR' } // 永远为 falsesteps { script { env.DYNAMIC_VAR = 'value' } } }// 正确方案:改用 script 判断 stage('动态判断') {steps {script {if (env.DYNAMIC_VAR) { ... }}} }
- 2. 条件组合技巧
when
仅支持Jenkins预定义的条件(如branch
、environment
、expression
),不支持直接写if
语句。复杂条件需用allOf
(与)、anyOf
(或)、not
(非)组合。when {// AND 关系:需同时满足allOf { branch 'main'environment name: 'DEPLOY_ENV', value: 'prod'}// OR 关系:满足其一anyOf {triggeredBy 'SCMTrigger'triggeredBy 'TimerTrigger'} }
- 3. 敏感操作保护
Groovy 脚本中未处理的异常会导致整个流水线立即中断,对于高风险操作(如生产环境部署、数据删除等),需通过异常捕获实现"柔性失败"。
script {try {sh '高风险命令'} catch (Exception e) {echo "⚠️ 捕获异常: ${e}"currentBuild.result = 'UNSTABLE' // 不中断流水线} }
- 4. 跳过阶段日志增强
条件不满足时,
when
会跳过阶段并在日志中提示Stage skipped
,建议添加echo
说明原因(如在post
阶段记录)。post {aborted {echo "⏩ 跳过原因: 分支=${env.BRANCH_NAME}, SKIP_TEST=${params.SKIP_TEST}"} }
- 5. 参数类型陷阱
Jenkins 参数在 Groovy 和 Shell 环境中类型不一致:
环境
布尔参数类型
数字参数类型
Groovy (
params
)boolean
Integer
Shell (
env
)String
String
// 布尔参数需转换比较 expression { params.SKIP_TEST == true } // 正确 expression { env.SKIP_TEST == 'true' } // 错误!
- 6. 脚本性能优化
script
块中避免写耗时操作(如循环查询数据库),可能导致流水线卡住。// 避免在 script 中执行耗时操作 script {def result = readFile('report.json') // 小文件可行// 避免:连接数据库查询 }
四、工具选型速查表
场景 | 推荐方案 | 示例 |
根据分支/参数跳过阶段 | when | branch 'main' |
多条件组合判断 | when+allOf/anyOf | allOf { branch; environment } |
动态计算(如测试通过率) | script | if (passRate > 90) {...} |
调用外部 API 或复杂计算 | script | def data = httpRequest ... |
流程中断控制 | script | error() / currentBuild.result |
掌握when
和script
的用法后,你可以根据实际需求灵活控制流水线流程,避免无效执行、降低资源消耗~