Jenkins基础教程（35）配置Jenkins 服务器之配置全局属性：Jenkins全局属性配置全攻略：让构建效率翻倍的魔法手册_contributing variables 的变量怎么显示到jenkins console out-优快云博客

每次重复配置环境变量到怀疑人生？Jenkins全局属性就是你的救星。

在软件开发中，我们经常会遇到这样的场景：多个项目需要使用相同的路径、相同的版本号或者相同的服务器地址。想象一下，当你的团队有几十个Jenkins任务，每个都需要配置相同的Maven路径或Docker仓库地址，然后某天这些地址突然变了……是不是光想想就头皮发麻？

别担心，Jenkins的全局属性功能就是专门为解决这类问题而生的。通过正确配置全局属性，我们可以实现**“一次配置，到处使用”**的神奇效果，极大提高维护效率。

一、什么是全局属性？为什么它如此重要？

全局属性，顾名思义，就是在Jenkins环境中全局有效的变量。它们就像是Jenkins世界的通用货币，可以在任何项目、任何流水线中流通使用。

与局部环境变量相比，全局属性具有以下优势：

统一管理：所有变量集中存放，修改时只需更新一处
跨项目共享：不同任务可以引用相同的变量，保证值的一致性
降低维护成本：当服务器地址、路径等发生变化时，无需逐个修改每个Job
减少错误：避免因手动输入错误导致的构建失败

举个例子，假设你的公司有多个环境（开发、测试、生产），每个环境都有不同的数据库地址和API密钥。使用全局属性，你可以定义如DEV_DB_URL、TEST_DB_URL、PROD_DB_URL等变量，然后在各个构建任务中按需引用。当某个环境的地需要变化时，只需在全局层面修改一次即可。

二、配置全局属性的多种方法

Jenkins提供了多种配置全局属性的方式，每种方式都有其适用场景。下面我们来一一揭秘。

方法1：通过Web界面配置（最简单）

这是最直接的方法，适合刚开始接触Jenkins的用户：

登录Jenkins，点击左侧菜单中的**"Manage Jenkins"**（管理Jenkins）
找到并点击**"Configure System"**（系统配置）
滚动到**"Global properties"**（全局属性）部分
勾选**"Environment variables"**（环境变量）复选框
点击**"Add"**按钮，输入变量名和值
最后点击**"Save"**保存配置

例如，你可以添加一个名为COMPANY_NAME的变量，值为你的公司名，这样所有构建任务就都能使用这个变量了。

实用技巧：你可以通过点击变量输入框旁边的「？」图标查看帮助信息。对于敏感信息如密码、API密钥等，建议使用Jenkins的凭证管理功能而非直接写在全局属性中。

方法2：通过属性文件批量配置（最高效）

当需要配置的变量很多时，逐个添加会非常繁琐。这时，通过属性文件批量加载就显示出巨大优势了。

具体操作步骤如下：

创建一个属性文件，例如env.properties，内容格式为key=value，每行一个变量：

APP_VERSION=1.0.0
MAVEN_HOME=/opt/maven
DEPLOY_PATH=/var/www/app
REPO_URL=https://github.com/company/project

将这个文件放在Jenkins服务器上某个固定位置，例如/var/jenkins_home/env.properties
在Jenkins的**"Manage Jenkins" → "Configure System"页面，找到"Global properties"**部分
勾选**"Environment variables"，然后点击"Add"按钮下方的"Load from file"**（从文件加载）选项
在**"Property file path"**（属性文件路径）中输入文件完整路径
保存配置

这样，Jenkins就会自动加载该文件中的所有变量，并在全局范围内使它们可用。当需要修改变量时，只需更新属性文件即可，无需登录Jenkins界面。

方法3：通过系统服务配置（最彻底）

如果你希望环境变量对Jenkins服务本身及其所有作业都可用，可以修改Jenkins的systemd服务文件。

具体步骤：

打开终端，连接到Jenkins服务器
编辑Jenkins的systemd服务文件：

sudo vi /usr/lib/systemd/system/jenkins.service

在[Service]部分添加Environment指令：

[Service]
Type=simple
User=jenkins
WorkingDirectory=/var/lib/jenkins
Environment="COMPANY_NAME=YourCompany"
Environment="API_ENDPOINT=https://api.company.com"
ExecStart=/usr/bin/jenkins
Restart=always

保存文件后，重新加载systemd配置并重启Jenkins服务：

sudo systemctl daemon-reload
sudo systemctl restart jenkins

验证环境变量是否生效：进入Jenkins的**"Manage Jenkins" → "Script Console"**（脚本控制台），执行println(System.getenv("COMPANY_NAME"))，如果输出YourCompany则表示设置成功。

这种方法设置的变量优先级最高，对Jenkins服务和所有构建任务都有效。

方法4：通过Jenkinsfile配置（最灵活）

对于Pipeline项目，可以直接在Jenkinsfile中通过environment块定义环境变量。这些变量虽然不算严格意义上的"全局属性"，但在Pipeline内部是全局可用的。

示例：

pipeline {
    agent any
    environment {
        // 定义简单变量
        APP_NAME = 'my-application'
        // 基于其他变量构造新变量
        DEPLOY_URL = "https://${APP_NAME}.company.com"
        // 使用credentials函数安全引用敏感信息
        API_TOKEN = credentials('api-token')
    }
    stages {
        stage('Build') {
            steps {
                echo "Building ${env.APP_NAME}"
                sh 'mvn clean package -Dapp.name=$APP_NAME'
            }
        }
        stage('Deploy') {
            steps {
                echo "Deploying to ${env.DEPLOY_URL}"
                sh './deploy.sh $DEPLOY_URL $API_TOKEN'
            }
        }
    }
}

这种方法特别适合Pipeline专用的变量，既保持了灵活性，又能在代码层面管理配置。

三、全局属性的使用与引用

配置好全局属性后，接下来就是在构建任务中使用它们了。根据不同的上下文，引用方式也有所不同。

在普通构建任务中

在**"Execute shell"或"Execute Windows batch command"**构建步骤中，可以直接通过$VARIABLE_NAME（Unix）或%VARIABLE_NAME%（Windows）方式引用：

# Unix/Linux shell
echo "Application version: $APP_VERSION"
echo "Maven home: $MAVEN_HOME"
cd $WORKSPACE
cp target/app.jar $DEPLOY_PATH

:: Windows batch
echo Application version: %APP_VERSION%
cd %WORKSPACE%
copy target\app.jar %DEPLOY_PATH%

在Pipeline中

在Jenkins Pipeline中，可以通过env.VARIABLE_NAME方式引用全局属性：

pipeline {
    agent any
    stages {
        stage('Example') {
            steps {
                echo "Building version ${env.APP_VERSION}"
                sh 'echo "Maven home is $MAVEN_HOME"'
                script {
                    // 在Scripted Pipeline中也可以这样使用
                    def deployPath = env.DEPLOY_PATH
                    echo "Deploy path is ${deployPath}"
                }
            }
        }
    }
}

在插件配置中

大多数Jenkins插件也支持使用环境变量。例如，在Email Extension插件中：

Subject: Build Notification for ${APP_NAME}
Body: The build of ${APP_NAME} version ${APP_VERSION} has completed.

四、实战演示：一个完整的企业级示例

现在，让我们通过一个真实的场景来演示全局属性的威力。

场景描述

假设我们有一个名为"SuperApp"的Java Web应用，需要部署到三个环境：开发、测试和生产。每个环境有不同的数据库连接、API端点和管理员邮箱。

配置步骤

创建全局属性文件

在Jenkins服务器上创建/var/jenkins_home/env.properties文件：

# 应用基本信息
APP_NAME=SuperApp
COMPANY_NAME=TechCorp

# 版本信息
CURRENT_VERSION=2.1.0
NEXT_VERSION=2.1.1

# 路径配置
BUILD_DIR=/opt/build
DEPLOY_BASE=/var/www

# 环境特定配置 - 开发
DEV_DB_URL=jdbc:mysql://dev-db.company.com:3306/superapp
DEV_API_URL=https://dev-api.company.com
DEV_ADMIN_EMAIL=dev-admin@company.com

# 环境特定配置 - 测试
TEST_DB_URL=jdbc:mysql://test-db.company.com:3306/superapp
TEST_API_URL=https://test-api.company.com
TEST_ADMIN_EMAIL=test-admin@company.com

# 环境特定配置 - 生产
PROD_DB_URL=jdbc:mysql://prod-db.company.com:3306/superapp
PROD_API_URL=https://api.company.com
PROD_ADMIN_EMAIL=prod-admin@company.com

在Jenkins中加载属性文件

按照前面介绍的方法，在**"Manage Jenkins" → "Configure System" → "Global properties"**中配置从文件加载环境变量，路径设为/var/jenkins_home/env.properties。

创建多环境部署Pipeline

创建一个名为deploy-pipeline的Pipeline项目，使用以下Jenkinsfile：

pipeline {
    agent any
    parameters {
        choice(
            name: 'DEPLOY_ENV',
            choices: ['dev', 'test', 'prod'],
            description: '选择要部署的环境'
        )
    }
    environment {
        // 根据选择的环境设置相应的变量
        DB_URL = "${params.DEPLOY_ENV == 'dev' ? env.DEV_DB_URL : params.DEPLOY_ENV == 'test' ? env.TEST_DB_URL : env.PROD_DB_URL}"
        API_URL = "${params.DEPLOY_ENV == 'dev' ? env.DEV_API_URL : params.DEPLOY_ENV == 'test' ? env.TEST_API_URL : env.PROD_API_URL}"
        ADMIN_EMAIL = "${params.DEPLOY_ENV == 'dev' ? env.DEV_ADMIN_EMAIL : params.DEPLOY_ENV == 'test' ? env.TEST_ADMIN_EMAIL : env.PROD_ADMIN_EMAIL}"
    }
    stages {
        stage('Init') {
            steps {
                echo "开始部署 ${env.APP_NAME} 到 ${params.DEPLOY_ENV} 环境"
                echo "应用版本: ${env.CURRENT_VERSION}"
                echo "数据库: ${DB_URL}"
                echo "API端点: ${API_URL}"
            }
        }
        stage('Build') {
            steps {
                sh """
                    mvn clean package \
                    -Ddb.url=${DB_URL} \
                    -Dapi.url=${API_URL} \
                    -Dapp.version=${env.CURRENT_VERSION}
                """
            }
        }
        stage('Deploy') {
            steps {
                sh """
                    cp target/${env.APP_NAME}.war ${env.DEPLOY_BASE}/${params.DEPLOY_ENV}/
                    systemctl restart tomcat-${params.DEPLOY_ENV}
                """
            }
        }
        stage('Notification') {
            steps {
                emailext (
                    to: "${ADMIN_EMAIL}",
                    subject: "部署完成: ${env.APP_NAME} ${env.CURRENT_VERSION} 到 ${params.DEPLOY_ENV}",
                    body: """
                    <html>
                    <body>
                    <p>${env.APP_NAME} 已成功部署到 ${params.DEPLOY_ENV} 环境</p>
                    <p><strong>版本:</strong> ${env.CURRENT_VERSION}</p>
                    <p><strong>数据库:</strong> ${DB_URL}</p>
                    <p><strong>API端点:</strong> ${API_URL}</p>
                    <p>请进行必要的验证测试。</p>
                    <p>-- Jenkins自动化部署系统</p>
                    </body>
                    </html>
                    """
                )
            }
        }
    }
    post {
        always {
            echo "${env.APP_NAME} ${params.DEPLOY_ENV} 环境部署流程结束"
        }
    }
}