如何通过Spring Boot读取GitLab CI/CD预定义变量

嗨，针对你提出的几个问题，我整理了实用的解决方案和建议，咱们一步步来看：

一、直接从环境变量读取GitLab CI变量的简便方法 #

GitLab CI会自动将CI_COMMIT_BRANCH、CI_PIPELINE_ID这类变量注入到作业的运行环境中，Spring Boot可以直接通过以下两种方式读取：

1. 使用@Value注解
   在你的Bean类中直接注入变量：

   import org.springframework.beans.factory.annotation.Value;
   import org.springframework.stereotype.Component;
   
   @Component
   public class CiInfoReader {
       @Value("${CI_COMMIT_BRANCH:unknown}") // 冒号后是默认值，防止变量不存在时报错
       private String commitBranch;
   
       @Value("${CI_PIPELINE_ID:unknown}")
       private String pipelineId;
   
       // 后续可以通过get方法对外提供这些值
   }
   

2. 通过Environment对象读取
   如果你需要更灵活的读取方式（比如动态判断变量是否存在），可以注入Environment：

   import org.springframework.core.env.Environment;
   import org.springframework.stereotype.Component;
   
   @Component
   public class CiInfoReader {
       private final Environment env;
   
       public CiInfoReader(Environment env) {
           this.env = env;
       }
   
       public String getCommitBranch() {
           return env.getProperty("CI_COMMIT_BRANCH", "unknown");
       }
   
       public String getPipelineId() {
           return env.getProperty("CI_PIPELINE_ID", "unknown");
       }
   }
   

另外，你已经在用Actuator，访问/actuator/env端点就能看到所有可用的环境变量，包括GitLab CI注入的这些，方便调试验证。

二、git-commit-id-plugin在生产环境的可用性 #

完全可以放心在生产环境使用这个插件！它是一个成熟的开源工具，被大量Spring Boot项目用于嵌入Git版本信息，优势很明显：

• 打包时就将Git信息（分支、提交ID、提交时间等）写入到项目中，不需要依赖部署环境的变量，即使部署到没有GitLab CI变量的服务器，也能查看版本信息；
• 可以轻松整合到Actuator的/actuator/info端点，方便运维查看应用的版本溯源；
• 配置灵活，可以过滤敏感信息，只保留需要的内容。

给你一个Gradle的基础配置示例：

plugins {
    id 'java'
    id 'org.springframework.boot' version '3.x.x'
    id 'io.spring.dependency-management' version '1.x.x'
    id 'pl.project13.spring.boot.git-commit-id-plugin' version '5.x.x'
}

gitCommitId {
    // 配置要生成的信息，比如包含分支、提交ID等
    includeBranch = true
    includeCommitId = true
    // 可以指定生成的properties文件位置
    gitPropertiesFile = file("src/main/resources/git.properties")
}

之后你就能通过@Value("${git.branch:unknown}")读取分支信息，或者直接通过/actuator/info查看（需要在application.properties中开启management.info.git.enabled=true）。

三、直接读环境变量VS写入文件的选择 #

这两种方案各有适用场景，你可以根据需求来选：

• 直接读环境变量：适合只在CI作业运行期间需要这些变量的场景（比如CI阶段的测试、验证逻辑），优点是简单不需要额外配置，但如果把应用部署到非CI环境，这些变量就会丢失；
• 写入文件后读取：适合需要在生产部署后依然能查看CI流水线信息的场景。你可以在GitLab CI的脚本阶段把变量写入到一个配置文件（比如application-ci.properties），然后打包到Jar中，示例CI脚本：

  echo "ci.commit.branch=${CI_COMMIT_BRANCH}" >> src/main/resources/application-ci.properties
  echo "ci.pipeline.id=${CI_PIPELINE_ID}" >> src/main/resources/application-ci.properties
  

  之后在Spring Boot中通过@Value("${ci.commit.branch:unknown}")读取即可。

总结一下：如果只需要CI运行时的临时变量，直接读环境变量最方便；如果需要长期保留CI信息，用git-commit-id-plugin（侧重Git版本）或者写入文件（侧重CI流水线信息）更合适。

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