当团队中的 Pipeline 越来越多时你会发现每个 Jenkinsfile 中都在重复写着类似的代码拉取代码、Maven 构建、Docker 打包、发送通知……维护几十个几乎相同的 Pipeline 会变成一场噩梦。Jenkins Shared Library共享库 正是为解决这个问题而生——它让你把通用的 Pipeline 逻辑抽取为可复用的函数一处修改全局生效。一、什么是 Shared Library可以把 Jenkins 比作一个“厨师”而 Shared Library 就是一份“菜谱合集”。在没有共享库时每个 Jenkinsfile 都要写重复的步骤有了共享库之后所有项目就能共享一套逻辑方便统一管理和维护。Shared Library 本质上是一个存放 Groovy 脚本的 Git 仓库这些脚本定义了可复用的 Pipeline 步骤。它让你能够封装通用逻辑将代码拉取、构建、测试、通知等步骤封装为函数。统一维护修改一处所有引用该库的 Pipeline 自动生效。版本化管理共享库本身也有版本分支/Tag可以灰度升级。二、Shared Library 的目录结构一个标准的 Shared Library 项目包含以下目录textjenkins-shared-library/├── vars/ # 全局函数目录最常用│ ├── helloWorld.groovy│ ├── buildApp.groovy│ └── notifySlack.groovy├── src/ # 类库目录Groovy 类│ └── org/example/│ └── Utils.groovy└── resources/ # 资源文件模板、配置文件等└── templates/└── email.txt核心目录说明三、编写第一个 Shared Library 函数3.1 创建函数文件在 vars/ 目录下创建 helloWorld.groovydefcall(String nameJenkins){echoHello,${name}! Welcome to Shared Library!}3.2 创建一个实用的构建函数vars/buildApp.groovydefcall(Map config[:]){stage(代码编译){shmvn clean compile}stage(单元测试){shmvn test}stage(打包){shmvn package -DskipTests}if(config.deploytrue){stage(部署){echo部署到${config.env?:staging}环境...}}}3.3 创建通知函数vars/notifySlack.groovydefcall(String message,String colorgood){slackSend(color:color,message:构建通知:${message})}四、在 Jenkins 中配置 Shared Library4.1 全局配置推荐登录 Jenkins → 系统管理 → 系统配置。滚动到 Global Pipeline Libraries点击 新增。填写以下字段4.2 文件夹级别配置如果只想让某个文件夹下的 Pipeline 使用该库可以在文件夹的配置中单独添加 Shared Library。五、在 Jenkinsfile 中使用 Shared Library5.1 使用 Library 注解推荐在 Jenkinsfile 顶部使用 Library 注解导入库Library(my-shared-lib)_pipeline{agent any stages{stage(构建应用){steps{// 调用 vars/buildApp.groovybuildApp()}}stage(发送通知){steps{notifySlack(构建完成,good)}}}}⚠️ 注意Library(‘my-shared-lib’) _ 中的下划线不能省略它是 Groovy 语法的一部分。5.2 指定特定版本// 使用特定分支Library(my-shared-libdevelop)_// 使用特定 TagLibrary(my-shared-libv1.2.0)_5.3传递参数 groovyLibrary(my-shared-lib)_pipeline{agent any parameters{booleanParam(name:DEPLOY,defaultValue:false,description:是否部署)choice(name:ENV,choices:[dev,test,prod],description:目标环境)}stages{stage(构建与部署){steps{buildApp(deploy:params.DEPLOY,env:params.ENV)}}}}5.4 使用 src/ 目录中的类Library(my-shared-lib)_importorg.example.Utils pipeline{agent any stages{stage(使用工具类){steps{script{defutilnewUtils()echo util.formatTimestamp()}}}}}六、实战封装完整的 CI 流水线库下面是一个更完整的共享库示例涵盖了从代码拉取到镜像推送的全流程。vars/ciPipeline.groovydefcall(Map config[:]){// 默认参数defappNameconfig.appName?:unknown-appdefregistryconfig.registry?:registry.example.comdefimageTagconfig.imageTag?:env.BUILD_NUMBER?:lateststage(拉取代码){checkout scm}stage(代码静态检查){shmvn checkstyle:check || true}stage(编译与测试){shmvn clean test}stage(打包){shmvn package -DskipTests}stage(构建镜像){sh docker build -t${registry}/${appName}:${imageTag}. }stage(推送镜像){withCredentials([usernamePassword(credentialsId:docker-registry,usernameVariable:DOCKER_USER,passwordVariable:DOCKER_PASS)]){sh docker login -u${DOCKER_USER}-p${DOCKER_PASS}${registry}docker push${registry}/${appName}:${imageTag}}}stage(归档产物){archiveArtifacts artifacts:target/*.jar}}使用该库的 JenkinsfileLibrary(my-shared-lib)_pipeline{agent any environment{APP_NAMEorder-serviceREGISTRYregistry.company.com}stages{stage(CI 流水线){steps{ciPipeline(appName:env.APP_NAME,registry:env.REGISTRY)}}}post{success{notifySlack(${env.APP_NAME}构建成功,good)}failure{notifySlack(${env.APP_NAME}构建失败,danger)}}}七、最佳实践共享库本身也要版本管理使用 Git Tag 标记每个稳定版本生产环境锁定特定版本。保持函数单一职责一个函数只做一件事便于组合和测试。提供默认参数让函数在大多数场景下可以直接调用无需额外配置。为共享库编写文档在仓库根目录添加 README.md说明每个函数的用途和参数。在测试环境先验证共享库的变更影响范围广先在测试分支验证再合并到主分支。使用 vars/ 目录的 call 方法这是最直接、最常用的复用方式。八、小结Jenkins Shared Library 让 Pipeline 代码从“复制粘贴”走向“复用共享”。通过将通用逻辑抽取到 Git 仓库中你可以消除重复代码统一维护和升级实现 Pipeline 的版本化管理Shared Library 是 Jenkins 高级用法的核心技能掌握它你就能构建出可维护、可扩展的企业级 CI/CD 体系。