如何在 Spring Boot 应用程序中读取我的 META-INF/MANIFEST.MF 文件？

Question

我正在尝试从我的 Spring Boot Web 应用程序中读取我的 META-INF/MANIFEST.MF 文件（包含在一个 jar 文件中）。

我正在尝试以下代码：

        InputStream is = getClass().getResourceAsStream("/META-INF/MANIFEST.MF");

        Properties prop = new Properties();
        prop.load( is );

但显然在 Spring Boot 的幕后有一些东西加载了不同的 manifest.mf（而不是我自己的位于 META-INF 文件夹中）。

有人知道如何在 Spring Boot 应用中读取清单应用吗？

更新：经过一些研究，我注意到使用通常的方式读取 manifest.mf 文件，在 Spring Boot 应用程序中，这是正在访问的 Jar

org.springframework.boot.loader.jar.JarFile

Answer 1

几乎所有 jar 文件都带有清单文件，因此您的代码返回 第一个文件，它可以在 类路径中找到它。

为什么你仍然想要清单？这是Java使用的文件。将您需要的任何自定义值放在其他位置，例如在您旁边的 .properties 文件中 .class 文件中。

更新 2

正如下面评论中提到的，不是在问题中，真正的目标是清单中的版本信息。 Java 已经通过 java.lang.Package 类提供了该信息。

不要试图自己阅读清单，即使你能找到它。

更新 1

请注意，清单文件不是Properties 文件。它的结构比这复杂得多。

请参阅JAR File Specification 的 java 文档中的示例。

Manifest-Version: 1.0
Created-By: 1.7.0 (Sun Microsystems Inc.)

Name: common/class1.class
SHA-256-Digest: (base64 representation of SHA-256 digest)

Name: common/class2.class
SHA1-Digest: (base64 representation of SHA1 digest)
SHA-256-Digest: (base64 representation of SHA-256 digest)

如您所见，Name 和 SHA-256-Digest 不止一次出现。 Properties 类无法处理这个问题，因为它只是一个 Map 并且键必须是唯一的。

Answer 2

public Properties readManifest() throws IOException {
    Object inputStream = this.getClass().getProtectionDomain().getCodeSource().getLocation().getContent();
    JarInputStream jarInputStream = new JarInputStream((InputStream) inputStream);
    Manifest manifest = jarInputStream.getManifest();
    Attributes attributes = manifest.getMainAttributes();
    Properties properties = new Properties();
    properties.putAll(attributes);
    return properties;
}

Answer 3

添加这个很简单

    InputStream is = this.getClass().getClassLoader().getResourceAsStream("META-INF/MANIFEST.MF");

    Properties prop = new Properties();
    try {
        prop.load( is );
    } catch (IOException ex) {
        Logger.getLogger(IndexController.class.getName()).log(Level.SEVERE, null, ex);
    }

为我工作。

注意：

getClass().getClassLoader() 很重要

和

“META-INF/MANIFEST.MF”不是“/META-INF/MANIFEST.MF”

谢谢 亚历山大

Answer 4

在对 Spring 文档进行测试和搜索后，我找到了一种读取清单文件的方法。

首先，Spring Boot 实现了自己的 ClassLoader，它改变了资源的加载方式。当您调用getResource() 时，Spring Boot 将加载与类路径中所有可用 JAR 列表中给定资源名称匹配的第一个资源，并且您的应用程序 jar 不是首选。

所以，当发出类似这样的命令时：

getClassLoader().getResourceAsStream("/META-INF/MANIFEST.MF");

返回在类路径的任何 Jar 中找到的第一个 MANIFEST.MF 文件。在我的例子中，它来自一个 JDK jar 库。

解决方案：

我设法获得了包含资源“/META-INF/MANIFEST.MF”的应用程序加载的所有 jar 的列表，并检查了资源是否来自我的应用程序 jar。如果是这样，请读取其 MANIFEST.MF 文件并返回应用程序，如下所示：

private Manifest getManifest() {
    // get the full name of the application manifest file
    String appManifestFileName = this.getClass().getProtectionDomain().getCodeSource().getLocation().toString() + JarFile.MANIFEST_NAME;

    Enumeration resEnum;
    try {
        // get a list of all manifest files found in the jars loaded by the app
        resEnum = Thread.currentThread().getContextClassLoader().getResources(JarFile.MANIFEST_NAME);
        while (resEnum.hasMoreElements()) {
            try {
                URL url = (URL)resEnum.nextElement();
                // is the app manifest file?
                if (url.toString().equals(appManifestFileName)) {
                    // open the manifest
                    InputStream is = url.openStream();
                    if (is != null) {
                        // read the manifest and return it to the application
                        Manifest manifest = new Manifest(is);
                        return manifest;
                    }
                }
            }
            catch (Exception e) {
                // Silently ignore wrong manifests on classpath?
            }
        }
    } catch (IOException e1) {
        // Silently ignore wrong manifests on classpath?
    }
    return null;
}

此方法将返回 Manifest 对象内 manifest.mf 文件中的所有数据。

我从reading MANIFEST.MF file from jar file using JAVA借了部分解决方案

Answer 5

我使用java.lang.Package 从清单中读取spring boot 中的Implementation-Version 属性。

String version = Application.class.getPackage().getImplementationVersion();

Implementation-Version属性应该配置在build.gradle中

jar {
    baseName = "my-app"
    version =  "0.0.1"
    manifest {
        attributes("Implementation-Version": version)
    }
}

Answer 6

我有它利用 Spring 的资源解析：

@Service
public class ManifestService {

    protected String ciBuild;

    public String getCiBuild() { return ciBuild; }

    @Value("${manifest.basename:/META-INF/MANIFEST.MF}")
    protected void setManifestBasename(Resource resource) {
        if (!resource.exists()) return;
        try (final InputStream stream = resource.getInputStream()) {
            final Manifest manifest = new Manifest(stream);
            ciBuild = manifest.getMainAttributes().getValue("CI-Build");
        }
        catch (IOException e) {
            throw new RuntimeException(e);
        }
    }

}

这里我们得到CI-Build，您可以轻松扩展示例以加载其他属性。

Answer 7

    try {
        final JarFile jarFile = (JarFile) this.getClass().getProtectionDomain().getCodeSource().getLocation().getContent();
        final Manifest manifest = jarFile.getManifest();
        final Map<Object, Object> manifestProps = manifest.getMainAttributes().entrySet().stream()
                .collect(Collectors.toMap(entry -> entry.getKey(), entry -> entry.getValue()));
    ...
    } catch (final IOException e) {
        LOG.error("Unable to read MANIFEST.MF", e);
        ...
    }

这只有在你通过java -jar 命令启动你的应用程序时才有效，如果创建一个集成测试它就不起作用。