如何在Jenkins共享库中配置全局常量环境变量跨流水线使用

你可以通过两种方式实现，分别利用vars目录和src目录，以下是具体实现步骤和注意事项：

方法一：使用vars目录（推荐，无需导入） #

vars目录下的Groovy脚本会被Jenkins自动注册为全局可用的类，无需手动导入即可直接调用，适合定义全局常量。

步骤1：在共享库中创建常量脚本 #

在共享库的vars目录下创建一个命名规范的脚本（比如GlobalConsts.groovy，首字母大写），在其中定义静态常量：

// vars/GlobalConsts.groovy
// 静态常量，全局可直接访问
static final String DEFAULT_REGISTRY = "docker.io/my-team"
static final int BUILD_TIMEOUT_MIN = 20
static final Map<String, String> ENV_ENDPOINTS = [
    dev: "https://dev.example.com/api",
    prod: "https://prod.example.com/api"
]

// 也可以定义普通属性（无需static，但建议用static更规范）
def LOG_LEVEL = "INFO"

步骤2：在流水线中直接调用 #

加载共享库后，直接通过脚本类名访问常量：

@Library('your-shared-library') _ // 替换为你的共享库名称

pipeline {
    agent any
    stages {
        stage('Demo') {
            steps {
                echo "镜像仓库：${GlobalConsts.DEFAULT_REGISTRY}"
                echo "超时时间：${GlobalConsts.BUILD_TIMEOUT_MIN}分钟"
                echo "Dev环境地址：${GlobalConsts.ENV_ENDPOINTS.dev}"
                echo "日志级别：${GlobalConsts.LOG_LEVEL}"
            }
        }
    }
}

方法二：使用src目录（需静态导入） #

如果习惯用Java风格的包结构管理常量，可以在src目录下创建静态类，通过静态导入实现无需实例化调用。

步骤1：在src目录创建常量类 #

遵循Java包结构，比如src/com/yourteam/Constants.groovy：

package com.yourteam

class Constants {
    // 静态常量定义
    static final String APP_NAME = "MyBusinessApp"
    static final String DB_CONN_STRING = "jdbc:postgresql://db-server:5432/mydb"
}

步骤2：在流水线中静态导入并调用 #

加载共享库后，通过静态导入直接使用常量名：

@Library('your-shared-library') _
import static com.yourteam.Constants.* // 静态导入所有常量

pipeline {
    agent any
    stages {
        stage('Demo') {
            steps {
                echo "应用名称：${APP_NAME}"
                echo "数据库连接串：${DB_CONN_STRING}"
            }
        }
    }
}

常见失败原因排查 #

如果之前尝试失败，可能是以下问题：

1. 共享库未正确配置：确保Jenkins全局配置中已添加该共享库，且流水线中正确加载（注意@Library后的下划线不能丢）。
2. 常量定义方式错误：
   • vars目录下未用static修饰常量，导致无法通过类名直接访问；
   • src目录下的常量未加static，必须实例化类才能访问。
3. 命名或路径错误：
   • vars目录的脚本名首字母需大写，流水线中调用时要对应（比如GlobalConsts而非globalConsts）；
   • src目录的类包路径需与导入语句完全匹配。

注意事项 #

• 敏感信息（如密码、API密钥）不要硬编码到共享库中，应使用Jenkins凭据管理，在共享库中封装获取凭据的方法。
• 建议统一常量的命名规范（比如全大写加下划线），提升可读性。

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