Как прочитать мой файл META-INF/MANIFEST.MF в приложении Spring Boot?

Я использую java.lang.Package для чтения атрибут 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)
    }
}

Просто добавьте это

    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»

Спасибо, Александр.

Практически все файлы jar поставляются с файлом манифеста, поэтому ваш код возвращает первый файл, который он может найти в пути к классам.

Зачем вам манифест в любом случае? Это файл, используемый Java. Поместите любые пользовательские значения, которые вам нужны, в другое место, например, в файл .properties рядом с вашим файлом .class.

Обновление 2

Как упоминалось в комментарии ниже, не в вопросе, реальной целью является информация о версии из манифеста. Java уже предоставляет эту информацию с помощью класса java.lang.Package. .

Не пытайтесь читать манифест самостоятельно, даже если сможете его найти.

Обновление 1

Обратите внимание, что файл манифеста не является файлом Properties. Его структура гораздо сложнее.

См. пример в документации по Java для файла JAR. Спецификация.

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, а ключи должны быть уникальными.

После тестирования и поиска в документации Spring я нашел способ прочитать файл манифеста.

Во-первых, Spring Boot реализует собственный ClassLoader, который изменяет способ загрузки ресурсов. Когда вы вызываете getResource(), Spring Boot загрузит первый ресурс, который соответствует заданному имени ресурса в списке всех JAR-файлов, доступных в пути к классу, и ваш jar-файл приложения не является первым выбором.

Итак, при выдаче команды типа:

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

Возвращается первый файл MANIFEST.MF, найденный в любой банке пути к классу. В моем случае это произошло из jar-библиотеки JDK.

РЕШЕНИЕ:

Мне удалось получить список всех JAR-файлов, загруженных приложением, которое содержит ресурс «/META-INF/MANIFEST.MF», и проверить, поступил ли ресурс из 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.mf внутри объекта Manifest.

Я позаимствовал часть решения из чтение файла MANIFEST.MF из jar-файла с помощью JAVA

Я использую разрешение ресурсов 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, и вы можете легко расширить пример для загрузки других атрибутов.

    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, оно не будет работать, если вы создадите интеграционный тест.