如何将本地Groovy库文件加载至Jenkins并像共享库一样调用？

1. 按Jenkins共享库规范整理本地文件结构 #

Jenkins对共享库有固定结构要求，哪怕本地库也需遵循，才能被正确识别加载：

my-local-library/
├── src/
│   └── groovy/
│       ├── Utils.groovy
│       └── BusinessLogic.groovy
└── vars/
    # 可选：存放暴露给Pipeline的全局变量脚本

• 所有需要互调的Groovy类文件放在src/groovy目录下
• 类名必须与文件名完全一致（Groovy规范），比如Utils.groovy内的类需定义为class Utils {}

2. 在Jenkins中配置本地共享库 #

• 进入Jenkins「系统管理」→「系统设置」
• 找到Global Pipeline Libraries区域，点击「Add」：
  • Name：给库命名，比如local-groovy-lib
  • Default version：任意填写（本地库该字段不生效，但不能为空）
  • Retrieval method：选择Modern SCM
  • SCM：根据Jenkins版本选择：
    • 若支持File System：填写本地库的绝对路径，比如/opt/jenkins-local-libs/my-local-library
    • 若仅支持Git：在本地库目录初始化Git仓库（无需推送到远程），路径填file:///opt/jenkins-local-libs/my-local-library，Default version填本地分支名（如main）
  • 可选勾选Load implicitly：所有Pipeline无需手动声明即可加载该库

3. Groovy文件间的互调实现 #

假设Utils.groovy有静态方法：

class Utils {
    static String getEnvVar(String key) {
        return System.getenv(key)
    }
}

在BusinessLogic.groovy中可直接通过类名调用（Jenkins会自动将src/groovy加入类路径）：

class BusinessLogic {
    static void processData() {
        String buildNumber = Utils.getEnvVar('BUILD_NUMBER')
        println "Processing data for build: ${buildNumber}"
    }
}

4. 在Jenkinsfile中调用库文件 #

• 若已勾选Load implicitly，直接调用：

pipeline {
    agent any
    stages {
        stage('Run Logic') {
            steps {
                script {
                    BusinessLogic.processData()
                }
            }
        }
    }
}

• 若未勾选隐式加载，需先声明加载：

@Library('local-groovy-lib') _
pipeline {
    // 同上逻辑
}

注意事项 #

• 确保Jenkins运行用户对本地库目录有读权限
• Groovy类的访问修饰符尽量显式声明（如public），避免访问权限问题
• 若依赖第三方Jar包，可将Jar放在本地库的lib目录下，Jenkins会自动加载这些依赖

内容的提问来源于stack exchange，提问作者Velan