检索子包类的资源

Question

我使用 java 的时间不长，所以我不确定还要寻找什么。我希望有人能指出我正确的方向。

目标： 我想使用一个查找表，存储为文本文件。但我不想使用绝对路径，因为最后我想打包一个版本并能够从任何位置调用它（文本文件将包含在打包版本中）。

当前设置： 我将文本文件放在一个名为“resources”的文件夹中（因为通过阅读有关 java 的教程，我得到了一个印象，我应该把它放在这个位置以维护一个更好的结构化项目）。

在根包文件夹中，我有一个类 (MainClass.java)，它调用子包中的另一个类 (LookUpClass.java)。 文件夹设置如下：

• 源
  • Java
    • main.package.com
      • 分包
        • Lo​​okUpClass.java
        • PlotterClass.java
      • MainClass.java
  • 资源
    • 查找表
      • Lo​​okUpTable1.txt
      • Lo​​okUpTable2.txt

我在LookUpClass.java 中编写了一个方法，该方法从我的资源查找表中检索某一行。为了检索文件并读出某一行，我使用了

// Gets respective line from LUT
private static String getLineFromLUT(int line) {
    URL url = LookUpClass.class.getClass().getResource("/LookUpTables/LookUpTable1.txt");
    File file = new File(url.toURI());
    BufferedReader br = new BufferedReader(new FileReader(file));

    for (int i = 0; i < line; ++i)
        br.readLine();

    return br.readLine;
}

在我的项目结构中，“java”文件夹被标记为“source”，而“resources”被标记为“resources”。

我的测试设置非常简单：

public static void main(String[] args) throws URISyntaxException, IOException {
    String c = LookUpClass.getLineFromLUT(5);
    System.out.println("Color of line 5: " + c);
}

输出：

Color of line 5: 0  0   38

（这是正确的。）

我在PlotterClass.java 中添加了完全相同的行，它也可以正常工作。

问题：

现在，如果我在 MainClass.java 中尝试相同的操作，我会收到 url 为空的错误。似乎找不到资源/资源文件夹。

我已经阅读了关于 SO 的各种帖子，并尝试了几个建议的解决方案，但到目前为止都失败了：

• 如果使用LookUpClass.class.getClassLoader().getResource("/LookUpTables/LookUpTable1.txt") 来自MainClass.java 和LookUpClass.java 的调用都失败（url 为空）。
• 我尝试使用以下路径（在任何一个类中都不起作用）： “LookUpTables/LookUpTable1.txt”（删除起始“/”） “/subpackage/LookUpTables/LookUpTable1.txt” "../subpackage/LookUpTables/LookUpTable1.txt"
• 由于使用了 Idea IntelliJ，我检查了“设置 > 构建、执行、部署 > 编译器 > 资源模式”并将“*.txt”添加到模式中。没有任何改变。
• 如果添加Class c = LookUpClass.class.getClass();，在Debug模式下c是“class.java.lang.Class”。我期待像“main.package.com.subpackage.LookUpClass”这样的东西。
• 在某些时候我尝试使用getResourceAsStream()，但我不明白如何获得我的（例如）第 5 行，所以我放弃了它。如果它解决了我的问题，我愿意阅读此内容。

我不知道如何解决这个问题。我意识到在这一点上我只是在尝试一些东西，甚至不明白为什么它可以或不能工作。 对我来说，似乎LookUpClass.java 的运行位置与MainClass.java 不同。但是“资源”文件夹和相应的文本文件位置永远不会改变。如何在一种情况下找到文件，而在另一种情况下找不到文件？

Answer 1

鉴于您提供的 MWE，我尝试重现您的问题，但没有成功。我在这里上传了我的项目，包括一个 pom.xml（你提到你使用了 maven）：http://www.filedropper.com/stackoverflow 这是我的查找类的样子（还展示了如何使用 getResourceAsStream 方法）：

public class LookUpClass {

    final static String tableName = "resources/LookUpTables/LookUpTable1.txt";

    public static String getLineFromLUT(final int line) {
        final URL url = LookUpClass.class.getResource(tableName);
        if (url.toString().startsWith("jar:")) {
            try (final URLClassLoader loader = URLClassLoader
                    .newInstance(new URL[] { url })) {
                return getLineFromLUT(
                        new InputStreamReader(
                                loader.getResourceAsStream(tableName)), line);
            } catch (final IOException e) {
                e.printStackTrace();
            }
        } else {
            return getLineFromLUT(
                    new InputStreamReader(
                            LookUpClass.class.getResourceAsStream(tableName)),
                    line);
        }
        return null;
    }

    public static String getLineFromLUT(final Reader reader, final int line) {
        try (final BufferedReader br = new BufferedReader(reader)) {
            for (int i = 0; i < line; ++i)
                br.readLine();
            return br.readLine();
        } catch (final IOException e) {
            e.printStackTrace();
        }
        return null;
    }
}

Answer 2

Maven 有一个standard directory layout。目录src/main/resources 用于此类应用程序资源。将您的文本文件放入其中。

您现在基本上有两个选择来准确放置文件：

1. 资源文件属于一个类。

这方面的一个例子是一个表示 GUI 元素（面板）的类，它还需要显示一些图像。

在这种情况下，将资源文件放在与相应类相同的目录（包）中。例如。对于名为your.pkg.YourClass 的类，将资源文件放入目录your/pkg：

src/main
 +-- java/
 |    +-- your/pkg/
 |    |    +-- YourClass.java
 +-- resources/
      +-- your/pkg/
           +-- resource-file.txt

您现在通过相应的类加载资源。在 your.pkg.YourClass 类中，您有以下代码 sn-p 用于加载：

String resource = "resource-file.txt"; // the "file name" without any package or directory
Class<?> clazz = this.getClass(); // or YourClass.class
URL resourceUrl = clazz.getResource(resource);
if (resourceUrl != null) {
    try (InputStream input = resourceUrl.openStream()) {
        // load the resource here from the input stream
    }
}

注意：你也可以通过类的类加载器来加载资源：

String resource = "your/pkg/resource-file.txt";
ClassLoader loader = this.getClass().getClassLoader(); // or YourClass.class.getClassLoader()
URL resourceUrl = loader.getResource(resource);
if (resourceUrl != null) {
    try (InputStream input = resourceUrl.openStream()) {
        // load the resource here from the input stream
    }
}

选择，你觉得更方便。

1. 资源整体属于应用程序。

在这种情况下，只需将资源直接放入src/main/resources 目录或适当的子目录即可。让我们看一个带有您的查找文件的示例：

src/main/resources/
    +-- LookupTables/
         +-- LookUpTable1.txt

然后您必须通过类加载器加载资源，使用当前线程的上下文类加载器或应用程序类加载器（任何更合适的 - 如果感兴趣，请搜索有关此问题的文章）。我将向您展示两种方式：

String resource = "LookupTables/LookUpTable1.txt";
ClassLoader ctxLoader = Thread.currentThread().getContextClassLoader();
ClassLoader sysLoader = ClassLoader.getSystemClassLoader();
URL resourceUrl = ctxLoader.getResource(resource); // or sysLoader.getResource(resource)
if (resourceUrl != null) {
    try (InputStream input = resourceUrl.openStream()) {
        // load the resource here from the input stream
    }
}

作为第一个建议，使用当前线程的上下文类加载器。在独立应用程序中，这将是系统类加载器或将系统类加载器作为父级。 （这些类加载器之间的区别对于同时加载资源的库将变得很重要。）

您应该始终使用类加载器来加载资源。通过这种方式，您可以独立于位置进行加载（只需在启动应用程序时注意文件位于类路径中），并且您可以将整个应用程序打包成一个 JAR 文件，该文件仍然可以找到资源。