Saya mencari cara untuk mendapatkan daftar semua nama sumber daya dari direktori classpath yang diberikan, sesuatu seperti metode List<String> getResourceNames (String directoryName) .

Sebagai contoh, diberikan sebuah direktori classpath x/y/zyang berisi file a.html, b.html, c.htmldan subdirektori d, getResourceNames("x/y/z")harus kembali List<String>mengandung string berikut:['a.html', 'b.html', 'c.html', 'd'] .

Ini harus bekerja baik untuk sumber daya dalam sistem file dan stoples.

Saya tahu bahwa saya dapat menulis cuplikan singkat dengan Files, JarFiles dan URLs, tetapi saya tidak ingin menemukan kembali kemudi. Pertanyaan saya adalah, mengingat perpustakaan yang ada tersedia untuk umum, apa cara tercepat untuk mengimplementasikan getResourceNames? Tumpukan Spring dan Apache Commons keduanya layak.

Pemindai Khusus

Terapkan pemindai Anda sendiri. Sebagai contoh:

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

Kerangka Pegas

Gunakan PathMatchingResourcePatternResolverdari Spring Framework.

Refleksi Ronmamo

Teknik lain mungkin lambat saat runtime untuk nilai CLASSPATH besar. Solusi yang lebih cepat adalah dengan menggunakan Reflection API ronmamo , yang mengompilasi pencarian pada waktu kompilasi.

Berikut adalah kode
Sumber : 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);
        }
    }
}  

Jika Anda menggunakan Spring Lihatlah PathMatchingResourcePatternResolver

Menggunakan Refleksi

Dapatkan semua yang ada di classpath:

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

Contoh lain - dapatkan semua file dengan ekstensi .csv dari some.package :

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

Jika Anda menggunakan apache commonsIO, Anda dapat menggunakan sistem file (opsional dengan filter ekstensi):

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

dan untuk sumber daya / classpath:

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

Jika Anda tidak tahu apakah "directoy /" ada di sistem file atau sumber daya, Anda dapat menambahkan

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

atau

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

sebelum panggilan dan gunakan keduanya dalam kombinasi ...

Jadi dalam hal PathMatchingResourcePatternResolver inilah yang diperlukan dalam kode:

@Autowired
ResourcePatternResolver resourceResolver;

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

The Spring framework's PathMatchingResourcePatternResolverbenar-benar mengagumkan untuk hal-hal ini:

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

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

Ketergantungan maven:

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

Menggunakan kombinasi respons 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
}

Dengan Spring itu mudah. Baik itu file, folder, atau bahkan banyak file, ada kemungkinan, Anda bisa melakukannya melalui injeksi.

Contoh ini menunjukkan injeksi beberapa file yang terletak di x/y/zfolder.

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

Itu bekerja untuk sumber daya di sistem file maupun di JAR.

Ini harus berfungsi (jika pegas bukan opsi):

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

Cara saya, tanpa Spring, digunakan selama unit test:

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

Mekanisme yang paling kuat untuk mendaftarkan semua sumber daya di classpath saat ini adalah untuk menggunakan pola ini dengan ClassGraph , karena menangani array seluas mungkin dari mekanisme spesifikasi classpath , termasuk sistem modul JPMS yang baru. (Saya penulis ClassGraph.)

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

Saya pikir Anda dapat memanfaatkan [ Penyedia Sistem File Zip ] [1] untuk mencapai ini. Ketika menggunakanFileSystems.newFileSystem sepertinya Anda bisa memperlakukan objek dalam ZIP itu sebagai file "biasa".

Dalam dokumentasi tertaut di atas:

Tentukan opsi konfigurasi untuk sistem file zip di objek java.util.Map yang diteruskan ke FileSystems.newFileSystem metode. Lihat topik [Properti Sistem File Zip] [2] untuk informasi tentang properti konfigurasi khusus penyedia untuk sistem file zip.

Setelah Anda memiliki instance dari sistem file zip, Anda dapat memanggil metode dari kelas [ java.nio.file.FileSystem] [3] dan [ java.nio.file.Path] [4] untuk melakukan operasi seperti menyalin, memindahkan, dan mengganti nama file, serta memodifikasi atribut file.

Dokumentasi untuk jdk.zipfsmodul di [Jawa 11 negara] [5]:

Penyedia sistem file zip memperlakukan file zip atau JAR sebagai sistem file dan menyediakan kemampuan untuk memanipulasi konten file. Penyedia sistem file zip dapat dibuat oleh [ FileSystems.newFileSystem] [6] jika diinstal.

Ini adalah contoh yang dibuat-buat yang saya lakukan menggunakan sumber daya contoh Anda. Perhatikan bahwa a .zipadalah a.jar , tetapi Anda dapat mengadaptasi kode Anda untuk menggunakan sumber daya classpath:

Mempersiapkan

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

Jawa

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

}

Keluaran

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

Tidak ada jawaban yang bekerja untuk saya walaupun sumber daya saya dimasukkan ke dalam folder sumber daya dan mengikuti jawaban di atas. Yang membuat tipuan adalah:

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

Berdasarkan informasi @rob di atas, saya membuat implementasi yang saya rilis ke domain publik:

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
}

Walaupun saya tidak akan berharap getResourcesAsStreamuntuk bekerja seperti itu pada direktori, itu benar-benar berfungsi dan bekerja dengan baik.