从类路径目录中获取资源列表

Question

我正在寻找一种从给定类路径目录中获取所有资源名称列表的方法，例如方法List<String> getResourceNames (String directoryName) 。

例如，给定一个类路径目录x/y/z包含文件a.html 、 b.html 、 c.html和一个子目录d ， getResourceNames("x/y/z")应该返回一个包含以下内容的List<String>字符串： ['a.html', 'b.html', 'c.html', 'd'] 。

它应该适用于文件系统和 jar 中的资源。

我知道我可以用File 、 JarFile和URL编写一个快速的片段，但我不想重新发明轮子。 我的问题是，鉴于现有的公开可用的库，实现getResourceNames的最快方法是什么？ Spring 和 Apache Commons 堆栈都是可行的。

Answer 1

自定义扫描仪

实现您自己的扫描仪。 例如：

（ 评论中提到了此解决方案的局限性）

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 。

龙马毛思考

对于巨大的 CLASSPATH 值，其他技术在运行时可能会很慢。 更快的解决方案是使用 ronmamo 的Reflections API ，它在编译时预编译搜索。

Answer 2

这是代码
来源：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

Answer 3

使用反射

获取类路径上的所有内容：

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

另一个例子 - 从some.package获取所有扩展名为.csv的文件：

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

Answer 4

因此，就 PathMatchingResourcePatternResolver 而言，这是代码中需要的：

@Autowired
ResourcePatternResolver resourceResolver;

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

Answer 5

如果您使用 apache commonsIO，您可以将其用于文件系统（可选择使用扩展过滤器）：

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

对于资源/类路径：

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)

在通话之前并结合使用两者......

Answer 6

列出类路径中所有资源的最健壮的机制目前是将此模式与 ClassGraph 一起使用，因为它处理最广泛的类路径规范机制，包括新的 JPMS 模块系统。 （我是 ClassGraph 的作者。）

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

Answer 7

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>

Answer 8

这应该有效（如果弹簧不是一个选项）：

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

Answer 9

我的方式，没有 Spring，在单元测试期间使用：

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

Answer 10

使用了 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
}

Answer 11

有了Spring，这很容易。 无论是文件，文件夹，甚至是多个文件，都有机会，你可以通过注入来做到这一点。

此示例演示了注入位于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 中的资源。

Answer 12

我认为您可以利用 [ Zip File System Provider ][1] 来实现这一点。 使用FileSystems.newFileSystem时，您似乎可以将该 ZIP 中的对象视为“常规”文件。

在上面的链接文档中：

在传递给FileSystems.newFileSystem方法的 java.util.Map 对象中指定 zip 文件系统的配置选项。 有关 zip 文件系统的提供程序特定配置属性的信息，请参阅 [Zip 文件系统属性][2] 主题。

一旦有了 zip 文件系统的实例，就可以调用 [ java.nio.file.FileSystem ][3] 和 [ java.nio.file.Path ][4] 类的方法来执行复制等操作、移动和重命名文件，以及修改文件属性。

[Java 11 states][5] 中jdk.zipfs模块的文档：

zip 文件系统提供程序将 zip 或 JAR 文件视为文件系统，并提供操作文件内容的能力。 如果安装了 zip 文件系统提供程序，则可以通过 [ FileSystems.newFileSystem ][6] 创建。

这是我使用您的示例资源所做的一个人为的示例。 请注意， .zip是.jar ，但您可以调整代码以改用类路径资源：

设置

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

爪哇

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

Answer 13

即使我将资源放在资源文件夹中并遵循上述答案，这两个答案都不适合我。 真正的诀窍是：

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

Answer 14

扩展Luke Hutchinson上面的回答，使用他的ClassGraph库，我几乎不费吹灰之力就能轻松获得资源文件夹中所有文件的列表。

假设在您的资源文件夹中，您有一个名为MyImages的文件夹。 获取该文件夹中所有文件的 URL 列表是多么容易：

import io.github.classgraph.ClassGraph;
import io.github.classgraph.ResourceList;
import io.github.classgraph.ScanResult;

public static LinkedList<URL> getURLList (String folder) {
    LinkedList<URL> urlList    = new LinkedList<>();
    ScanResult      scanResult = new ClassGraph().enableAllInfo().scan();
    ResourceList    resources  = scanResult.getAllResources();
    for (URL url : resources.getURLs()) {
        if (url.toString().contains(folder)) {
            urlList.addLast(url);
        }
    }
    return urlList;
}

然后你只需这样做：

LinkedList<URL> myURLFileList = getURLList("MyImages");

然后可以将 URL 加载到流中或使用 Apache 的 FileUtils 将文件复制到其他地方，如下所示：

String outPath = "/My/Output/Path";
for(URL url : myURLFileList) {
    FileUtils.copyURLToFile(url, new File(outPath, url.getFile()));
}

我认为 ClassGraph 是一个非常漂亮的库，可以让这样的任务变得非常简单和易于理解。

Answer 15

根据上面@rob 的信息，我创建了我要发布到公共领域的实现：

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
}

虽然我没想到getResourcesAsStream会像在目录上那样工作，但它确实可以，而且效果很好。