如何确定我的 JavaFX 应用程序所需的 FXML 文件、CSS 文件、图像和其他资源的正确路径？

Question

我的 JavaFX 应用程序需要能够找到 FXML 文件以加载它们FXMLLoader，以及样式表（CSS 文件）和图像。当我尝试加载这些时，我经常遇到错误，或者我尝试加载的项目在运行时根本没有加载。

对于 FXML 文件，我看到的错误消息包括

Caused by: java.lang.NullPointerException: location is not set

对于图像，堆栈跟踪包括

Caused by: java.lang.IllegalArgumentException: Invalid URL: Invalid URL or resource not found

如何找出这些资源的正确资源路径？

Answer 1

答案的简短版本：

• 使用getClass().getResource(...)或SomeOtherClass.class.getResource(...)来创建URL资源
• 将绝对路径（带前导/）或相对路径（不带前导/）传递给getResource(...)方法。路径是包含资源的包，.替换为/.
• 不要 ..在资源路径中使用。如果并且当应用程序捆绑为 jar 文件时，这将不起作用。如果资源不在同一个包或类的子包中，请使用绝对路径。
• 对于 FXML 文件，将URL直接传递给FXMLLoader.
• 对于图像和样式表，呼吁toExternalForm()对URL生成String传递到Image或ImageView构造，或添加到stylesheets列表中。
• 要进行故障排除，请检查您的buid文件夹（或 jar 文件）的内容，而不是您的源文件夹。

完整答案

内容

1. 本回答的范围
2. 资源在运行时加载
3. JavaFX 使用 URL 加载资源
4. 资源名称规则
5. 创建一个资源 URL getClass().getResource(...)
6. 组织代码和资源
7. Maven（和类似的）标准布局
8. 故障排除

本回答的范围

请注意，此答案仅解决作为应用程序一部分并与其捆绑在一起的加载资源（例如 FXML 文件、图像和样式表）。因此，例如，加载用户从运行应用程序的机器上的文件系统中选择的图像将需要不同的技术，此处未涵盖。

资源在运行时加载

关于加载资源，首先要了解的是，它们当然是在运行时加载的。通常，在开发过程中，应用程序是从文件系统运行的：也就是说，运行它所需的类文件和资源是文件系统上的单个文件。然而，一旦应用程序被构建，它通常是从一个 jar 文件中执行的。在这种情况下，FXML 文件、样式表和图像等资源不再是文件系统上的单个文件，而是 jar 文件中的条目。所以：

代码不能使用File、FileInputStream或file:URL 来加载资源

JavaFX 使用 URL 加载资源

JavaFX 使用 URL 加载 FXML、图像和 CSS 样式表。

的FXMLLoader明确需要一个java.net.URL对象被传递给它（无论对static FXMLLoader.load(...)方法，所述FXMLLoader构造函数，或对setLocation()方法）。

双方Image并Scene.getStylesheets().add(...)希望String代表网址秒。如果 URL 在没有方案的情况下传递，它们将相对于类路径进行解释。这些字符串可以从创建URL一个可靠的方法调用toExternalForm()上URL。

为资源创建正确 URL 的推荐机制是使用Class.getResource(...)，它在适当的Class实例上调用。这样的类实例可以通过调用getClass()（给出当前对象的类）或ClassName.class. 该Class.getResource(...)方法采用String代表资源名称的 。

资源名称规则

• 资源名称是/分隔的路径名称。每个组件代表一个包或子包名称组件。
• 资源名称区分大小写。
• 资源名称中的各个组件必须是有效的 Java 标识符

最后一点有一个重要的后果：

.并且..不是有效的 Java 标识符，因此它们不能用于资源名称。

当应用程序从文件系统运行时，这些实际上可能起作用，尽管这实际上更像是getResource(). 当应用程序捆绑为 jar 文件时，它们将失败。

类似地，如果您在不区分仅因大小写而异的文件名的操作系统上运行，则在从文件系统运行时在资源名称中使用错误的大小写可能会起作用，但在从 jar 文件运行时会失败。

以前导开头的资源名称/是绝对的：换句话说，它们是相对于类路径解释的。没有前导的资源名称/相对于getResource()被调用的类进行解释。

对此的一个细微变化是使用getClass().getClassLoader().getResource(...). 提供给的路径ClassLoader.getResource(...) 不能以 a 开头/并且始终是绝对的，即它是相对于类路径的。还需要注意的是，在模块化应用中，对使用的资源的访问ClassLoader.getResource()，在某些情况下需要遵循强封装规则，另外包含资源的包必须无条件打开。有关详细信息，请参阅文档。

创建一个资源 URL getClass().getResource()

要创建资源 URL，请使用someClass.getResource(...). 通常，someClass表示当前对象的类，使用 获得getClass()。但是，情况并非一定如此，如下一节所述。

• 如果资源与当前类在同一个包中，或者在该类的子包中，请使用资源的相对路径：

   // FXML file in the same package as the current class:
   URL fxmlURL = getClass().getResource("MyFile.fxml");
   Parent root = FXMLLoader.load(fxmlURL);
  
   // FXML file in a subpackage called `fxml`:
   URL fxmlURL2 = getClass().getResource("fxml/MyFile.fxml");
   Parent root2 = FXMLLoader.load(fxmlURL2);
  
   // Similarly for images:
   URL imageURL = getClass().getResource("myimages/image.png");
   Image image = new Image(imageURL.toExternalForm());
  

• 如果资源位于不是当前类的子包的包中，请使用绝对路径。例如，如果当前类在 package 中org.jamesd.examples.view，而我们需要加载package 中的 CSS 文件style.css，则org.jamesd.examples.css必须使用绝对路径：

   URL cssURL = getClass().getResource("/org/jamesd/examples/css/style.css");
   scene.getStylesheets().add(cssURL.toExternalForm());
  

  值得在此示例中再次强调路径"../css/style.css"不包含有效的 Java 资源名称，如果应用程序捆绑为 jar 文件，则该路径将不起作用。

组织代码和资源

我建议将您的代码和资源组织到由它们关联的 UI 部分确定的包中。Eclipse 中的以下源代码布局给出了这种组织的示例：

使用这种结构，每个资源在同一个包中都有一个类，因此很容易为任何资源生成正确的 URL：

FXMLLoader editorLoader = new FXMLLoader(EditorController.class.getResource("Editor.fxml"));
Parent editor = editorLoader.load();
FXMLLoader sidebarLoader = new FXMLLoader(SidebarController.class.getResource("Sidebar.fxml"));
Parent sidebar = sidebarLoader.load();

ImageView logo = new ImageView();
logo.setImage(newImage(SidebarController.class.getResource("logo.png").toExternalForm()));

mainScene.getStylesheets().add(App.class.getResource("style.css").toExternalForm());

如果你有一个只有资源没有类的images包，例如下面布局中的包

您甚至可以考虑创建一个“标记界面”，仅用于查找资源名称：

package org.jamesd.examples.sample.images ;
public interface ImageLocation { }

现在，您可以轻松找到这些资源：

Image clubs = new Image(ImageLocation.class.getResource("clubs.png").toExternalForm());

从类的子包加载资源也相当简单。鉴于以下布局：

我们可以在App类中加载资源，如下所示：

package org.jamesd.examples.resourcedemo;

import java.net.URL;

import javafx.application.Application;
import javafx.fxml.FXMLLoader;
import javafx.scene.Parent;
import javafx.scene.Scene;
import javafx.stage.Stage;

public class App extends Application {

    @Override
    public void start(Stage primaryStage) throws Exception {        
        
        URL fxmlResource = getClass().getResource("fxml/MainView.fxml");
        
        
        FXMLLoader loader = new FXMLLoader();
        loader.setLocation(fxmlResource);
        Parent root = loader.load();
        Scene scene = new Scene(root);
        scene.getStylesheets().add(getClass().getResource("style/main-style.css").toExternalForm());
        primaryStage.setScene(scene);
        primaryStage.show();
    }
    
    public static void main(String[] args) {
        Application.launch(args);
    }

}

要加载不在加载它们的类的同一个包或子包中的资源，您需要使用绝对路径：

    URL fxmlResource = getClass().getResource("/org/jamesd/examples/resourcedemo/fxml/MainView.fxml");

Maven（和类似的）标准布局

Maven 和其他依赖管理和构建工具推荐了一种源文件夹布局，其中资源与 Java 源文件分开。上一个示例的 Maven 布局版本如下所示：

了解它是如何构建以组装应用程序很重要：

• *.java源文件夹中的文件src/main/java被编译为类文件，这些文件被部署到构建文件夹或jar文件中。
• 在资源的资源文件夹src/main/resources被复制到build文件夹或jar文件。

在此示例中，由于资源位于与定义源代码的包的子包相对应的文件夹中，因此生成的构建（在 Maven 中默认位于 中target/classes）由单个结构组成。

请注意，src/main/java和src/main/resources都被视为构建中相应结构的根，因此只有它们的内容，而不是文件夹本身，才是构建的一部分。换句话说，resources在运行时没有可用的文件夹。构建结构显示在下面的“故障排除”部分。

请注意，本例中的 IDE (Eclipse) 显示的src/main/java源文件夹与src/main/resources文件夹不同；在第一种情况下，它显示包，但对于资源文件夹，它显示文件夹。确保您知道您是在.IDE中创建包（名称以-delimited 分隔）还是文件夹（名称不得包含.，或任何其他在 Java 标识符中无效的字符）。

故障排除

如果出现意外错误，请首先检查以下内容：

• 确保您没有为资源使用无效名称。这包括在资源路径中使用.或..。
• 确保在预期的地方使用相对路径，在预期的地方使用绝对路径。因为Class.getResource(...)路径是绝对的，如果它有一个前导/，否则是相对的。对于ClassLoader.getResource(...)，路径始终是绝对的，不能用一个开始/。
• 请记住，绝对路径是相对于classpath定义的。通常，类路径的根是 IDE 中所有源文件夹和资源文件夹的联合。

如果所有这些看起来都正确，但您仍然看到错误，请检查构建或部署文件夹。此文件夹的确切位置因 IDE 和构建工具而异。如果您使用 Maven，默认情况下它是target/classes. 其他的构建工具和IDE将部署到命名的文件夹bin，classes，build，或out。

通常，您的 IDE 不会显示构建文件夹，因此您可能需要使用系统文件资源管理器进行检查。

上面 Maven 示例的组合源和构建结构是

如果要生成 jar 文件，某些 IDE 可能允许您在树视图中展开 jar 文件以检查其内容。您还可以使用以下命令检查命令行中的内容jar tf file.jar：

 // FXML file in the same package as the current class:
 URL fxmlURL = getClass().getResource("MyFile.fxml");
 Parent root = FXMLLoader.load(fxmlURL);

 // FXML file in a subpackage called `fxml`:
 URL fxmlURL2 = getClass().getResource("fxml/MyFile.fxml");
 Parent root2 = FXMLLoader.load(fxmlURL2);

 // Similarly for images:
 URL imageURL = getClass().getResource("myimages/image.png");
 Image image = new Image(imageURL.toExternalForm());

如果资源未部署，或部署到意外位置，请检查构建工具或 IDE 的配置。