聊聊如何驗證線上的版本是符合預期的版本

語言: CN / TW / HK
時間 2022-05-03 15:15:19
主題:

前言

當我們想知道部署專案的哪個版本有問題？當我們想知道線上執行的版本是否是我們預期的版本？當我們想把部署的版本與程式碼進行關聯？如果是你用git來做版本管理，那就可以使用git-commit-id-maven-plugin外掛來實現上述功能。

git-commit-id-maven-plugin外掛，會根據當前分支的版本號生成一個git.properties檔案。git.properties內容形如下

java git.branch=master git.build.host=xxx git.build.time=2022-03-01T20\:33\:43+0800 [email protected] git.build.user.name=aaa git.build.version=1.0-SNAPSHOT git.closest.tag.commit.count= git.closest.tag.name= git.commit.id=6dab4430864e3e4a9fc1ba6f6b93f278100d4e2e git.commit.id.abbrev=6dab443 git.commit.id.describe=6dab443-dirty git.commit.id.describe-short=6dab443-dirty git.commit.message.full=Add README.md git.commit.message.short=Add README.md git.commit.time=2022-03-01T16\:24\:48+0800 [email protected] git.commit.user.name=aa git.dirty=true git.remote.origin.url=http://hello git.tags= git.total.commit.count=1

如何使用

本文以springboot專案為例，springboot專案的parent pom裡面已經內嵌git-commit-id-maven-plugin外掛管理依賴。如下

xml <pluginManagement> <plugins> <plugin> <groupId>pl.project13.maven</groupId> <artifactId>git-commit-id-plugin</artifactId> <executions> <execution> <goals> <goal>revision</goal> </goals> </execution> </executions> <configuration> <verbose>true</verbose> <dateFormat>yyyy-MM-dd'T'HH:mm:ssZ</dateFormat> <generateGitPropertiesFile>true</generateGitPropertiesFile> <generateGitPropertiesFilename>${project.build.outputDirectory}/git.properties</generateGitPropertiesFilename> </configuration> </plugin> </plugins> </pluginManagement>

因此我們的專案中可以做如下配置

1、在我們的專案中顯式引入git-commit-id-plugin外掛

java <build> <plugins> <plugin> <groupId>pl.project13.maven</groupId> <artifactId>git-commit-id-plugin</artifactId> </plugin> </plugins> </build>

2、通過和actuator整合，顯示git資訊

a、在專案中引入actuator GAV

xml <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-actuator</artifactId> </dependency>

b、瀏覽器訪問http://ip : port/actuator/info

如果覺得上面的資訊不夠多，我們可以通過自定義端點或者自己寫一個controller把資訊展示出來

詳細的資訊可以通過org.springframework.boot.info.GitProperties展示

本示例以自定義端點為例。示例如下

```java @Endpoint(id = "git") @Component public class GitEndpoint {

@Autowired(required = false)
private GitProperties gitProperties;

@ReadOperation
public Object info() throws IOException {

    if(ObjectUtils.isEmpty(gitProperties)){
        return new HashMap<>();
    }


    return gitProperties;
}

}

``` 在application.yml中開放自定義端點

yaml management: endpoints: web: exposure: include: 'git'

瀏覽器訪問http://ip : port/actuator/git 如果仍然覺得上述的資訊還是不夠詳細，那可以通過解析git.properties檔案顯示。示例

```java @Endpoint(id = "gitDetail") @Slf4j @Component public class GitDetailEndPoint {

@ReadOperation
public Object detail() throws IOException {


    Properties props = null;
    try {
        props = PropertiesLoaderUtils.loadAllProperties("git.properties");
        return props;
    } catch (IOException e) {
        log.error("git.properties not found");
    } finally {
    }
    return new HashMap<>();
}

}

``` 在application.yml中開放自定義端點

yaml management: endpoints: web: exposure: include: 'gitDetail'

瀏覽器訪問http://ip:port/actuator/gitDetail

總結

git-commit-id-maven-plugin在分散式或者微服務專案中，用來驗證專案版本還是挺有用的，推薦大家有機會用一下

demo連結

http://github.com/lyb-geek/springboot-learning/tree/master/springboot-git-commit

「」