我正在寻找一种方法来获取给定类路径目录中所有资源名称的列表,类似方法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
s,JarFile
和URL
来编写快速代码段,但我不想重新发明轮子。我的问题是,鉴于现有的公开图书馆,实施getResourceNames
的最快方法是什么? Spring和Apache Commons堆栈都是可行的。
答案 0 :(得分:148)
实施您自己的扫描仪。例如:
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,它在编译时预编译搜索。
答案 1 :(得分:47)
这是代码
来源: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
答案 2 :(得分:17)
使用Google思考:
获取类路径中的所有内容:
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> fileNames = reflections.getResources(Pattern.compile(".*\\.csv"));
答案 3 :(得分:15)
如果您使用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)
在呼叫之前并且两者结合使用......
答案 4 :(得分:10)
所以就PathMatchingResourcePatternResolver而言,这就是代码所需要的:
@Autowired
ResourcePatternResolver resourceResolver;
public void getResources() {
resourceResolver.getResources("classpath:config/*.xml");
}
答案 5 :(得分:5)
使用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
}
答案 6 :(得分:5)
Spring framework
的{{1}}对于这些事情非常棒:
PathMatchingResourcePatternResolver
Maven依赖:
private Resource[] getXMLResources() throws IOException
{
ClassLoader classLoader = MethodHandles.lookup().getClass().getClassLoader();
PathMatchingResourcePatternResolver resolver = new PathMatchingResourcePatternResolver(classLoader);
return resolver.getResources("classpath:x/y/z/*.xml");
}
答案 7 :(得分:1)
这应该有用(如果弹簧不是一个选项):
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;
}
答案 8 :(得分:1)
使用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中的资源。
答案 9 :(得分:1)
当前列出类路径中所有资源的最健壮的机制是to use this pattern with ClassGraph,因为它处理widest possible array of classpath specification mechanisms,包括新的JPMS模块系统。 (我是ClassGraph的作者。)
List<String> resourceNames;
try (ScanResult scanResult = new ClassGraph().whitelistPaths("x/y/z").scan()) {
resourceNames = scanResult.getAllResources().getNames();
}
答案 10 :(得分:0)
我认为您可以利用[ Zip文件系统提供程序] [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状态] [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
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
答案 11 :(得分:0)
即使我将我的资源放在资源文件夹中并遵循上面的答案,这两个答案都对我不起作用。真正的把戏是:
@Value("file:*/**/resources/**/schema/*.json")
private Resource[] resources;
答案 12 :(得分:0)
我的方法,没有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);
}
答案 13 :(得分:-4)
基于上述@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
在目录上像这样工作,但确实如此,并且效果很好。