本文详细阐述了在jenkins中执行独立jar文件的最佳实践。内容涵盖jar文件的部署策略，包括使用版本控制系统或本地工作空间；以及如何高效、安全地管理命令行参数，特别是敏感信息和配置变量，通过jenkins参数化构建或外部属性文件注入等方法，确保自动化流程的顺畅与安全。
在Jenkins自动化流水线中执行独立的JAR应用程序是常见的需求。这通常涉及到JAR文件的部署位置、执行命令的配置以及如何安全有效地传递运行时参数。本文将提供一套专业的指南，涵盖从JAR文件获取到参数管理的完整流程。
一、JAR文件部署策略
将JAR文件引入Jenkins构建环境主要有两种推荐方式，直接上传JAR文件并非一个理想或推荐的选项，因为它缺乏版本控制和可追溯性。
-
通过版本控制系统或制品库获取（推荐） 这是最推荐的做法。将JAR文件（或其源代码，由Jenkins构建生成JAR）存储在版本控制系统（如Git、SVN）或专业的制品库（如Nexus、Artifactory）中。
- Git/SVN: 如果JAR是项目构建的产物，Jenkins可以克隆包含源代码的仓库，然后在构建过程中编译并打包生成JAR。如果JAR是预编译的依赖，可以直接将其提交到版本控制系统（尽管这通常不推荐，更推荐使用Maven/Gradle等依赖管理工具）。
- 制品库: 将编译好的JAR文件上传到Maven、Gradle等工具可访问的制品库中。Jenkins在构建时可以通过对应的构建工具（如Maven、Gradle）下载所需的JAR文件。 这种方式的优点在于：版本控制、可追溯性、易于管理依赖和协作。
-
放置在Jenkins代理或控制器的工作空间 另一种方法是将JAR文件直接放置在Jenkins运行构建的代理（Agent）或控制器（Controller）的本地文件系统中的特定路径下。
- 本地路径: 确保JAR文件位于Jenkins作业可以访问的固定路径。
- 优点: 简单直接，无需额外的仓库配置。
- 缺点: 缺乏版本控制，更新JAR需要手动替换文件，不便于大规模部署和团队协作。通常适用于开发测试环境或特定的一次性任务。
不推荐的做法：
- 直接上传JAR到Jenkins界面： Jenkins没有提供直接上传JAR文件的功能，即使有，这种方式也缺乏版本控制和管理能力，不符合持续集成的最佳实践。
二、执行JAR文件的Jenkins配置
一旦JAR文件可在Jenkins环境中访问，我们就可以通过“Execute Shell”构建步骤来运行它。
添加“Execute Shell”构建步骤 在Jenkins作业的“构建”部分，添加一个“Execute Shell”（或“Execute Windows batch command”）。
-
编写执行命令 使用Java命令行工具来执行JAR文件。
# 假设JAR文件在当前工作目录，或者指定完整路径 java -jar your-application.jar [command_line_arguments]
- your-application.jar: 你的可执行JAR文件的名称。
- [command_line_arguments]: 传递给JAR应用程序的参数。
示例： 如果JAR文件名为my-app.jar，且位于Jenkins工作空间的根目录：
java -jar my-app.jar --env=production --port=8080
三、命令行参数管理
在执行JAR文件时，经常需要传递各种参数，包括配置变量和敏感信息（如密码）。Jenkins提供了多种方式来管理这些参数。
-
使用Jenkins参数化构建 Jenkins的“This project is parameterized”选项允许你在构建开始前输入参数，这些参数随后可以在Shell命令中作为环境变量使用。
-
配置步骤：
在Shell中使用： Jenkins会将这些参数转换为环境变量。例如，如果你定义了一个名为ENV的String Parameter和一个名为DB_PASSWORD的Password Parameter，它们可以在Shell中通过$ENV和$DB_PASSWORD（或${ENV}和${DB_PASSWORD}）访问。
示例： 假设我们定义了以下Jenkins参数：
- ENV_NAME (String Parameter)
- APP_PORT (String Parameter)
- DB_PASS (Password Parameter)
Shell命令可以这样写：
echo "Executing application for environment: $ENV_NAME on port: $APP_PORT" java -jar my-app.jar --env=$ENV_NAME --port=$APP_PORT --db-password=$DB_PASS
注意事项： 尽管Password Parameter在Jenkins UI和日志中会被掩码，但在Shell脚本内部，它仍然是明文的。应避免在Shell中直接echo敏感信息。对于真正的生产环境密码，更推荐使用Jenkins凭据管理（Credentials Management）和Jenkins Secret Text/File插件。
-
-
通过外部属性文件注入（推荐用于复杂或敏感配置） 对于大量配置变量或需要更安全地管理敏感信息，将它们存储在一个外部属性文件（如.properties文件）中，并在Jenkins构建时注入，是一个更灵活和安全的方法。
-
创建属性文件： 在你的代码仓库中创建一个.properties文件（例如config.properties），包含所有配置变量。
# config.properties app.environment=production app.port=8080 db.username=admin db.password=secure_database_password # ⚠️ 敏感信息不应明文存储在仓库中，此处仅作示例 api.key=your_api_key
安全提示： 像db.password和api.key这样的敏感信息，不应该明文提交到版本控制系统。更安全的做法是：
- 将.properties文件提交到仓库，但敏感字段留空或使用占位符。
- 在Jenkins中通过“Inject environment variables”插件，结合Jenkins凭据管理，动态替换这些占位符。
-
Jenkins配置： 使用“EnvInject Plugin”（通常已集成或易于安装）或Jenkins Pipeline中的withEnv步骤来注入环境变量。
- 在构建步骤中，添加“Inject environment variables”构建步骤。
- 在“Properties File Path”中，指定你的.properties文件的路径（相对于工作空间）。
- Jenkins会将文件中的键值对作为环境变量注入到后续的构建步骤中。
-
在Shell中使用： 注入后，你可以像使用Jenkins参数一样，通过$PROPERTY_NAME访问这些变量。
# 假设config.properties中的变量已注入 echo "Running app in $app_environment mode on port $app_port" java -jar my-app.jar --env=$app_environment --port=$app_port --db-user=$db_username --db-password=$db_password
更安全的敏感信息处理： 结合Jenkins凭据管理。
- 在Jenkins中创建“Secret text”类型的凭据，存储数据库密码等。
- 在Jenkinsfile (Pipeline) 中，使用withCredentials来安全地暴露这些凭据作为环境变量。
pipeline { agent any stages { stage('Run JAR') { steps { script { // 假设 'my-db-password' 是一个Secret Text类型的凭据ID withCredentials([string(credentialsId: 'my-db-password', variable: 'DB_PASSWORD_SECRET')]) { sh """ echo "Executing JAR with secure password..." java -jar my-app.jar --env=production --db-password=$DB_PASSWORD_SECRET """ } } } } } }对于FreeStyle项目，可以使用“Secret Text”参数类型，或通过“EnvInject Plugin”结合“Inject passwords to the build as environment variables”选项。
-
四、总结与最佳实践
- JAR文件部署： 优先考虑将JAR文件及其源代码纳入版本控制系统，或通过制品库进行管理。这提供了版本控制、可追溯性和团队协作的便利。
- 执行命令： 使用“Execute Shell”步骤，以java -jar命令运行应用程序。
-
参数管理：
- 对于少量、非敏感的运行时变量，使用Jenkins的“参数化构建”功能。
- 对于大量配置或敏感信息，推荐使用外部属性文件结合Jenkins凭据管理和环境变量注入，以提高安全性和管理效率。
- 安全性： 永远不要将敏感信息（如密码、API密钥）明文提交到版本控制系统。利用Jenkins的凭据管理功能，并在运行时安全地注入这些值。
- 日志与错误处理： 确保你的JAR应用程序有良好的日志输出，并且Jenkins作业能捕获这些日志，以便于调试和监控。在Shell脚本中可以添加错误检查（如set -e）来确保脚本在命令失败时立即退出。
通过遵循这些最佳实践，你可以在Jenkins中高效、安全地自动化JAR应用程序的执行流程。
