讲师中心 微信公众号
AI工具推荐 视频效率加速

Jenkins 中如何使用 Groovy 编写共享库

落杰酱_8887

落杰酱_8887

发布时间:2026-07-11 10:37:06

|

265人浏览过

|

来源于php中文网

原创

Jenkins共享库需按vars/src/resources规范组织,通过后台配置Git仓库并加载,在Jenkinsfile中用@Library调用vars脚本或实例化src类。

jenkins 中如何使用 groovy 编写共享库

在 Jenkins 中用 Groovy 编写共享库,核心是把重复的流水线逻辑(比如构建、打包、推送镜像、发通知)抽出来,存到 Git 仓库里,再通过 Jenkins 配置加载,最后在 Jenkinsfile 里调用。它不是写个脚本扔进去就行,而是有约定结构、加载方式和调用规范的一套机制。

共享库的目录结构必须规范

共享库本质是一个 Git 项目,根目录下需包含三个关键子目录:

  • vars/:放全局可调用的 Groovy 脚本,文件名即变量名(如 deploy.groovy),里面必须定义 call 方法,才能在 Pipeline 中直接写 deploy(...)
  • src/:按 Java 包结构组织类(如 src/com/example/Utils.groovy),适合封装复杂逻辑、复用工具类,需用 new com.example.Utils() 实例化调用
  • resources/:存放 JSON、YAML、模板等静态资源,可通过 libraryResource('path/to/file.json') 加载

这三个目录可以空着启动,但一旦要用某类功能,就得按对应位置放文件。比如只用简单函数,vars/ 就够了;要做类型封装或引入第三方库,就得走 src/。

在 Jenkins 后台配置共享库

进入 Manage Jenkins → Configure System → Global Pipeline Libraries,点击 “Add” 添加一个库:

  • Name:起个简短名字(如 mylib),后续在 @Library 中引用
  • Default version:填分支名(如 main)或标签(如 v1.2),决定默认加载哪个版本
  • Retrieval method:选 “Modern SCM”,然后配置 Git URL 和凭据
  • Load implicitly:勾选后,所有 Pipeline 自动可用该库,无需显式声明;不勾选则每次都要加 @Library

配置保存后,Jenkins 会在下次 Pipeline 执行前自动拉取并缓存代码。注意:修改共享库后,已运行的 Pipeline 不会自动更新,需手动触发或等待缓存刷新(默认 1 小时)。

Jenkins
Jenkins

通过 REST API 与 Jenkins CI/CD 服务器交互。适用于触发构建、查询状态、查看控制台输出、管理任务或监控 Jenkins...

下载

在 Jenkinsfile 中调用共享库

调用方式分两种,推荐用第一种:

  • @Library 注解(静态加载):写在 Jenkinsfile 最顶部,编译期就绑定版本,安全稳定
    @Library('mylib@main') _
    pipeline { ... steps { script { deploy(appName: 'web') } } }
  • library 步骤(动态加载):运行时调用,适合根据参数切换不同库版本
    steps { script { library identifier: 'mylib@feature-branch', retriever: modernSCM([ ... ]) } }

vars 下的脚本会自动变成全局变量,直接调用即可;src 下的类需显式 import 或 new 实例;resources 需配合 libraryResource 使用,不能直接读文件路径。

写一个可用的 vars 脚本示例

以 vars/notify.groovy 为例:

def call(Map args = [:]) {
    def title = args.title ?: 'Pipeline Notification'
    def message = args.message ?: 'Build completed.'
    echo "Sending notification: ${title}"
    // 实际可集成企业微信、邮件或 Slack
    sh "echo '${message}' | mail -s '${title}' admin@example.com"
}

在 Jenkinsfile 中就能这样用:

@Library('mylib') _
pipeline {
  agent any
  stages {
    stage('Notify') {
      steps {
        notify(title: 'Deploy Success', message: 'v1.0.5 deployed to staging')
      }
    }
  }
}

不需要 import,不关心路径,只要名字对、结构对、配置对,就能跑起来。

热门AI工具

更多
DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

Seko
Seko Hot

一款AI视频创作工具,主要用于商汤科技推出的创编一体的AI短视频创作Agent,适合需要提升相关任务效率的用户。

Lovart
Lovart Hot

一款面向视觉设计创作的AI设计平台,可通过智能体和画布工作流辅助制作海报、Logo、网页、PPT及其他视觉内容。

火山引擎

火山引擎是一款面向企业的云计算与AI服务平台。

音述AI
音述AI Hot

一款AI音频处理工具,主要用于音述AI是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区,适合需要提升相关任务效率的用户。

墨刀AI
墨刀AI Hot

一款AI图像与设计工具,主要用于产品经理的专属智能体,适合需要提升相关任务效率的用户。

蛙蛙写作

一款AI论文写作工具,主要用于超级AI智能写作助手,适合需要提升相关任务效率的用户。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

相关专题

更多
Docker容器化部署与DevOps实践
Docker容器化部署与DevOps实践

本专题面向后端与运维开发者,系统讲解 Docker 容器化技术在实际项目中的应用。内容涵盖 Docker 镜像构建、容器运行机制、Docker Compose 多服务编排,以及在 DevOps 流程中的持续集成与持续部署实践。通过真实场景演示,帮助开发者实现应用的快速部署、环境一致性与运维自动化。

239

2026.02.11

FrankenPHP集成Laravel详细教程
FrankenPHP集成Laravel详细教程

本专题提供FrankenPHP集成Laravel的详细配置指南,全面解析运行原理、开发环境搭建、Caddyfile配置、Octane工作模式、数据库连接、队列任务、定时任务和生产环境优化,解决部署过程中常见的报错与兼容性问题。

40

2026.10.08

LLVM自定义Pass怎么写
LLVM自定义Pass怎么写

本专题聚焦LLVM自定义Pass开发,整理Pass类结构、run()方法、PreservedAnalyses、CMake构建、插件注册、-load-pass-plugin加载和测试用例编写流程。

140

2026.09.30

LLVM RISC-V参数配置教程
LLVM RISC-V参数配置教程

本专题介绍LLVM对RISC-V基础ISA和扩展的支持方式,涵盖RV32、RV64、标准扩展、实验性扩展、厂商扩展、-menable-experimental-extensions和版本差异。

140

2026.09.30

LLVM IR中间表示入门指南
LLVM IR中间表示入门指南

本专题整理LLVM IR的核心概念,包括中间表示作用、模块结构、函数、基本块、SSA形式、类型系统和常见语法,帮助新手理解LLVM编译流程中的关键层。

100

2026.09.30

PDF转图片方法
PDF转图片方法

需要把 PDF 页面用于上传、预览、分享或图片归档时,PDF 转图片方法专题整理 JPG/PNG 格式选择、逐页导出、清晰度设置、批量下载和结果检查等流程,帮助用户稳定完成 PDF 图片化处理。

100

2026.09.30

PixTV AI视频生成与无限画布创作
PixTV AI视频生成与无限画布创作

PixTV专题整理AI视频与视觉内容创作相关功能使用教程,涵盖AI生图、视频生成、无限画布、多模型创作、素材管理、声音音乐及视频剪辑等功能,帮助用户快速掌握PixTV从创意到成片的完整制作方法。

120

2026.09.29

Buffalo框架数据库开发全教程
Buffalo框架数据库开发全教程

本专题围绕Buffalo框架数据库开发,讲解database.yml多环境配置、soda与fizz迁移生成回滚、模型结构体标签、增删改查与条件查询、一对多与多对多关联、数据校验、回调钩子、事务处理及原生SQL执行能力。

320

2026.09.23

Buffalo框架路由与请求处理实操指南
Buffalo框架路由与请求处理实操指南

本专题讲解Buffalo框架路由与请求处理机制,涵盖路由注册与分组、资源路由、Handler编写规范、Context上下文方法、参数绑定、中间件编写挂载、Session与Cookie读写、Flash消息及错误页面定制方法。

220

2026.09.23

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
热门推荐
/
最新课程
关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn