如何在Java中从classpath中真正读取文本文件

Question

我正在尝试读取在CLASSPATH系统变量中设置的文本文件.不是用户变量.

我试图获取输入流到文件,如下所示:

将file(D:\myDir)的目录放在CLASSPATH中并尝试以下操作:

InputStream in = this.getClass().getClassLoader().getResourceAsStream("SomeTextFile.txt");
InputStream in = this.getClass().getClassLoader().getResourceAsStream("/SomeTextFile.txt");
InputStream in = this.getClass().getClassLoader().getResourceAsStream("//SomeTextFile.txt");

将文件(D:\myDir\SomeTextFile.txt)的完整路径放在CLASSPATH中,并尝试上面3行代码.

但不幸的是,他们中的任何人都在工作,我总是null进入我的InputStream in.

Answer 1

使用类路径上的目录,从同一个类加载器加载的类,您应该能够使用以下任何一个:

// From ClassLoader, all paths are "absolute" already - there's no context
// from which they could be relative. Therefore you don't need a leading slash.
InputStream in = this.getClass().getClassLoader()
                                .getResourceAsStream("SomeTextFile.txt");
// From Class, the path is relative to the package of the class unless
// you include a leading slash, so if you don't want to use the current
// package, include a slash like this:
InputStream in = this.getClass().getResourceAsStream("/SomeTextFile.txt");

如果那些不起作用,那表明还有其他问题.

例如,请使用以下代码:

package dummy;

import java.io.*;

public class Test
{
    public static void main(String[] args)
    {
        InputStream stream = Test.class.getResourceAsStream("/SomeTextFile.txt");
        System.out.println(stream != null);
        stream = Test.class.getClassLoader().getResourceAsStream("SomeTextFile.txt");
        System.out.println(stream != null);
    }
}

而这个目录结构:

code
    dummy
          Test.class
txt
    SomeTextFile.txt

然后(使用Unix路径分隔符,因为我在Linux机器上):

java -classpath code:txt dummy.Test

结果:

true
true

Answer 2

使用Spring Framework时(作为实用程序或容器的集合- 您不需要使用后者的功能),您可以轻松使用Resource抽象.

Resource resource = new ClassPathResource("com/example/Foo.class");

通过Resource接口,您可以将资源作为InputStream,URL,URI或File访问.将资源类型更改为例如文件系统资源是更改实例的简单问题.

Answer 3

这就是我使用Java 7 NIO读取类路径上文本文件的所有行的方法:

...
import java.nio.charset.Charset;
import java.nio.file.Files;
import java.nio.file.Paths;

...

Files.readAllLines(
    Paths.get(this.getClass().getResource("res.txt").toURI()), Charset.defaultCharset());

注意,这是一个如何完成它的例子.你必须根据需要进行改进.此示例仅在文件实际存在于类路径中时才有效,否则当getResource()返回null并且在其上调用.toURI()时,将抛出NullPointerException.

此外,从Java 7开始,指定字符集的一种便捷方法是使用定义的常量java.nio.charset.StandardCharsets (根据它们的javadoc,"保证在Java平台的每个实现上都可用.").

因此,如果您知道文件的编码为UTF-8,则明确指定charset StandardCharsets.UTF_8

Answer 4

请试试

InputStream in = this.getClass().getResourceAsStream("/SomeTextFile.txt");

您尝试没有成功,因为只对类加载器的类是能够从classpath加载.您使用了类加载器来为java系统本身.

Answer 5

要实际读取文件的内容,我喜欢使用Commons IO + Spring Core.假设Java 8:

try (InputStream stream = new ClassPathResource("package/resource").getInputStream()) {
    IOUtils.toString(stream);
}

或者:

InputStream stream = null;
try {
    stream = new ClassPathResource("/log4j.xml").getInputStream();
    IOUtils.toString(stream);
} finally {
    IOUtils.closeQuietly(stream);
}

Answer 6

要获得类绝对路径,请尝试以下操作:

String url = this.getClass().getResource("").getPath();

Answer 7

不知何故,最好的答案对我不起作用.我需要使用稍微不同的代码.

ClassLoader loader = Thread.currentThread().getContextClassLoader();
InputStream is = loader.getResourceAsStream("SomeTextFile.txt");

我希望这可以帮助那些遇到同样问题的人.

Answer 8

如果你使用番石榴:

import com.google.common.io.Resources;

我们可以从CLASSPATH获取URL:

URL resource = Resources.getResource("test.txt");
String file = resource.getFile();   // get file path 

或InputStream:

InputStream is = Resources.getResource("test.txt").openStream();