如何在JobDSL Groovy脚本中导入共享配置数据以避免重复定义？

问题背景 #

现有20余个JobDSL脚本，大量重复定义如ENVIRONMENTS这类元数据，尝试用Jenkins共享库的@Library注解导入时出现unable to resolve class Library错误，需要找到可行的集中存储共享数据的方案，优先将元数据存在JobDSL脚本所在仓库。

可行解决方案 #

方案1：同一仓库创建共享Groovy文件导入（推荐） #

直接在JobDSL所在仓库创建专门的共享配置文件，在各脚本中加载使用，无需额外Jenkins配置。

1. 创建共享常量文件
   在仓库根目录新建shared/Constants.groovy，集中定义所有共享元数据：

// shared/Constants.groovy
// 共享环境列表
def ENVIRONMENTS = [
    'Development',
    'Testing',
    'Production'
]
// 可添加其他共享配置，如日志保留数量
def LOG_ROTATOR_NUM = 30

2. 在JobDSL脚本中加载使用
   修改原脚本，开头添加加载语句，直接引用共享常量：

// 加载共享常量文件，路径根据实际目录结构调整
load('shared/Constants.groovy')

def SERVICES = [
    'Service-1',
    'Service-2'
]

for (SVC in SERVICES) {
    SVC_NAME = SVC.replaceAll('-', ' ')
    SVC_PATH = SVC.replaceAll('-', '_')

    pipelineJob("DEPLOY/${SVC_NAME}") {
        displayName("DEPLOY ${SVC_NAME.toUpperCase()}")

        parameters {
            // 直接使用共享的ENVIRONMENTS列表
            choiceParam('ENVIRONMENT', ENVIRONMENTS, 'Select the environment to deploy to')
        }

        logRotator {
            // 使用共享的日志保留数量
            numToKeep(LOG_ROTATOR_NUM)
        }
        
        definition {
            cpsScm {
                scm {
                    git {
                        remote {
                            // 原Git配置内容
                        }
                    }
                }
                scriptPath('deploy/Jenkinsfile_deploy_services.groovy')
            }
        }
    }
}

注意：确保种子Job拉取仓库后，shared/Constants.groovy在工作目录的对应路径下，若种子Job配置了子目录，需调整load的路径。

方案2：用readFileFromWorkspace加载共享文件 #

如果load方法因权限或路径问题无法使用，可改用readFileFromWorkspace读取文件内容后求值：

// 读取共享文件内容并执行
def sharedConfigContent = readFileFromWorkspace('shared/Constants.groovy')
evaluate(sharedConfigContent)

// 后续脚本逻辑同方案1...

方案3：修复Jenkins共享库的使用方式 #

若仍想使用Jenkins共享库，需调整加载方式（JobDSL不支持直接用@Library注解）：

1. 在共享库中定义常量类
   在共享库的src/com/yourcompany/JobConstants.groovy中定义静态常量：

package com.yourcompany

class JobConstants {
    static final List<String> ENVIRONMENTS = [
        'Development',
        'Testing',
        'Production'
    ]
}

2. 在JobDSL脚本中加载并使用
   在脚本开头手动加载共享库并导入类：

// 加载共享库，库名与Jenkins中配置一致
library('our-shared-library').load('src/com/yourcompany/JobConstants.groovy')
import com.yourcompany.JobConstants

// 使用常量
JobConstants.ENVIRONMENTS

注意：需确保Jenkins中已正确配置共享库，且种子Job开启了Groovy沙箱权限。

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