基于Maven的Spring Boot应用版本号获取解析

引言

在Spring Boot应用的开发和部署中，了解应用的版本号对于管理和监控应用至关重要。本文将深入解析一种基于Maven打包的Spring Boot应用中，根据不同的运行环境获取应用版本号的解决方案。在开始介绍代码之前，我们先来了解一下可能的文件目录结构，以及获取版本号的思路。

文件目录结构

JAR包运行环境

假设我们的应用被打包成了一个名为 myapp.jar 的可执行 JAR 文件。

myapp.jar
│
├── META-INF
│   └── maven
│       └── group
│           └── artifact
│               └── pom.properties
│
├── com
│   └── example
│       └── MyApp.class
│
└── ...

在这个结构中，META-INF/maven/group/artifact/pom.properties 文件包含了版本号信息。

IDE或文件系统运行环境

在IDE或文件系统中，应用以类文件的形式存在，目录结构可能如下：

project-root
│
├── target
│   └── classes
│       ├── com
│       │   └── example
│       │       └── MyApp.class
│       │
│       └── ...
│
├── maven-archiver
│   └── pom.properties
│
└── ...

在这个结构中，target/classes 目录包含了编译后的类文件，而 maven-archiver/pom.properties 文件包含了版本号信息。

有了这两种可能的文件结构，我们可以更清晰地理解下面介绍的代码解决方案。

JAR包运行环境

在JAR包运行环境中，应用被打包成一个可执行的JAR文件。以下是获取版本号的代码实现和思路：

if (classPath.startsWith("jar:")) {
    return getVersionFromJar(clazz);
}

getVersionFromJar 方法

private String getVersionFromJar(Class<?> clazz) {
    ProtectionDomain protectionDomain = clazz.getProtectionDomain();
    CodeSource codeSource = protectionDomain.getCodeSource();
    try (JarFile jarFile = new JarFile(codeSource.getLocation().getPath())) {
        Enumeration<JarEntry> entries = jarFile.entries();
        while (entries.hasMoreElements()) {
            JarEntry entry = entries.nextElement();
            if (entry.getName().startsWith("META-INF/maven/") && entry.getName().endsWith("/pom.properties")) {
                return extractVersion(jarFile.getInputStream(entry));
            }
        }
    } catch (IOException e) {
        e.printStackTrace();
    }
    return null;
}

在JAR包中，我们通过ProtectionDomain和CodeSource获取JAR文件的路径，然后遍历JAR包中的条目，寻找包含版本信息的pom.properties文件。最终，调用extractVersion方法提取版本号。

IDE或文件系统运行环境

在IDE或文件系统运行环境中，应用通常以类文件的形式存在。以下是获取版本号的代码实现和思路：

else if (classPath.startsWith("file:")) {
    // 在IDE或文件系统中获取版本号
    // 省略部分代码...
}

获取文件路径

String basePath = classPath.substring(0, classPath.indexOf("/classes/"));
basePath = URLUtil.decode(FileUtil.normalize(basePath));

通过解析类文件的路径，我们可以得到应用在文件系统中的基本路径。

读取pom.properties文件

File propertiesFile = Paths.get(basePath, "maven-archiver", "pom.properties").toFile();
if (propertiesFile.exists()) {
    return extractVersion(FileUtil.getInputStream(propertiesFile));
}

根据基本路径构建pom.properties文件的路径，然后通过文件流获取其中的版本号信息。

结论

通过本文的介绍，我们详细解析了在不同环境下获取Spring Boot应用版本号的代码实现思路。这种灵活的解决方案能够确保在不同的部署环境中都能获取到正确的应用版本号，为开发者提供了更好的应用管理和监控手段。在实际应用中，可以根据这一思路进一步优化和定制，以适应特定的部署场景。