SpringBoot读取项目的Git版本号

SEO Meta Description: 了解如何在Spring Boot项目中读取Git版本号，通过详细的配置和代码示例，掌握版本信息管理技巧，提升项目可维护性和可追溯性。

介绍

在软件开发中，版本管理是确保代码可追溯性和可维护性的关键。特别是在Spring Boot项目中，自动读取和显示Git版本号对于调试和部署非常有帮助。本文将详细介绍如何在Spring Boot项目中读取Git版本号，提供完整的配置和代码示例，帮助开发者轻松实现这一功能。

使用Git插件生成版本信息

引入插件

为了在Spring Boot项目中读取Git版本号，我们需要使用 git-commit-id-plugin插件。首先，在 pom.xml中添加插件配置：

<project>
  ...
  <build>
    <plugins>
      ...
      <plugin>
        <groupId>pl.project13.maven</groupId>
        <artifactId>git-commit-id-plugin</artifactId>
        <version>4.0.4</version>
        <executions>
          <execution>
            <goals>
              <goal>revision</goal>
            </goals>
          </execution>
        </executions>
      </plugin>
      ...
    </plugins>
  </build>
  ...
</project>

该插件会在构建过程中生成一个包含Git信息的 git.properties文件，放置在 target/classes目录下。

配置插件

在 pom.xml中进一步配置 git-commit-id-plugin插件，以便生成所需的Git信息：

<project>
  ...
  <build>
    <plugins>
      ...
      <plugin>
        <groupId>pl.project13.maven</groupId>
        <artifactId>git-commit-id-plugin</artifactId>
        <version>4.0.4</version>
        <configuration>
          <generateGitPropertiesFile>true</generateGitPropertiesFile>
          <generateGitPropertiesFilename>git.properties</generateGitPropertiesFilename>
        </configuration>
        <executions>
          <execution>
            <goals>
              <goal>revision</goal>
            </goals>
          </execution>
        </executions>
      </plugin>
      ...
    </plugins>
  </build>
  ...
</project>

读取Git版本信息

配置文件

Spring Boot自动读取 git.properties文件。为了在应用中方便地访问这些信息，可以创建一个配置类来加载这些属性。

创建配置类

在项目中创建一个配置类，用于加载Git信息：

import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;

@Component
public class GitProperties {

    @Value("${git.commit.id.abbrev}")
    private String commitId;

    @Value("${git.branch}")
    private String branch;

    @Value("${git.commit.time}")
    private String commitTime;

    // Getters
    public String getCommitId() {
        return commitId;
    }

    public String getBranch() {
        return branch;
    }

    public String getCommitTime() {
        return commitTime;
    }
}

创建REST接口

创建一个REST控制器，用于提供Git版本信息：

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class GitInfoController {

    @Autowired
    private GitProperties gitProperties;

    @GetMapping("/git-info")
    public GitProperties getGitInfo() {
        return gitProperties;
    }
}

完整的Spring Boot应用

以下是完整的Spring Boot应用示例，包含了上述配置和代码：

pom.xml

<project>
  ...
  <build>
    <plugins>
      <plugin>
        <groupId>pl.project13.maven</groupId>
        <artifactId>git-commit-id-plugin</artifactId>
        <version>4.0.4</version>
        <configuration>
          <generateGitPropertiesFile>true</generateGitPropertiesFile>
          <generateGitPropertiesFilename>git.properties</generateGitPropertiesFilename>
        </configuration>
        <executions>
          <execution>
            <goals>
              <goal>revision</goal>
            </goals>
          </execution>
        </executions>
      </plugin>
    </plugins>
  </build>
  ...
</project>

GitProperties.java

import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;

@Component
public class GitProperties {

    @Value("${git.commit.id.abbrev}")
    private String commitId;

    @Value("${git.branch}")
    private String branch;

    @Value("${git.commit.time}")
    private String commitTime;

    public String getCommitId() {
        return commitId;
    }

    public String getBranch() {
        return branch;
    }

    public String getCommitTime() {
        return commitTime;
    }
}

GitInfoController.java

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class GitInfoController {

    @Autowired
    private GitProperties gitProperties;

    @GetMapping("/git-info")
    public GitProperties getGitInfo() {
        return gitProperties;
    }
}

运行和验证

构建并运行Spring Boot应用：

mvn clean install
mvn spring-boot:run

在浏览器中访问 http://localhost:8080/git-info，你将看到类似如下的JSON响应：

{
  "commitId": "abcdef1",
  "branch": "main",
  "commitTime": "2023-06-01T12:34:56Z"
}

分析说明表

结论

通过使用 git-commit-id-plugin插件和Spring Boot的自动配置功能，我们可以轻松地在Spring Boot项目中读取和展示Git版本信息。这不仅有助于调试和部署，还能提升项目的可追溯性和维护性。通过本文的详细步骤和代码示例，开发者可以快速实现这一功能，确保在项目的每个版本中都能准确追踪Git版本信息。