Получение списка ресурсов из директории classpath

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

Для оптимального получения ресурсов из classpath-директории рекомендуется обратиться к утилите PathMatchingResourcePatternResolver из Spring:

import org.springframework.core.io.support.PathMatchingResourcePatternResolver;
import org.springframework.core.io.Resource;

PathMatchingResourcePatternResolver резолвер = new PathMatchingResourcePatternResolver();
Resource[] ресурсы = резолвер.getResources("classpath*:ваша/директория/**");

for (Resource ресурс : ресурсы) {
    System.out.println(ресурс.getFilename());
}

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

Обширное рассмотрение методов получения ресурсов

Разберёмся в различных подходах, подходящих для решения специфических задач и соответствующих требованиям ваших проектов:

Поддержка с использованием Spring Framework

PathMatchingResourcePatternResolver — это мощный инструмент от Spring, обеспечивающий точное перечисление файлов в classpath.

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

Сканирование с применением Reflections

Пользуясь библиотекой Reflections можно осуществить быстрый поиск ресурсов в процессе компиляции.

Варианты работы с JAR-файлами

Технологии получения ресурсов различаются в зависимости от их месторасположения — в файловой системе или внутри JAR-файла.

Максимальное использование сторонних библиотек

Не тратьте время на создание уже известных решений. Spring, Apache CommonsIO и другие инструменты готовы придти на помощь.

getResourceAsStream и BufferedReader

Этот широко известный способ, предлагаемый JDK, подходит для решения многих задач, однако может замедлять выполнение в больших проектах.

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

С помощью метода getContextClassLoader() можно управлять потоками классов и их загрузчиками.

Использование регулярных выражений

Регулярные выражения — наше лучшее оружие для аккуратного фильтрации ресурсов по сложным шаблонам.

Учёт влияния на производительность

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

Проверка совместимости библиотек

Прежде чем выбрать определённое решение, ознакомьтесь с отзывами и убедитесь в совместимости используемых библиотек.

Работа с шаблонами ресурсов

Вам стоит овладеть шаблонами ресурсов для повышения гибкости работы с файлами:

Использование Reflections для исследования classpath

import org.reflections.Reflections;
import org.reflections.scanners.ResourcesScanner;

Reflections reflections = new Reflections("ваша/директория", new ResourcesScanner());
Set<String> путиРесурсов = reflections.getResources(Pattern.compile(".*"));
путиРесурсов.forEach(System.out::println);

Следите за обновлениями библиотеки Reflections, чтобы избежать ошибок.

Применение Apache Commons IO для работы с файлами

import org.apache.commons.io.FileUtils;

File dir = new File("src/main/resources/ваша/директория");
Collection<File> файлы = FileUtils.listFiles(dir, null, true);
файлы.forEach(System.out::println);

Хороший выбор, если ваши файлы не упакованы в JAR, а находятся в файловой системе.

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

Представьте процесс поиска ресурсов как поиск определённых фруктов в корзинах, разбросанных по комнате:

Комната: [🧺(Яблоки), 🧺(Бананы), 🧺(Апельсины), ...]

Каждый фрукт — это ресурс, корзина — директория, а комната — classpath:

| Директория ClassPath 📂     | Собранные ресурсы    |
| -------------------------- | -------------------- |
| /корзина_с_яблоками         | 🍎🍎🍎                |
| /корзина_с_бананами         | 🍌🍌🍌                |
| /корзина_с_апельсинами      | 🍊🍊🍊                |

Мы действуем как ниндзя, собирающие разнообразные фрукты в додзё classpath!

Результат: [🍎🍎🍎, 🍌🍌🍌, 🍊🍊🍊]
// Пустая корзина здесь не уместна!

Оптимальные стратегии для особых случаев

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

Определение местоположения ресурса

Если не уверены, где расположен ресурс, просто выясните его место:

String путь = "/ваша/директория";
URL dirURL = Thread.currentThread().getContextClassLoader().getResource(путь);
if (dirURL != null && dirURL.getProtocol().equals("file")) {
    // Метод для работы с файлами
} else if (dirURL != null && "jar".equals(dirURL.getProtocol())) {
    // Обработка Jar-файла
}

Аккуратный доступ к ресурсам в алфавитном порядке

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

List<Resource> отсортированныеРесурсы = Arrays.stream(ресурсы).sorted(Comparator.comparing(Resource::getFilename)).collect(Collectors.toList());
// Организованное хранение — это хорошо!

Использование ресурсов в Spring

Вы можете оптимально использовать возможности Spring для работы с ресурсами в контексте приложения:

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.core.io.ResourceLoader;

@Autowired
ResourceLoader загрузчикРесурсов;

public void используйтеSpringДляРаботыСРесурсами() {
    // И вот начинается волшебство...
}

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

1. ClassLoader (Java Platform SE 8) — Подробное руководство Oracle по ClassLoader.
2. Получение списка ресурсов из директории classpath – Stack Overflow — Обсуждения и решения от сообщества разработчиков.
3. Java ClassLoader | DigitalOcean — Обзор работы ClassLoader.
4. Spring Framework: работа с ресурсами — Руководство по работе с ресурсами в Spring.
5. Java Classloader – vogella — Глубокий анализ classloaders от vogella.
6. Понимание Java Class Loader — Глубинное изучение темы в блоге Oracle.
7. Сканирование classpath в Java – DZone — Анализ процедуры сканирования classpath от DZone.