提问者:小点点

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


我的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

如何计算出这些资源的正确资源路径?


共1个答案

匿名用户

  • 使用GetClass().GetResource(。。。)SometherClass.Class.GetResource(。。。)创建指向资源的URL
  • 将绝对路径(带前导/)或相对路径(不带前导/)传递给GetResource(。。。)方法。 路径是包含资源的包,.替换为/.
  • 不要在资源路径中使用..。 如果并且当应用程序被捆绑为jar文件时,这将不起作用。 如果资源不在同一个包或类的子包中,请使用绝对路径。
  • 对于FXML文件,将URL直接传递给FXMLLoader
  • 对于图像和样式表,调用URL上的ToExternalForm()以生成要传递给ImageImageView构造函数的字符串,或者添加到样式表列表中。
  1. 此答案的范围
  2. 资源在运行时加载
  3. JavaFX使用URL加载资源
  4. 资源名称规则
  5. 使用getClass()。getResource(。。。)
  6. 创建资源URL
  7. 组织代码和资源
  8. Maven(和类似的)标准布局
  9. 疑难解答

null

注意,这个答案只处理加载资源(例如FXML文件,图像和样式表),这些资源是应用程序的一部分,并且与应用程序捆绑在一起。 因此,例如,加载用户从运行应用程序的计算机上的文件系统中选择的映像将需要不同的技术,这里没有介绍这些技术。

null

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

代码不能使用filefileInputStreamfile:URL加载资源

null

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

FXMLLoader显式地期望将java.net.url对象传递给它(传递给staticFXMLLoader.Load(。。。)方法,传递给FXMLLoader构造函数或传递给SetLocation()方法)。

imagescene.getStyleSheets()。add(。。。)都需要表示URL的string。 如果在没有方案的情况下传递URL,则相对于类路径解释URL。 通过调用URL上的ToExternalForm(),可以通过URL以健壮的方式从URL创建这些字符串。

为资源创建正确URL的推荐机制是使用Class.GetResource(。。。),它在适当的实例上调用。 这样的类实例可以通过调用getClass()(它给出了当前对象的类)或className.class来获得。 Class.GetResource(。。。)方法采用表示资源名称的字符串

null

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

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

...不是有效的Java标识符,因此不能在资源名称中使用。

当应用程序从文件系统中运行时,这些可能会实际工作,尽管这实际上更多是getResource()实现的意外。 当应用程序捆绑为jar文件时,它们将失败。

类似地,如果您运行的操作系统不区分文件名的大小写差异,那么在从文件系统运行时在资源名中使用错误的大小写可能会起作用,但从jar文件运行时将会失败。

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

这方面的一个细微变化是使用getClass()。getClassLoader()。getResource(。。。)。 提供给ClassLoader.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());
    

    如果资源所在的包不是当前类的子包,请使用绝对路径。 例如,如果当前类位于org.jamesd.examples.view包中,并且我们需要加载位于org.jamesd.examples.CSS包中的CSS文件style.CSS,我们必须使用绝对路径:

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

    在本例中值得再次强调的是,路径“。。/css/style.css”不包含有效的Java资源名称,如果应用程序被捆绑为jar文件,则该路径将无法工作。

    null

    我建议将您的代码和资源组织到包中,这些包由它们所关联的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");
    

    null

    Maven和其他依赖关系管理和构建工具推荐一种源文件夹布局,其中资源与Java源文件分离。 前面示例的Maven布局版本如下所示:

    了解如何构建此组件以组装应用程序是很重要的:

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

    在本例中,由于资源位于与定义源代码的包的子包相对应的文件夹中,因此生成的构建(默认情况下,Maven位于目标/类中)由单个结构组成。

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

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

    null

    如果您得到了您不期望的错误,首先检查以下内容:

    • 请确保没有为资源使用无效名称。 这包括在资源路径中使用...
    • 确保在需要的地方使用相对路径,在需要的地方使用绝对路径。 对于类。GetResource(。。。),如果路径具有前导/,则路径为绝对路径,否则为相对路径。 对于ClassLoader.GetResource(。。。),路径始终是绝对的。
    • 请记住,绝对路径是相对于类路径定义的。 通常,类路径的根是IDE中所有源和资源文件夹的联合。

    如果所有这些看起来都是正确的,并且您仍然看到错误,请检查构建或部署文件夹。 此文件夹的确切位置将因IDE和生成工具而异。 如果您使用的是Maven,默认情况下它是目标/类。 其他生成工具和IDE将部署到名为binbuildout的文件夹。

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

    上面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的配置。