如何在Jenkins中使用JobDSL删除作业并执行清理代码？

嘿，这个需求我之前维护多分支JobDSL流水线的时候也碰到过，刚好有几个靠谱的方案可以分享给你：

方案一：先对比分支差异，再执行清理+删除 #

最直接的思路是先找出「已存在但对应分支已被删除」的作业，先跑清理逻辑再删除作业，完全在JobDSL脚本里就能实现：

// 第一步：获取当前Git仓库存在的分支（实际项目里可以用Git插件API自动拉取）
def activeBranches = ['main', 'feature/user-profile', 'bugfix/login-issue']
def jobNamePrefix = 'pipeline-'

// 第二步：获取Jenkins中已存在的、符合前缀的作业
def existingJobs = Jenkins.instance.items.findAll { 
    it.name.startsWith(jobNamePrefix) 
}

// 第三步：筛选出需要删除的作业（对应分支不在当前活跃列表里）
def jobsToCleanAndDelete = existingJobs.findAll { job ->
    def branchName = job.name.replace(jobNamePrefix, '')
    !activeBranches.contains(branchName)
}

// 第四步：先清理，再删除
jobsToCleanAndDelete.each { job ->
    def branchName = job.name.replace(jobNamePrefix, '')
    println "开始清理分支 ${branchName} 的相关资源..."
    
    // 这里写你的自定义清理逻辑，比如：
    // 1. 删除作业的工作空间目录
    def workspaceDir = new File(job.workspace)
    if (workspaceDir.exists()) {
        workspaceDir.deleteDir()
    }
    // 2. 调用外部API清理关联资源（比如测试环境、缓存）
    // 3. 记录清理日志到指定位置
    
    // 最后删除作业
    job.delete()
    println "已完成分支 ${branchName} 的清理与作业删除"
}

// 第五步：生成当前活跃分支对应的新作业
activeBranches.each { branch ->
    job("${jobNamePrefix}${branch}") {
        // 你的流水线配置（比如拉取分支、执行构建脚本等）
        scm {
            git {
                remote { url '你的Git仓库地址' }
                branch branch
            }
        }
        steps {
            shell 'echo 执行流水线构建'
        }
    }
}

这个方案逻辑清晰，完全可控，适合大多数场景。

方案二：自定义JobDSL删除动作（进阶） #

如果你想更贴合JobDSL的原生扩展机制，可以自定义一个RemovedJobAction，让作业被标记为删除时自动触发清理：

// 自定义删除动作类，继承JobDSL的RemovedJobAction
class BranchCleanupAction extends RemovedJobAction {
    @Override
    void doRemove(Job job) {
        def branchName = job.name.replace('pipeline-', '')
        println "触发分支 ${branchName} 的清理逻辑..."
        
        // 这里写你的清理代码，和方案一的逻辑一致
        def workspaceDir = new File(job.workspace)
        if (workspaceDir.exists()) {
            workspaceDir.deleteDir()
        }
        
        // 别忘了执行默认的删除动作
        job.delete()
    }
}

// 生成作业时绑定自定义删除动作
activeBranches.each { branch ->
    job("pipeline-${branch}") {
        removedJobActions {
            add(new BranchCleanupAction())
        }
        // 其他流水线配置...
    }
}

这种方式更优雅，适合需要复用清理逻辑的大型项目。

方案三：监听Jenkins全局作业删除事件 #

如果你的清理逻辑需要覆盖「手动删除作业」的场景，可以注册一个Jenkins全局监听器，不管作业是怎么被删除的，都会触发清理：

import jenkins.model.Jenkins
import hudson.model.listeners.ItemListener

// 自定义监听器类
class JobDeleteCleanupListener extends ItemListener {
    @Override
    void onDeleted(Item item) {
        // 只处理我们的流水线作业
        if (item instanceof Job && item.name.startsWith('pipeline-')) {
            def branchName = item.name.replace('pipeline-', '')
            println "检测到作业删除，开始清理分支 ${branchName}..."
            
            // 执行清理逻辑
            def workspaceDir = new File(item.workspace)
            if (workspaceDir.exists()) {
                workspaceDir.deleteDir()
            }
        }
    }
}

// 注册监听器（避免重复注册，先移除旧的）
def listener = new JobDeleteCleanupListener()
Jenkins.instance.removeListener(listener)
Jenkins.instance.addListener(listener)

你可以把这段代码放到Jenkins的「系统管理→脚本控制台」执行，或者做成初始化脚本让Jenkins启动时自动加载。

需要注意的是，执行清理逻辑时要确保Jenkins有足够的权限（比如删除文件、调用外部API的权限），如果清理逻辑耗时较长，建议异步执行，避免阻塞Jenkins主线程。

内容的提问来源于stack exchange，提问作者CodyK