getResourceAsStream 返回 null

Question

我正在从我的 Java 项目的已编译 JAR 中的 package 中加载一个文本文件。 相关目录结构如下：

/src/initialization/Lifepaths.txt

我的代码通过调用Class::getResourceAsStream来加载文件以返回InputStream 。

public class Lifepaths {
    public static void execute() {
        System.out.println(Lifepaths.class.getClass().
            getResourceAsStream("/initialization/Lifepaths.txt"));
    }

    private Lifepaths() {}

    //This is temporary; will eventually be called from outside
    public static void main(String[] args) {execute();}
}

打印输出将始终打印null ，无论我使用什么。 我不确定为什么上面的方法不起作用，所以我也试过：

• "/src/initialization/Lifepaths.txt"
• "initialization/Lifepaths.txt"
• "Lifepaths.txt"

这些都不起作用。 到目前为止， 我已经阅读了很多关于该主题的问题，但没有一个有帮助 - 通常，他们只是说使用根路径加载文件，我已经在这样做了。 那，或者只是从当前目录加载文件（只是加载filename ），我也试过。 该文件正在以适当的名称在适当的位置编译到 JAR。

我该如何解决这个问题？

Answer 1

Lifepaths.class.getClass().getResourceAsStream(...)使用系统类加载器加载资源，它显然失败了，因为它看不到你的 JAR

Lifepaths.class.getResourceAsStream(...)使用加载 Lifepaths 类的相同类加载器加载资源，它应该可以访问 JAR 中的资源

Answer 2

规则如下：

1. 检查要加载到 JAR 中的文件的位置（从而确保它确实添加到了 JAR 中）
2. 使用绝对路径：路径从 JAR 的根开始
3. 使用相对路径：路径从您正在调用的类的包目录开始 getResource/getResoucreAsStream

并尝试：

Lifepaths.class.getResourceAsStream("/initialization/Lifepaths.txt")

代替

Lifepaths.class.getClass().getResourceAsStream("/initialization/Lifepaths.txt")

（不确定它是否有区别，但前者将使用正确的 ClassLoader/JAR，而我不确定后者）

Answer 3

因此，有多种方法可以从 jar 中获取资源，每种方法的语法略有不同，需要以不同方式指定路径。

我见过的最好的解释是这篇来自InfoWorld 的文章。 我会在这里总结，但如果你想了解更多，你应该看看这篇文章。

方法

1. ClassLoader.getResourceAsStream() 。

格式：“/”-分隔的名称； 没有前导“/”（所有名称都是绝对的）。

示例： this.getClass().getClassLoader().getResourceAsStream("some/pkg/resource.properties");

2. Class.getResourceAsStream()

格式：“/”-分隔的名称； 前导“/”表示绝对名称； 所有其他名称都相对于类的包

示例： this.getClass().getResourceAsStream("/some/pkg/resource.properties");

2020 年 9 月更新：更改了文章链接。 原始文章来自 Javaworld，它现在托管在 InfoWorld 上（并且有更多广告）

Answer 4

不要使用绝对路径，使它们相对于项目中的“资源”目录。 显示来自“资源”目录的 MyTest.txt 内容的快速而肮脏的代码。

@Test
public void testDefaultResource() {
    // can we see default resources
    BufferedInputStream result = (BufferedInputStream) 
         Config.class.getClassLoader().getResourceAsStream("MyTest.txt");
    byte [] b = new byte[256];
    int val = 0;
    String txt = null;
    do {
        try {
            val = result.read(b);
            if (val > 0) {
                txt += new String(b, 0, val);
            }
        } catch (IOException e) {
            e.printStackTrace();
        } 
    } while (val > -1);
    System.out.println(txt);
}

Answer 5

您可能想尝试使用此方法来获取流，即首先获取 url，然后将其作为流打开。

URL url = getClass().getResource("/initialization/Lifepaths.txt"); 
InputStream strm = url.openStream(); 

我曾经有一个类似的问题： 从 jar 读取 txt 文件失败，但读取图像有效

Answer 6

我发现自己遇到了类似的问题。 由于我使用的是 maven，因此我需要更新我的 pom.xml 以包含如下内容：

   ...
</dependencies>
<build>
    <resources>
        <resource>
            <directory>/src/main/resources</directory>
        </resource>
        <resource>
            <directory>../src/main/resources</directory>
        </resource>
    </resources>
    <pluginManagement>
        ...

请注意其中的资源标签以指定该文件夹的位置。 如果您有嵌套项目（就像我一样），那么您可能希望从其他区域获取资源，而不仅仅是在您正在使用的模块中。如果您使用类似的配置数据，这有助于减少在每个 repo 中保留相同的文件

Answer 7

您使用的 ClassLoader 似乎存在问题。 使用 contextClassLoader 加载类。 这与是否在静态/非静态方法中无关

Thread.currentThread().getContextClassLoader().getResourceAsStream ......

Answer 8

粗略地说：

getClass().getResource("/") ~= Thread.currentThread().getContextClassLoader().getResource(".")

假设您的项目结构如下所示：

├── src
│   ├── main
│   └── test
│   └── test
│       ├── java
│       │   └── com
│       │       └── github
│       │           └── xyz
│       │               └── proj
│       │                   ├── MainTest.java
│       │                   └── TestBase.java
│       └── resources
│           └── abcd.txt
└── target
    └── test-classes
        ├── com
        └── abcd.txt

// in MainClass.java
this.getClass.getResource("/") -> "~/proj_dir/target/test-classes/"
this.getClass.getResource(".") -> "~/proj_dir/target/test-classes/com/github/xyz/proj/"
Thread.currentThread().getContextClassLoader().getResources(".") -> "~/proj_dir/target/test-classes/"
Thread.currentThread().getContextClassLoader().getResources("/") ->  null

Answer 9

对我有用的是在My Project/Java Resources/src下添加文件，然后使用

this.getClass().getClassLoader().getResourceAsStream("myfile.txt");

我不需要将此文件显式添加到路径中（将它添加到/src显然是这样做的）

Answer 10

默认的 JVM 类加载器将首先使用父类加载器来加载资源： .

Lifepaths.class.getClass()的类加载器是bootstrap classloader ，所以getResourceAsStream将只搜索 $JAVA_HOME ，而不管用户提供的classpath 。 显然，Lifepaths.txt 不存在。

Lifepaths.class的类加载器是system classpath classloader ，因此getResourceAsStream将搜索用户定义的classpath而 Lifepaths.txt 就在那里。

使用java.lang.Class#getResourceAsStream(String name) ，不以“/”开头的名称将添加package name作为前缀。 如果您想避免这种情况，请使用java.lang.ClassLoader#getResourceAsStream 。 例如：

ClassLoader loader = Thread.currentThread().getContextClassLoader();
String resourceName = "Lifepaths.txt";
InputStream resourceStream = loader.getResourceAsStream(resourceName); 

Answer 11

不知道是否有帮助，但就我而言，我的资源位于 /src/ 文件夹中，但出现此错误。 然后我将图片移动到 bin 文件夹并解决了问题。

Answer 12

确保您的资源目录（例如“src”）在您的类路径中（确保它是 eclipse 中构建路径中的源目录）。

确保从主类加载器加载 clazz。

然后，加载 src/initialization/Lifepaths.txt，使用

clazz.getResourceAsStream("/initialization/Lifepaths.txt");

为什么： clazz.getResourcesAsStream(foo)从clazz 的类路径中查找 foo ，相对于 clazz 所在的目录。 前导“/”使其从 clazz 类路径中任何目录的根目录加载。

除非您在某种容器中，例如 Tomcat，或者直接使用 ClassLoaders 执行某些操作，否则您可以将 eclipse/命令行类路径视为唯一的类加载器类路径。

Answer 13

如果您使用 Maven，请确保您的包装是“jar”而不是“pom”。

<packaging>jar</packaging>

Answer 14

您真正需要的是文件的完整绝对类路径。 因此，与其猜测，不如尝试找出根目录，然后将文件移动到基​​于 <.war> 文件结构的更好位置...

URL test1 = getClass().getResource("/");
URL test2 = getClass().getClassLoader().getResource("/");            
URL test3 = getClass().getClassLoader().getResource("../");

logger.info(test1.getPath()); 
logger.info(test2.getPath());
logger.info(test3.getPath());

Answer 15

对我有用的是我将文件放在

src/main/java/myfile.log

和

InputStream is = getClass().getClassLoader().getResourceAsStream("myfile.log");
        
        if (is == null) {
            throw new FileNotFoundException("Log file not provided");
        }

Answer 16

就我而言，除非我从文件名中删除空格，否则什么都行不通...

Answer 17

请删除

../src/main/resources

或包含您尝试读取的文件

Answer 18

在 pom.xml 中管理或删除 ../src/main/resources

Answer 19

我的调用者类在src/main/...

是什么帮助我从src/test/resources/folder/file.properties加载资源

`properties.load(getClass().getClassLoader().getResourceAsStream("folder/file.properties"));`

https://howtodoinjava.com/java/io/read-file-from-resources-folder/

爪哇 11

Answer 20

jdk >=9 需要在module-info模块中把非根目录/非共父目录的包给它open了。

jdk >=9 需要在 module-info.java 中打开资源目录，例如：

• 源文件
  • 爪哇
  • 资源
    • 配置文件
      • 配置文件
    • log4j2.xml
    • openapi.yaml

如果你需要阅读 conf/config.json ，你需要两步：

// in module-info.java
module your.mod.name {
    open conf;
}

// then in java code
getClassLoader().getResourceAsStream("conf/config.json");

否则，如果您需要在 root 中阅读 other ，它只是：

getClassLoader().getResourceAsStream("openapi.yaml");

你可以看到 {@link java.lang.ClassLoader#getResourceAsStream(String)} 知道为什么~

Answer 21

虽然不打算作为答案，但我将此建议作为答案提出，以便我可以获取屏幕截图。

对于那些在 Windows 平台上开发的人，我强烈推荐 Microsoft 实用程序 ProcMon，或 Process Monitor。

Process Monitor 是 Microsoft 提供的一组实用程序中的一个实用程序（您甚至不需要登录即可下载）。 它们都可以在 sysinternals.com 上找到，这是微软收购并保留的原始主机。

Process Monitor 可以监控与任何正在运行的进程相关的大量事件。 如果您指定文件打开事件并提供文件名（或文件名的一部分），它将记录尝试打开文件的进程并显示每个搜索到的目录。 当您不知道正在运行的代码在哪里寻找您在 source/config.php 中指定的文件时，这会很有用。 下面是一个例子：

在这里，我正在寻找（而不是找到）模式文件 (XSD)，以便代码可以使用它来验证某些用户提供的 XML。

Answer 22

如果您使用的是 IDEA，请确保将您的资源文件夹标记为“资源”，以便 IDE 可以正确识别该路径。

假设你在'resources/'中有一个名为'book.json'的文件，那么要使用其中的资源，你可以这样做

InputStream input = Main.class.getResourceAsStream("/book.json");

Answer 23

Lifepaths.class.getClass()。 getResourceAsStream("Lifepaths.txt"));

Answer 24

我知道这里有不同的答案。 我的工作是这样的。 在资源目录中添加了文件。 在可执行代码中，我提到了该文件的路径，在文件名的引号内以“/”作为前缀。

 InputStream resourceStream = loader.getResourceAsStream("/LifePaths.txt");

Answer 25

我的问题是资源不在 src 文件夹中。

Answer 26

晚会迟到了。 根据您使用的 JDK 版本（也许是时候查看 StackOverflow 的“问题已回答”？）JPMS 可能会影响您能够加载（或不能加载）的资源。

将我的代码打包为模块我必须这样做：

Thread.currentThread().getClass().getModule().getResourceAsStream("resourceName");

然后它起作用了

Answer 27

@Emracool ...我建议你另一种选择。 由于您似乎正在尝试加载 *.txt 文件。 最好使用FileInputStream()而不是这个烦人的getClass().getClassLoader().getResourceAsStream()或getClass().getResourceAsStream() 。 至少你的代码会正确执行。