Решение: Spring Boot не находит ресурсы в jar при сборке Maven

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

Чтобы избежать неприятных ситуаций с отсутствием ресурса classpath в архиве .jar, следует прибегнуть к применению метода getClass().getResourceAsStream("/path/to/resource"). Отметим важность начального слэша. Он указывает на то, что поиск ресурса начнется от корневой директории classpath:

InputStream resourceStream = getClass().getResourceAsStream("/path/to/resource");
if (resourceStream == null) {
    throw new RuntimeException("Ресурс не обнаружен!");  // Иногда призывы к небу бывают полезны.😉
}

Во избежание непредвиденных обстоятельств, убедитесь в корректности пути, и старайтесь не использовать классы File или FileInputStream, так как они не совместимы с содержимым .jar.

Область применения метода getFile() ограничена

Если речь идет о разработке, особенно когда проект запускается прямо из IDE, такой как STS (Spring Tool Suite), можно воспользоваться методом getFile() для доступа к ресурсам classpath. Но в случае с исполняемым JAR такой подход обречен на провал. getFile() пытается воспроизвести поведение при обращении к файловой системе и не способен работать с ресурсами, запакованными в .jar-файлы. Такая попытка приведет к ошибке java.io.FileNotFoundException.

Лучшие практики работы с ресурсами

• При использовании Spring Boot желательно использовать класс ClassPathResource, так как он предоставляет эффективный и удобный механизм взаимодействия с ресурсами classpath.
• Для чтения содержимого файла в виде массива байт хорошо подойдет FileCopyUtils.copyToByteArray().
• При преобразовании InputStream в строку всегда указывайте кодировку явно, например, StandardCharsets.UTF_8.
• Прежде чем собирать проект, убедитесь, что ресурсы включены в сборку и размещены правильно внутри .jar-файла.

Эффективная обработка исключений

Будьте готовы к встрече с IOException, используя для этого блоки try-catch. Это избавит от остановки программы при возникновении исключений и предотвратит утечки ресурсов. Если проверяемые исключения вызывают у вас отчуждение, всегда можно обернуть IOException в UncheckedIOException, чтобы обеспечить непрерывную передачу исключений.

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

Представьте, что вы потеряли инструмент в собственном ящике для инструментов🧰 и не можете его обнаружить.

Ящик для инструментов (🧰):
- Молоток (🔨)
- Отвертка (🔧)
- Гаечный ключ (🔩)

Теперь представьте, что после перемещения ящика некоторые инструменты выпали наружу:

Снаружи (🏚️): [🔩]

Запуск исполняемого файла формата .jar можно сравнить с поиском инструмента внутри этого ящика. Но его там нет.

🧰 ❌🔩
# Это волшебство! Программа не может обнаружить ресурс classpath (🔩), поскольку он ухитрился спрятаться снаружи (🧰)!

Корректное пакование ресурсов в .jar-файл обеспечивает их наличие при запросе.

Эффективное управление ресурсами для всех

Работа с текстовыми ресурсами

Для работы с текстовыми файлами идеально подходит комбинация BufferedReader и InputStreamReader:

InputStream is = getClass().getResourceAsStream("/path/to/resource");
BufferedReader reader = new BufferedReader(new InputStreamReader(is, StandardCharsets.UTF_8));

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

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

Динамичный подход к указанию путей

Старайтесь избегать жестких путей к ресурсам. Проявите инициативу и определите пути в файлах свойств, или же примените динамический подход, используя внедрение путей. Например, можно перечислить все файлы в формате *.json, которые находятся в ресурсных папках, следовательно, профессионалы делают это так:

ResourcePatternResolver resolver = ResourcePatternUtils.getResourcePatternResolver(new DefaultResourceLoader());
Resource[] resources = resolver.getResources("classpath:" + location + "/*.json");

Отладка для новичков: эффективное логирование

Если вы столкнулись с трудноразрешимой проблемой, логгирование может стать вашим надежным спутником. Правильное использование логгера поможет отслеживать исключения и упростит диагностику проблем.

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

1. Zip File System Provider — Ознакомьтесь с осobенностями доступа к файловой системе JAR посредством API NIO.2.
2. ClassLoader (Java Platform SE 8 ) — Официальная документация Java по загрузчикам классов поможет вам лучше понять механизм поиска ресурсов в JAR.
3. Core Features — Подробно о том, как Spring Boot управляет доступом к ресурсам внутри приложения, включая работу с JAR-файлами.
4. File I/O (Featuring NIO.2) — Базовые операции с файлами, включая использование NIO.2, которые могут оказаться вам полезны при работе с ресурсами в JAR.
5. Apache Maven Shade Plugin – Introduction — Узнайте, как использовать плагин Shade от Maven для создания исполняемого JAR, включающего все необходимые зависимости, что является одной из причин недоступности ресурсов.