在 Java 中，如何在日志文件中包含动态版本信息？

Question

我可以使用自定义日志记录框架从 Java 应用程序记录字符串，如下所示：

logger.info("Version 1.2 of the application is currently running");

因此，当用户向我发送日志文件时，我可以轻松查看他们正在运行的应用程序版本。

上面代码的问题在于版本是硬编码在字符串文字中的，需要有人记住为每个版本更新它。 在发布时忘记更新此字符串是相当不可避免的。

我想做的是根据应用程序 JAR 的清单文件中的版本号之一自动更新此字符串文字：

Specification-Version: 1.2
Implementation-Version: 1.2.0.0

我不介意这种情况是在编译时还是在运行时发生，只要版本号获取到日志文件中。

Answer 1

获取该信息的标准方法是 SomeClass。类。getPackage().getImplementationVersion()。

您无需自行进行任何解析。

Answer 2

您可以使用以下类在运行时加载清单，

public class ManifestFinder {

    private final Class<?> _theClass;


    public ManifestFinder(Class<?> theClass) {

        _theClass = theClass;
    }


    public Manifest findManifest() throws MalformedURLException, IOException {

        String className = _theClass.getSimpleName();
        String classFileName = className + ".class";
        String pathToThisClass = _theClass.getResource(classFileName).toString();

        int mark = pathToThisClass.indexOf("!");
        String pathToManifest = pathToThisClass.toString().substring(0, mark + 1);
        pathToManifest += "/META-INF/MANIFEST.MF";
        return new Manifest(new URL(pathToManifest).openStream());

    }

}

解析清单中的数据（未经测试）

 String specificationVersion = manifest.getMainAttributes().getValue("Implementation-Version");

，然后将解析后的版本包含在日志语句中，

logger.info("Version " + specificationVersion + " of the application is currently running");

请参阅 Jar 文件规范 了解更多详细信息。

Answer 3

因此您可以使用 ClassLoader 在运行时加载 /META-INF/MANIFEST。 然后加载并解析Implementation-Version：

String welcome = String.format("Version %s of the application is currently running",
                          implementationVersion);
logger.info(welcome);