Получить список ресурсов из каталога classpath - PullRequest
Новая
       29

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

215 голосов
/ 13 октября 2010

Я ищу способ получить список всех имен ресурсов из заданного каталога classpath, что-то вроде метода List<String> getResourceNames (String directoryName).

Например, заданный каталог classpath x/y/z, содержащий файлы a.html, b.html, c.html и подкаталог d, getResourceNames("x/y/z") должен возвращать List<String>, содержащий следующие строки: ['a.html', 'b.html', 'c.html', 'd'].

Он должен работать как для ресурсов в файловой системе, так и для файловой системы.jars.

Я знаю, что могу написать быстрый фрагмент с File s, JarFile s и URL s, но я не хочу изобретать велосипед.Мой вопрос, учитывая существующие общедоступные библиотеки, каков самый быстрый способ реализации getResourceNames?Стеки Spring и Apache Commons возможны.

Ответы [ 11 ]

151 голосов
/ 13 октября 2010

Пользовательский сканер

Реализация собственного сканера.Например: 

private List<String> getResourceFiles(String path) throws IOException {
    List<String> filenames = new ArrayList<>();

    try (
            InputStream in = getResourceAsStream(path);
            BufferedReader br = new BufferedReader(new InputStreamReader(in))) {
        String resource;

        while ((resource = br.readLine()) != null) {
            filenames.add(resource);
        }
    }

    return filenames;
}

private InputStream getResourceAsStream(String resource) {
    final InputStream in
            = getContextClassLoader().getResourceAsStream(resource);

    return in == null ? getClass().getResourceAsStream(resource) : in;
}

private ClassLoader getContextClassLoader() {
    return Thread.currentThread().getContextClassLoader();
}

Spring Framework

Использование PathMatchingResourcePatternResolver от Spring Framework.

Ronmamo Reflections

Другойметоды могут быть медленными во время выполнения для огромных значений CLASSPATH.Более быстрое решение заключается в использовании API отражений от ronmamo, который прекомпилирует поиск во время компиляции.

47 голосов
/ 13 октября 2010

Вот код
Источник : forums.devx.com/showthread.php?t=153784

import java.io.File;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Enumeration;
import java.util.regex.Pattern;
import java.util.zip.ZipEntry;
import java.util.zip.ZipException;
import java.util.zip.ZipFile;

/**
 * list resources available from the classpath @ *
 */
public class ResourceList{

    /**
     * for all elements of java.class.path get a Collection of resources Pattern
     * pattern = Pattern.compile(".*"); gets all resources
     * 
     * @param pattern
     *            the pattern to match
     * @return the resources in the order they are found
     */
    public static Collection<String> getResources(
        final Pattern pattern){
        final ArrayList<String> retval = new ArrayList<String>();
        final String classPath = System.getProperty("java.class.path", ".");
        final String[] classPathElements = classPath.split(System.getProperty("path.separator"));
        for(final String element : classPathElements){
            retval.addAll(getResources(element, pattern));
        }
        return retval;
    }

    private static Collection<String> getResources(
        final String element,
        final Pattern pattern){
        final ArrayList<String> retval = new ArrayList<String>();
        final File file = new File(element);
        if(file.isDirectory()){
            retval.addAll(getResourcesFromDirectory(file, pattern));
        } else{
            retval.addAll(getResourcesFromJarFile(file, pattern));
        }
        return retval;
    }

    private static Collection<String> getResourcesFromJarFile(
        final File file,
        final Pattern pattern){
        final ArrayList<String> retval = new ArrayList<String>();
        ZipFile zf;
        try{
            zf = new ZipFile(file);
        } catch(final ZipException e){
            throw new Error(e);
        } catch(final IOException e){
            throw new Error(e);
        }
        final Enumeration e = zf.entries();
        while(e.hasMoreElements()){
            final ZipEntry ze = (ZipEntry) e.nextElement();
            final String fileName = ze.getName();
            final boolean accept = pattern.matcher(fileName).matches();
            if(accept){
                retval.add(fileName);
            }
        }
        try{
            zf.close();
        } catch(final IOException e1){
            throw new Error(e1);
        }
        return retval;
    }

    private static Collection<String> getResourcesFromDirectory(
        final File directory,
        final Pattern pattern){
        final ArrayList<String> retval = new ArrayList<String>();
        final File[] fileList = directory.listFiles();
        for(final File file : fileList){
            if(file.isDirectory()){
                retval.addAll(getResourcesFromDirectory(file, pattern));
            } else{
                try{
                    final String fileName = file.getCanonicalPath();
                    final boolean accept = pattern.matcher(fileName).matches();
                    if(accept){
                        retval.add(fileName);
                    }
                } catch(final IOException e){
                    throw new Error(e);
                }
            }
        }
        return retval;
    }

    /**
     * list the resources that match args[0]
     * 
     * @param args
     *            args[0] is the pattern to match, or list all resources if
     *            there are no args
     */
    public static void main(final String[] args){
        Pattern pattern;
        if(args.length < 1){
            pattern = Pattern.compile(".*");
        } else{
            pattern = Pattern.compile(args[0]);
        }
        final Collection<String> list = ResourceList.getResources(pattern);
        for(final String name : list){
            System.out.println(name);
        }
    }
}

Если вы используете Spring, посмотрите на PathMatchingResourcePatternResolver

17 голосов
/ 14 декабря 2015

Использование Google Reflections:

Получить все на пути к классам: 

Reflections reflections = new Reflections(null, new ResourcesScanner());
Set<String> resourceList = reflections.getResources(x -> true);

Другой пример - получить все файлы с расширением .csv из some.package : 

Reflections reflections = new Reflections("some.package", new ResourcesScanner());
Set<String> fileNames = reflections.getResources(Pattern.compile(".*\\.csv"));
15 голосов
/ 19 ноября 2013

Если вы используете Apache commonsIO, вы можете использовать для файловой системы (опционально с расширением фильтра): 

Collection<File> files = FileUtils.listFiles(new File("directory/"), null, false);

и для ресурсов / classpath: 

List<String> files = IOUtils.readLines(MyClass.class.getClassLoader().getResourceAsStream("directory/"), Charsets.UTF_8);

Если вы этого не сделаетезнать, находится ли "directoy /" в файловой системе или в ресурсах, вы можете добавить 

if (new File("directory/").isDirectory())

или 

if (MyClass.class.getClassLoader().getResource("directory/") != null)

перед вызовами и использовать оба в комбинации ...

11 голосов
/ 09 апреля 2015

Так что с точки зрения PathMatchingResourcePatternResolver это то, что нужно в коде: 

@Autowired
ResourcePatternResolver resourceResolver;

public void getResources() {
  resourceResolver.getResources("classpath:config/*.xml");
}
5 голосов
/ 06 января 2018

Spring framework PathMatchingResourcePatternResolver действительно хорош для этих вещей: 

private Resource[] getXMLResources() throws IOException
{
    ClassLoader classLoader = MethodHandles.lookup().getClass().getClassLoader();
    PathMatchingResourcePatternResolver resolver = new PathMatchingResourcePatternResolver(classLoader);

    return resolver.getResources("classpath:x/y/z/*.xml");
}

Зависимость Maven: 

<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-core</artifactId>
    <version>LATEST</version>
</dependency>
5 голосов
/ 29 апреля 2015

Использовал комбинацию ответа Роба.

final String resourceDir = "resourceDirectory/";
List<String> files = IOUtils.readLines(Thread.currentThread.getClass().getClassLoader().getResourceAsStream(resourceDir), Charsets.UTF_8);

for(String f : files){
  String data= IOUtils.toString(Thread.currentThread.getClass().getClassLoader().getResourceAsStream(resourceDir + f));
  ....process data
}
2 голосов
/ 10 января 2018

Это должно работать (если весна не вариант): 

public static List<String> getFilenamesForDirnameFromCP(String directoryName) throws URISyntaxException, UnsupportedEncodingException, IOException {
    List<String> filenames = new ArrayList<>();

    URL url = Thread.currentThread().getContextClassLoader().getResource(directoryName);
    if (url != null) {
        if (url.getProtocol().equals("file")) {
            File file = Paths.get(url.toURI()).toFile();
            if (file != null) {
                File[] files = file.listFiles();
                if (files != null) {
                    for (File filename : files) {
                        filenames.add(filename.toString());
                    }
                }
            }
        } else if (url.getProtocol().equals("jar")) {
            String dirname = directoryName + "/";
            String path = url.getPath();
            String jarPath = path.substring(5, path.indexOf("!"));
            try (JarFile jar = new JarFile(URLDecoder.decode(jarPath, StandardCharsets.UTF_8.name()))) {
                Enumeration<JarEntry> entries = jar.entries();
                while (entries.hasMoreElements()) {
                    JarEntry entry = entries.nextElement();
                    String name = entry.getName();
                    if (name.startsWith(dirname) && !dirname.equals(name)) {
                        URL resource = Thread.currentThread().getContextClassLoader().getResource(name);
                        filenames.add(resource.toString());
                    }
                }
            }
        }
    }
    return filenames;
}
1 голос
/ 07 ноября 2018

С весной это легко. Будь то файл, папка или даже несколько файлов, есть вероятность, что вы можете сделать это с помощью инъекции.

В этом примере демонстрируется внедрение нескольких файлов, расположенных в папке x/y/z. 

import org.springframework.beans.factory.annotation.Value;
import org.springframework.core.io.Resource;
import org.springframework.stereotype.Service;

@Service
public class StackoverflowService {
    @Value("classpath:x/y/z/*")
    private Resource[] resources;

    public List<String> getResourceNames() {
        return Arrays.stream(resources)
                .map(Resource::getFilename)
                .collect(Collectors.toList());
    }
}

Он работает для ресурсов как в файловой системе, так и в JAR-файлах.

0 голосов
/ 29 марта 2019

Я думаю, что вы можете использовать [ Zip File System Provider ] [1] для достижения этой цели. При использовании FileSystems.newFileSystem похоже, что вы можете рассматривать объекты в этом ZIP как "обычный" файл.

В приведенной выше документации:

Укажите параметры конфигурации для файловой системы zip в объекте java.util.Map, переданном методу FileSystems.newFileSystem. Информацию о свойствах конфигурации конкретного провайдера для файловой системы zip см. В разделе [Свойства системы Zip-файлов] [2].

Получив экземпляр файловой системы zip, вы можете вызывать методы классов [java.nio.file.FileSystem] [3] и [java.nio.file.Path] [4] для выполнения таких операций, как копирование, перемещение и переименование. файлы, а также изменение атрибутов файла.

Документация для модуля jdk.zipfs в [состояниях Java 11] [5]:

Поставщик файловой системы zip рассматривает файл zip или JAR как файловую систему и предоставляет возможность манипулировать содержимым файла. Поставщик файловой системы zip может быть создан с помощью [FileSystems.newFileSystem] [6], если он установлен.

Вот надуманный пример, который я сделал, используя ваши примеры ресурсов. Обратите внимание, что .zip - это .jar, но вы можете адаптировать свой код, чтобы вместо этого использовать ресурсы classpath:

Настройка 

cd /tmp
mkdir -p x/y/z
touch x/y/z/{a,b,c}.html
echo 'hello world' > x/y/z/d
zip -r example.zip x

Java 

import java.io.IOException;
import java.net.URI;
import java.nio.file.FileSystem;
import java.nio.file.FileSystems;
import java.nio.file.Files;
import java.util.Collections;
import java.util.stream.Collectors;

public class MkobitZipRead {

  public static void main(String[] args) throws IOException {
    final URI uri = URI.create("jar:file:/tmp/example.zip");
    try (
        final FileSystem zipfs = FileSystems.newFileSystem(uri, Collections.emptyMap());
    ) {
      Files.walk(zipfs.getPath("/")).forEach(path -> System.out.println("Files in zip:" + path));
      System.out.println("-----");
      final String manifest = Files.readAllLines(
          zipfs.getPath("x", "y", "z").resolve("d")
      ).stream().collect(Collectors.joining(System.lineSeparator()));
      System.out.println(manifest);
    }
  }

}

выход 

Files in zip:/
Files in zip:/x/
Files in zip:/x/y/
Files in zip:/x/y/z/
Files in zip:/x/y/z/c.html
Files in zip:/x/y/z/b.html
Files in zip:/x/y/z/a.html
Files in zip:/x/y/z/d
-----
hello world
Страница:
...