Estoy buscando una manera de obtener una lista de todos los nombres de recursos de un directorio classpath dado, algo así como un método List<String> getResourceNames (String directoryName).

Por ejemplo, dado un directorio de ruta de clases x/y/zque contiene archivos a.html, b.html, c.htmly un subdirectorio d, getResourceNames("x/y/z")debe devolver una List<String>que contiene las siguientes cadenas: ['a.html', 'b.html', 'c.html', 'd'].

Debería funcionar tanto para recursos en el sistema de archivos como en frascos.

Sé que puedo escribir un fragmento rápido con Files, JarFilesy URLs, pero no quiero reinventar la rueda. Mi pregunta es, dadas las bibliotecas disponibles públicamente, ¿cuál es la forma más rápida de implementar getResourceNames? Las pilas Spring y Apache Commons son factibles.

Escáner personalizado

Implemente su propio escáner. Por ejemplo:

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

Uso PathMatchingResourcePatternResolverde Spring Framework.

Reflexiones de Ronmamo

Las otras técnicas pueden ser lentas en tiempo de ejecución para grandes valores de CLASSPATH. Una solución más rápida es utilizar la API Reflections de ronmamo , que precompila la búsqueda en el momento de la compilación.

Aquí está el código
Fuente : 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);
        }
    }
}  

Si está utilizando Spring Eche un vistazo a PathMatchingResourcePatternResolver

Usando reflexiones

Obtén todo en el classpath:

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

Otro ejemplo: obtenga todos los archivos con extensión .csv de some.package :

Reflections reflections = new Reflections("some.package", new ResourcesScanner());
Set<String> fileNames = reflections.getResources(Pattern.compile(".*\\.csv"));

Si usa apache commonsIO, puede usarlo para el sistema de archivos (opcionalmente con filtro de extensión):

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

y para recursos / classpath:

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

Si no sabe si "directoy /" está en el sistema de archivos o en los recursos, puede agregar un

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

o

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

antes de las llamadas y usar ambos en combinación ...

Entonces, en términos de PathMatchingResourcePatternResolver, esto es lo que se necesita en el código:

@Autowired
ResourcePatternResolver resourceResolver;

public void getResources() {
  resourceResolver.getResources("classpath:config/*.xml");
}

El Spring framework's PathMatchingResourcePatternResolveres realmente increíble para estas cosas:

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

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

Dependencia de Maven:

<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-core</artifactId>
    <version>LATEST</version>
</dependency>

Usó una combinación de la respuesta de Rob.

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
}

Con Spring es fácil. Ya sea un archivo o carpeta, o incluso varios archivos, hay posibilidades de que pueda hacerlo mediante inyección.

Este ejemplo demuestra la inyección de múltiples archivos ubicados en la x/y/zcarpeta.

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());
    }
}

Funciona para recursos en el sistema de archivos, así como en JAR.

Esto debería funcionar (si la primavera no es una opción):

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;
}

Mi manera, no Spring, utilizada durante una prueba unitaria:

URI uri = TestClass.class.getResource("/resources").toURI();
Path myPath = Paths.get(uri);
Stream<Path> walk = Files.walk(myPath, 1);
for (Iterator<Path> it = walk.iterator(); it.hasNext(); ) {
    Path filename = it.next();   
    System.out.println(filename);
}

El mecanismo más robusto para enumerar todos los recursos en el classpath es utilizar este patrón con ClassGraph , ya que maneja la gama más amplia posible de mecanismos de especificación de classpath , incluido el nuevo sistema de módulos JPMS. (Soy el autor de ClassGraph).

List<String> resourceNames;
try (ScanResult scanResult = new ClassGraph().whitelistPaths("x/y/z").scan()) {
    resourceNames = scanResult.getAllResources().getNames();
}

Creo que puede aprovechar el [ Proveedor del sistema de archivos Zip ] [1] para lograr esto. Cuando se usa FileSystems.newFileSystemparece que puede tratar los objetos en ese ZIP como un archivo "normal".

En la documentación vinculada arriba:

Especifique las opciones de configuración para el sistema de archivos zip en el objeto java.util.Map pasado al FileSystems.newFileSystemmétodo. Consulte el tema [Propiedades del sistema de archivos zip] [2] para obtener información sobre las propiedades de configuración específicas del proveedor para el sistema de archivos zip.

Una vez que tenga una instancia de un sistema de archivos zip, puede invocar los métodos de las clases [ java.nio.file.FileSystem] [3] y [ java.nio.file.Path] [4] para realizar operaciones como copiar, mover y renombrar archivos, así como modificar los atributos del archivo.

La documentación para el jdk.zipfsmódulo en [Java 11 estados] [5]:

El proveedor del sistema de archivos zip trata un archivo zip o JAR como un sistema de archivos y proporciona la capacidad de manipular el contenido del archivo. El proveedor del sistema de archivos zip puede ser creado por [ FileSystems.newFileSystem] [6] si está instalado.

Aquí hay un ejemplo artificial que hice usando sus recursos de ejemplo. Tenga en cuenta que a .zipes a .jar, pero podría adaptar su código para utilizar recursos classpath:

Preparar

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);
    }
  }

}

Salida

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

Ninguna de las respuestas funcionó para mí, aunque mis recursos se pusieron en carpetas de recursos y seguí las respuestas anteriores. Lo que hizo un truco fue:

@Value("file:*/**/resources/**/schema/*.json")
private Resource[] resources;

Basado en la información de @rob anterior, creé la implementación que estoy lanzando al dominio público:

private static List<String> getClasspathEntriesByPath(String path) throws IOException {
    InputStream is = Main.class.getClassLoader().getResourceAsStream(path);

    StringBuilder sb = new StringBuilder();
    while (is.available()>0) {
        byte[] buffer = new byte[1024];
        sb.append(new String(buffer, Charset.defaultCharset()));
    }

    return Arrays
            .asList(sb.toString().split("\n"))          // Convert StringBuilder to individual lines
            .stream()                                   // Stream the list
            .filter(line -> line.trim().length()>0)     // Filter out empty lines
            .collect(Collectors.toList());              // Collect remaining lines into a List again
}

Si bien no hubiera esperado getResourcesAsStreamtrabajar así en un directorio, realmente funciona y funciona bien.