Jenkins Pipeline 方法（函数）定义及调用

原创已于 2023-10-05 12:57:32 修改 · 7.2k 阅读

10 ·

CC 4.0 BY-SA版权

文章标签：

#jenkins #运维

于 2022-07-04 15:47:44 首次发布

CICD 专栏收录该内容

24 篇文章

订阅专栏

本文介绍如何在 Jenkinsfile 中定义和调用方法，通过示例演示如何简化部署流程，适用于多台服务器的自动化部署场景。

首先来说一下为什么要使用方法？有这样一个场景，我有十几台远端服务器，这些服务器都是我的测试（或线上）服务器，我构建后的包需要部署到这些服务器上，于是我会为每台远程服务器定义相关登录信息（用户名、密码或密钥）等。这些配置对于每台服务器来说其实都是一样，无非就是 IP 不同而已（用户名、密钥或密码我暂且保持一致），于是我就可以将相同的部分定义为一个方法或叫函数，并在我的流水线阶段来调用这些方法或函数，当你定义的函数过多时，你还可以将这些函数写道共享库中，然后流水线调用共享库即可。

本案例以声明式 Jenkinsfile 为例进行演示！

1、定义方法（函数）

方法定义于 pipeline {} 之外，并在 pipeline {} 之内进行调用。如下，我定义了一个远程服务器的远程登录信息，方便我能把构建的包发布到远程服务器上。

// 创建函数
def RemoteHost(Jarnname, Host, ProJect) {
    withCredentials([usernamePassword(credentialsId: '131', passwordVariable: 'PassWord', usernameVariable: 'UserName')]){
        def remote = [:]
        remote.name = "$Jarnname"
        remote.host = "$Host"
        remote.user = "$UserName"
        remote.password = "$PassWord"
        remote.port = 22
        remote.allowAnyHosts = true
        sshPut remote: remote, from: "./target/$Jarnname", into: "./${ProJect}/", override: true
    }
}

// 流水线步骤
pipeline {
	stages {
		// 阶段 + 步骤
	}
}

2、调用方法（函数）

看下面代码块的项目发布阶段，在这里调用了上面定义的函数，并进行参数传递。

// 创建函数
def RemoteHost(Jarnname, Host, ProJect) {
    withCredentials([usernamePassword(credentialsId: '131', passwordVariable: 'PassWord', usernameVariable: 'UserName')]){
        def remote = [:]
        remote.name = "$Jarnname"
        remote.host = "$Host"
        remote.user = "$UserName"
        remote.password = "$PassWord"
        remote.port = 22
        remote.allowAnyHosts = true
        sshPut remote: remote, from: "./target/$Jarnname", into: "./${ProJect}/", override: true
    }
}

// 流水线步骤
pipeline {
    agent {
        docker {
            image 'maven:v2'
            args '-v /var/lib/jenkins/workspace/$JOB_NAME:/root/.m2 -v /root/mavenRepository:/usr/repository'
        }
    }
    ...
    ...
	stages {
	    // 拉取代码
        stage('拉取代码') {
            steps {
                checkout([$class: 'GitSCM',
                    branches: [[name: "${params.BRANCH_TAG}"]],
                    doGenerateSubmoduleConfigurations: false,
                    extensions: [],
                    gitTool: 'Default',
                    submoduleCfg: [],
                    userRemoteConfigs: [[url: 'https://codeup.aliyun.com/xx/java_code.git',credentialsId: 'yourid',]]
                ])
        }
        // 项目构建
        stage("构建项目") {
            steps {
                sh "mvn clean package -Dmaven.test.skip=true -P test"
            }
        }
        // 项目发布（在这里调用方法）
        stage ("项目发布") {
            steps {
                script {
                    switch("$p_name"){
                        case "cms":
                            Jarnname = "demo.jar"
                            Host = "192.168.56.131"
                            ProJect = "cms"
                            // 调用方法并传递参数
                            RemoteHost("${Jarnname}", "${Host}", "${ProJect}")
                        break
                    }
                }
            }
        }
        ...
        ...
	}
}