Чтение собственного Manifest из Jar в Java: решение для OSGi

Быстрый ответ

Для получения значений атрибутов манифеста JAR-файла можно использовать следующий код:

Manifest manifest = new Manifest(getClass().getResourceAsStream("/META-INF/MANIFEST.MF"));
String attributeValue = manifest.getMainAttributes().getValue("Attribute-Key");

Значение "Attribute-Key" следует заменить на имя требуемого атрибута из манифеста. Код должен выполняться внутри класса, содержащегося в JAR-файле.

Проверка источника загрузки класса

Прежде чем работать с манифестом, убедитесь, что ваш класс был загружен из JAR-файла. Проверка URL поможет в этом:

URL jarUrl = YourClass.class.getResource(YourClass.class.getSimpleName() + ".class");
if (jarUrl != null && jarUrl.toString().startsWith("jar:")) {
    // Класс загружен из JAR-файла, это важно учитывать!
}

Прямой доступ через JarURLConnection

Для прямого доступа к манифесту используйте JarURLConnection:

JarURLConnection jarConnection = (JarURLConnection)jarUrl.openConnection();
Manifest manifest = jarConnection.getManifest();

Этот метод работает, если URL соответствует протоколу "jar".

Использование jcabi для упрощения

Если хочется минимизировать число написанных строчек кода, библиотека jcabi-manifests может упростить процесс чтения атрибутов:

String attrValue = Manifests.read("My-Attribute");

Теперь получение значений атрибутов манифеста стало гораздо проще.

Извлечение информации из Java пакета

Java API предоставляет доступ к информации манифеста через метаданные пакета:

Package pkg = YourClass.class.getPackage();
String implVersion = pkg.getImplementationVersion();
String implTitle = pkg.getImplementationTitle();
// Таким образом, можно получить информацию о пакете.

Эта информация особенно ценна при получении информации о версии пакета.

Работа с нестандартными загрузчиками классов

Нестандартные загрузчики классов, такие как OSGi или JBoss VFS, в своем поведении могут быть недостаточно предсказуемы:

// Допустим, у нас есть VFS URL
URL vfsUrl = ...; 
if (vfsUrl.toString().startsWith("vfs:/")) {
    // Здесь могут требоваться хитрости при работе с URL, аналогично фокусам с шляпой мага!
}

Навигация в среде OSGi

В OSGi-среде важно учесть особенности экспорта пакетов, например, в Apache Felix.

Особенности работы в ограниченных средах

При работе в ограниченной среде, такой как апплеты или Java Web Start, следует учесть, что доступ к манифесту может быть затруднён. Не отчаивайтесь и ищите способы решения проблемы.

Визуализация

Можно представить чтение манифеста как открытие вложенных сундуков, в самом последнем из которых находится манифест:

Использование JAR-файлов в роли вложенных сундуков:
- Большой сундук (JAR) -> Средний сундук (Класс) -> Малый сундук (Область защиты) -> Миниатюрный сундук (Исходный код) -> Сокровище (Манифест)

// Код для открытия каждого сундука:
YourClass.class.getProtectionDomain().getCodeSource().getLocation().openStream();

С каждым открытых сундуком вы приближаетесь к цели:
[🔒🔓] --> [🔒🔓] --> [🔒🔓] --> [💎 Манифест]

Это похоже на увлекательную ролевую игру, в которой каждый сундук приближает нас к сокровищу, спрятанному в сердце JAR-файла.

Обработка крайних случаев

Случай с некорректным манифестом

Важно внимательно относиться к содержимому пути класса и проверять URL, чтобы избежать ошибки с неправильным манифестом.

Подробнее об этом расскажет наш спикер на видео

Характеристики OSGi атрибутов

В контексте OSGi атрибут Export-Package играет ключевую роль при экспорте пакетов и работы с бандлами.

Ограниченные зоны и атрибуты

В зонах с повышенной безопасностью доступ к манифесту может быть затруднён, тут может потребоваться изобретательность и использование альтернативного подхода.

Полезные материалы

1. Документация JDK 21 — официальная документация Java.
2. Чтение манифеста Jar-файла – Stack Overflow — обсуждение на тематическом ресурсе.
3. Руководство по манифесту Java – Baeldung — подробное описание манипуляции с манифестом.
4. Чтение manifest.mf из jar – Mkyong — практические рекомендации и обзоры.
5. Gist – Пример чтения манифеста Jar — рабочий код для использования в качестве образца.
6. Создание и использование Java манифеста – DZone — основы создания манифеста Java.