Jenkins共享库编写与使用

MrJason...大约 4 分钟

Jenkins共享库编写与使用

1. 背景

如果你经常使用 Jenkins Pipeline 一定会遇到多个不同流水线中有大量重复代码的情况，很多时候为了方便我们都是直接复制粘贴到不同的管道中去的，但是长期下去这些代码的维护就会越来越麻烦。为了解决这个问题，Jenkins 中提供了共享库的概念来解决重复代码的问题，我们只需要将公共部分提取出来，然后就可以在所有的 Pipeline 中引用这些共享库下面的代码了。

2. 共享库是什么？

共享库（shared library）是一些独立的 Groovy 脚本的集合，我们可以在运行 Pipeline 的时候去获取这些共享库代码。使用共享库最好的方式同样是把代码使用 Git 仓库进行托管，这样我们就可以进行版本化管理了。

使用共享库一般只需要3个步骤即可：

首先创建 Groovy 脚本，添加到 Git 仓库中
然后在 Jenkins 中配置将共享库添加到 Jenkins 中来
最后，在我们的流水线中导入需要使用的共享库：@Library('your-shared-library')，这样就可以使用共享库中的代码了。

3. 共享库内容

在共享库中一般会有两种通用的代码：

3.1 vars 下的steps

Steps：这些 Steps 在 Jenkins 中被称为全局变量，我们可以在所有的 Jenkins Pipeline 中使用这些自定义的 Steps。

比如，我们可以编写一个标准的 Step 来部署应用或者发送消息通知等，我们就可以将代码添加到 vars/YourStepName.groovy 文件中，然后实现一个 call 函数即可：

#!/usr/bin/env groovy
// vars/YourStepName.groovy

def call() {
  // Do something here...
}

3.2 src下的通用代码（通常放帮助类）

这些代码需要放在 src/your/package/name 目录下面，然后就可以使用常规的 Groovy 语法了，例如：

#!/usr/bin/env groovy
// com/qikqiak/GlobalVars.groovy
package com.qikqiak

class GlobalVars {
   static String foo = "bar"
}

我们可以在 Jenkins Pipeline 中使用 import 导入上面的类，并引用其中的静态变量，比如 GlobalVars.foo。

4. 示例

4.1 步骤1：vars的steps示例

新建一个名为 pipeline-library-demo 的文件夹，将该项目加入到 Git 仓库中。首先创建一个名为 vars 的目录，自定义一个 step 就是在 vars 目录下面的一个 .groovy 文件，这些被称为全局变量，比如我们添加一个 sayHi.groovy 的文件，代码如下所示：

#!/usr/bin/env groovy

def call(String name='zsz') {
  echo "Hello, ${name}."
}

需要注意的是需要实现 call 方法，添加了一个名为 name 的参数，具有默认值 zsz，可以用 ${name} 来进行访问。

4.2 步骤2：src 的通用代码示例

然后创建一个名为 src/com/zsz/GlobalVars.groovy 的文件，文件内容如下所示：

#!/usr/bin/env groovy
package com.qikqiak

class GlobalVars {
  static String foo = "bar"

  // 在 Pipeline 中可以引用这里的静态变量：
  // 
  // import com.zsz.GlobalVars
  // println GlobalVars.foo
}

4.3 完整的代码目录如下所示：

$ tree .
.
├── README.md
├── src
│   └── com
│       └── zsz
│           └── GlobalVars.groovy
└── vars
    └── sayHi.groovy

4 directories, 3 files

4.4 上传代码到git

https://gitee.com/zszdevelop/pipeline-library-demo

4.5 Jenkins 添加共享库

共享库创建完成后，我们需要让 Jenkins 知道这个共享库，我们可以从 Jenkins 的 Web 页面进行添加。在 Jenkins 首页 -> 系统管理 -> 系统配置，在 Global Pipeline Libraries 区域配置共享库：

4.6 新建流水线项目

保存后即可使用配置共享库。接下来新建一个名为 share-lib-demo 的流水线项目，在 Pipeline script 区域添加如下代码：

@Library('pipeline-library-demo')_

import com.qikqiak.GlobalVars

stage('Demo') {
    echo 'Hello world'
    sayHi '张三'
    println GlobalVars.foo
}

需要注意的是 @Library('pipeline-library-demo')_ 最后有一个下划线 _，这个下划线并不是写错了，如果 @Libray 后面紧接的一行不是 import 语句的话，就需要这个下划线，我们这里后面就是一条 import 语句，所以这里可以省略这个下划线。