CI/CD / 系统课时

创建可调用的共享库步骤

创建可调用的共享库步骤

当多个 Jenkinsfile 都包含相同的构建、测试或部署逻辑时,可以把这些逻辑提取到 Shared Library。本文从最小目录结构开始创建一个公共步骤,并演示业务流水线如何加载和调用它。

学习目标

  • 理解 Shared Library 中 vars 目录和 call 方法的作用
  • 能创建一个可由 Jenkinsfile 直接调用的公共步骤
  • 能通过最小流水线验证共享步骤是否成功加载

建立最小共享库结构

Jenkins Shared Library 通常放在独立的 Git 仓库中。对于希望像普通流水线步骤一样调用的能力,最直接的方式是在仓库根目录建立 vars 目录,并创建同名 Groovy 文件。

例如要提供 buildApp() 步骤,可以建立 vars/buildApp.groovy。文件名 buildApp 会成为 Jenkinsfile 中可见的全局变量,而其中的 call 方法让它能够以函数形式调用。

共享库步骤从仓库到 Jenkinsfile 的调用关系

封装公共步骤

下面是一个最小可用的共享步骤。它使用 Jenkins Pipeline 提供的 echo 和 sh 步骤,因此代码应由 Jenkins 流水线上下文执行。

groovy
def call() {
    echo 'Building application with shared library'
    // 公共构建逻辑集中在共享库,业务 Jenkinsfile 不再复制命令。
    sh 'mvn -B package -DskipTests'
}

这是 vars/buildApp.groovy 的完整示例。提交到共享库仓库后,还需要在 Jenkins 中将该仓库配置为 Shared Library;配置时使用的库名称就是 Jenkinsfile 加载它时引用的名称。

从 Jenkinsfile 调用

假设 Jenkins 中已经把该仓库注册为名为 ci-library 的共享库,业务流水线可以使用 @Library 加载它,再直接调用 buildApp()。

groovy
@Library('ci-library') _

pipeline {
    agent any

    stages {
        stage('Build') {
            steps {
                buildApp()
            }
        }
    }
}

@Library('ci-library') _ 中的下划线用于让注解附着到一个有效的 Groovy 表达式。执行到 Build 阶段时,Jenkins 会解析共享库中的 vars/buildApp.groovy,然后调用其 call() 方法。

预期输出

text
Building application with shared library
[INFO] BUILD SUCCESS

Maven 的完整日志、工作目录和时间信息会因项目与 Jenkins 环境不同而变化;验证时重点确认共享步骤输出出现,并且 Maven 最终构建成功。

验证共享步骤边界

第一次接入时,不要立即迁移复杂部署逻辑。先使用一个只有 echo 或简单构建命令的步骤验证三个边界:Jenkins 能取得共享库仓库、配置的库名称与 @Library 一致、vars 下的文件能够被流水线识别。

如果出现 No such DSL method 'buildApp',优先检查共享库是否实际加载、文件是否位于仓库根目录的 vars/buildApp.groovy、文件名与调用名是否一致。若库能加载但 sh 执行失败,则问题已经进入构建环境,应继续检查 Agent 上的 Maven、JDK 和项目文件,而不是修改共享库加载方式。

共享库的价值不是简单地把 Jenkinsfile 搬到另一个仓库,而是形成稳定的公共流水线接口。先用小而明确的 vars 步骤建立调用边界,再逐步提取测试、制品发布和部署能力,更容易控制共享逻辑的复杂度。

按自己的节奏,确认真正理解。

目录与阅读设置

阅读设置

17

记录一个想法

创建可调用的共享库步骤

0 / 10000 · 笔记保存到账号。未提交的修改会在关闭、离开或刷新后丢失。

登录哪都通