SpringBoot: 读取项目的Git版本号

在开发项目的时候，我们经常会想要拿到线上运行的程序版本，以确定程序是否正确发布。Spring Boot提供了这样的能力支持。这个能力的核心组件是3个:

Maven插件git-commit-id-maven-plugin，用于生成.properties文件，里边包含git的各种信息
加载git.properties文件，ProjectInfoAutoConfiguration判断是否存在git的properties文件，注册GitProperties Bean
引用GitProperties Bean，读取git信息

1. 使用Maven插件

首先我们需要在pom.xml里引入插件，在build/plugins/plugin配置插件git-commit-id-maven-plugin的

XML 复制代码

<?xml version="1.0" encoding="UTF-8"?>

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">


    ...
    <build>
        <plugins>
            <plugin>
                <groupId>io.github.git-commit-id</groupId>
                <artifactId>git-commit-id-maven-plugin</artifactId>
                <configuration>
                    <generateGitPropertiesFile>true</generateGitPropertiesFile>
                    <generateGitPropertiesFilename>
                        ${project.build.outputDirectory}/git.properties
                    </generateGitPropertiesFilename>
                </configuration>
            </plugin>
            ...
        </plugins>
    </build>

</project>

执行插件git-commit-id:revision，查看生成的target，最终会在class目录下创建一个git.properties文件

bash 复制代码

mvn clean package git-commit-id:revision

看一下生成的git.properties文件，可以看到，里边不仅有版本号(commit.id)，还有分支(git.branch)，用户名(user.name)等信息

2. 加载git.properties文件

SpringBoot定义了一个AutoConfiguration类(ProjectInfoAutoConfiguration)，基于条件创建GitProperties对象。

1. 条件对象

GitResourceAvailableCondition通过环境变量spring.info.git.location获取git.proerties文件的路径。如果没有设置环境变量则直接查看classpath:git.properties。

获取配置文件的路径后，通过ResourceLoader#getResource(location)判断这个文件是否存在。

2. 创建Bean

ProjectInfoAutoConfiguration是一个AutoConfiguration类，定义了一个@Bean方法，创建一个GitProperties Bean。后续只需要引用这个Bean即可。

3. 引用GitProperties Bean

在我们的业务代码中只需要直接注入GitProperties Bean即可，GitProperties有5个核心方法:

getBranch，获取分支
getCommitId，获取提交版本号
getShortCommitId，获取短的提交版本号
get，按属性名读取git.properties文件，返回String类型
getInstant，按属性名读取git.properties文件，返回Instant类型