javafx - 如何确定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列表中。




完整答案

内容


这个答案的范围
资源在运行时加载
JavaFX使用URL加载资源
资源名称规则
使用getClass().getResource(...)创建资源URL
组织代码和资源
Maven（和类似的）标准布局
故障排除




这个答案的范围

请注意，此答案仅解决了作为应用程序一部分并与之捆绑在一起的加载资源（例如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(...)都期望表示URL的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(...)的路径始终是绝对路径，即相对于类路径。

使用getClass().getResource()创建资源URL

要创建资源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());

如果资源位于不是当前类的子包的包中，请使用绝对路径。例如，如果当前类在包 org.jamesd.examples.view中，并且我们需要加载在包 style.css中的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中的资源被复制到构建文件夹或jar文件。


在此示例中，由于资源位于与定义了源代码的包的子包相对应的文件夹中，因此生成的内部版本（默认情况下，Maven在 target/classes中）包含单个结构。

请注意， src/main/java和 src/main/resources都被认为是构建中相应结构的根，因此，构建中仅包含它们的内容，而不是文件夹本身。换句话说，运行时没有 resources文件夹可用。下面的“疑难解答”部分中显示了构建结构。

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



故障排除

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


确保您的资源没有使用无效的名称。这包括在资源路径中使用 .或 ..。
确保在预期的位置使用相对路径，在预期的位置使用绝对路径。对于 Class.getResource(...)，如果路径具有前导 /，则该路径为绝对路径，否则为相对路径。对于 ClassLoader.getResource(...)，该路径始终是绝对路径。
请记住，绝对路径是相对于类路径定义的。通常，类路径的根是IDE中所有源和资源文件夹的并集。


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

通常，您的IDE不会显示build文件夹，因此您可能需要使用系统文件浏览器进行检查。

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



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

$ jar -tf resource-demo-0.0.1-SNAPSHOT.jar 
META-INF/
META-INF/MANIFEST.MF
org/
org/jamesd/
org/jamesd/examples/
org/jamesd/examples/resourcedemo/
org/jamesd/examples/resourcedemo/images/
org/jamesd/examples/resourcedemo/style/
org/jamesd/examples/resourcedemo/fxml/
org/jamesd/examples/resourcedemo/images/so-logo.png
org/jamesd/examples/resourcedemo/style/main-style.css
org/jamesd/examples/resourcedemo/Controller.class
org/jamesd/examples/resourcedemo/fxml/MainView.fxml
org/jamesd/examples/resourcedemo/App.class
module-info.class
META-INF/maven/
META-INF/maven/org.jamesd.examples/
META-INF/maven/org.jamesd.examples/resource-demo/
META-INF/maven/org.jamesd.examples/resource-demo/pom.xml
META-INF/maven/org.jamesd.examples/resource-demo/pom.properties
$ 

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