Tôi đang tìm cách để có được một danh sách tất cả các tên tài nguyên từ một thư mục classpath đã cho, giống như một phương thức List<String> getResourceNames (String directoryName).

Ví dụ, với một thư mục classpath x/y/zchứa file a.html, b.html, c.htmlvà một thư mục con d, getResourceNames("x/y/z")phải trả lại một List<String>chứa chuỗi kí tự sau: ['a.html', 'b.html', 'c.html', 'd'].

Nó nên hoạt động cả cho các tài nguyên trong hệ thống tập tin và lọ.

Tôi biết rằng tôi có thể viết một đoạn nhanh với Files, JarFiles và URLs, nhưng tôi không muốn phát minh lại bánh xe. Câu hỏi của tôi là, với các thư viện có sẵn công khai, cách nhanh nhất để thực hiện là getResourceNamesgì? Các ngăn xếp Spring và Apache Commons đều khả thi.

Máy quét tùy chỉnh

Thực hiện máy quét của riêng bạn. Ví dụ:

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

Khung mùa xuân

Sử dụng PathMatchingResourcePatternResolvertừ Spring Framework.

Phản xạ Ronmamo

Các kỹ thuật khác có thể chậm trong thời gian chạy đối với các giá trị CLASSPATH lớn. Một giải pháp nhanh hơn là sử dụng API Reflections của ronmamo , dịch vụ này sẽ biên dịch trước tìm kiếm tại thời điểm biên dịch.

Đây là mã
Nguồn : forum.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);
        }
    }
}  

Nếu bạn đang sử dụng Spring Hãy xem PathMatchingResourcePotypeResolver

Sử dụng phản xạ

Nhận mọi thứ trên đường dẫn:

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

Một ví dụ khác - lấy tất cả các tệp có đuôi .csv từ some.package :

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

Nếu bạn sử dụng apache commonsIO, bạn có thể sử dụng cho hệ thống tệp (tùy chọn có bộ lọc mở rộng):

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

và đối với tài nguyên / classpath:

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

Nếu bạn không biết "directoy /" có trong hệ thống tập tin hay trong tài nguyên, bạn có thể thêm một

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

hoặc là

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

trước các cuộc gọi và sử dụng cả hai kết hợp ...

Vì vậy, theo thuật ngữ của PathMatchingResourcePotypeResolver, đây là những gì cần thiết trong mã:

@Autowired
ResourcePatternResolver resourceResolver;

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

Các Spring framework's PathMatchingResourcePatternResolverlà thực sự tuyệt vời cho những điều sau:

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

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

Phụ thuộc Maven:

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

Được sử dụng kết hợp phản ứng của 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
}

Với mùa xuân thật dễ dàng. Có thể là một tệp, hoặc thư mục, hoặc thậm chí nhiều tệp, có nhiều khả năng, bạn có thể thực hiện thông qua tiêm.

Ví dụ này cho thấy việc tiêm nhiều tệp nằm trong x/y/zthư mục.

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

Nó không hoạt động cho các tài nguyên trong hệ thống tập tin cũng như trong JAR.

Điều này sẽ hoạt động (nếu mùa xuân không phải là một lựa chọ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;
}

Cách của tôi, không có Spring, được sử dụng trong bài kiểm tra đơn vị:

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

Cơ chế mạnh mẽ nhất để liệt kê tất cả các tài nguyên trong đường dẫn hiện đang sử dụng mẫu này với ClassGraph , vì nó xử lý mảng cơ chế đặc tả đường dẫn rộng nhất có thể , bao gồm cả hệ thống mô-đun JPMS mới. (Tôi là tác giả của ClassGraph.)

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

Tôi nghĩ bạn có thể tận dụng [ Nhà cung cấp hệ thống tệp Zip ] [1] để đạt được điều này. Khi đang sử dụngFileSystems.newFileSystem có vẻ như bạn có thể coi các đối tượng trong ZIP đó là tệp "thông thường".

Trong các tài liệu liên kết ở trên:

Chỉ định các tùy chọn cấu hình cho hệ thống tệp zip trong đối tượng java.util.Map được truyền cho FileSystems.newFileSystem phương thức. Xem chủ đề [Thuộc tính hệ thống tệp Zip] [2] để biết thông tin về các thuộc tính cấu hình dành riêng cho nhà cung cấp cho hệ thống tệp zip.

Khi bạn có một phiên bản của hệ thống tệp zip, bạn có thể gọi các phương thức của các lớp [ java.nio.file.FileSystem] [3] và [ java.nio.file.Path] [4] để thực hiện các thao tác như sao chép, di chuyển và đổi tên tệp, cũng như sửa đổi các thuộc tính tệp.

Tài liệu cho jdk.zipfsmô-đun ở [trạng thái Java 11] [5]:

Nhà cung cấp hệ thống tệp zip coi tệp zip hoặc tệp JAR là một hệ thống tệp và cung cấp khả năng thao tác với nội dung của tệp. Nhà cung cấp hệ thống tệp zip có thể được tạo bởi [ FileSystems.newFileSystem] [6] nếu được cài đặt.

Đây là một ví dụ giả định tôi đã sử dụng tài nguyên mẫu của bạn. Lưu ý rằng a .ziplà a .jar, nhưng bạn có thể điều chỉnh mã của mình để sử dụng tài nguyên đường dẫn:

Thiết lập

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

}

Đầu ra

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

Không có câu trả lời nào phù hợp với tôi mặc dù tôi đã đặt tài nguyên của mình vào các thư mục tài nguyên và làm theo các câu trả lời ở trên. Điều gì đã làm cho một mẹo là:

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

Dựa trên thông tin của @rob ở trên, tôi đã tạo ra triển khai mà tôi sẽ phát hành cho miền công cộng:

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
}

Mặc dù tôi không mong đợi sẽ getResourcesAsStreamhoạt động như vậy trên một thư mục, nhưng nó thực sự hoạt động và nó hoạt động tốt.