如何在jlink之后获取资源路径？

Question

如何在jlink之后获取资源路径？

javamavenvisual-studio-codejavafxjlink

4

我正在尝试使用Maven和Visual Studio Code使我的JavaFx应用程序可执行。

在这个主题上花费了一些时间后，我发现了一些提到jlink的帖子。

对于打包Java/JavaFX应用程序，我还是一个新手，所以我尝试了一下。

目前，我至少可以执行打包的启动器。

但是，在启动应用程序后立即抛出NullPointerException： 无法调用"Object.toString()"，因为"java.lang.Class.getResource(String)"的返回值为null。

为了样式化视图组件，我创建了一些.css文件，并将它们放在/style目录中。根据示例JavaFx应用程序的要求，我将此目录放置在Maven创建的/resources目录中。我以类似的方式处理声音和图像文件。

这里您可以看到我的目录结构摘录。

|
|--src/main
|  |
|  |-- java
|  |   | ...
|  |
|  |-- resources
|      |
|      |-- img
|      |   | ...    
|      |
|      |-- style
|      |   | ...
|      |
|      |-- sound
|          | ...
|
|-- target
    |
    |-- classes
    |   | ...
    |   |
    |   |-- img
    |   |   | ...
    |   |
    |   |-- style
    |   |   | ...
    |   |
    |   |-- sound
    |   |   | ...
    |
    |-- ...
    |
    |-- app
        |
        |-- bin
        |-- ...

现在我正在尝试从我的应用程序中访问资源。

这是我的第一种方法。在从VSCode运行时它可以正常工作。

    public static final String PATH_TO_STYLESHEET = App.class.getResource("/style").toString();
    public static final String PATH_TO_IMG = App.class.getResource("/img").toString();
    public static final String PATH_TO_SOUNDS = App.class.getResource("/sounds").toString();

但是在运行jlink之后，我的应用程序崩溃了，显示了前面提到的NullPointerException。

这是我的pom.xml文件：

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
    
    <modelVersion>4.0.0</modelVersion>
    <groupId>org.openjfx</groupId>
    <artifactId>App</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    
    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <maven.compiler.release>19</maven.compiler.release>
        <javafx.version>19</javafx.version>
        <javafx.maven.plugin.version>0.0.8</javafx.maven.plugin.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.openjfx</groupId>
            <artifactId>javafx-controls</artifactId>
            <version>${javafx.version}</version>
        </dependency>
        <dependency>
            <groupId>org.openjfx</groupId>
            <artifactId>javafx-media</artifactId>
            <version>${javafx.version}</version>
        </dependency>
        <dependency>
            <groupId>org.openjfx</groupId>
            <artifactId>javafx-fxml</artifactId>
            <version>${javafx.version}</version>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>3.8.1</version>
                <configuration>
                    <release>${maven.compiler.release}</release>
                </configuration>
            </plugin>
            <plugin>
                <groupId>org.openjfx</groupId>
                <artifactId>javafx-maven-plugin</artifactId>
                <version>${javafx.maven.plugin.version}</version>
                <configuration>
                    <release>${maven.compiler.release}</release>
                    <jlinkImageName>App</jlinkImageName>
                    <launcher>launcher</launcher>
                    <mainClass>com.test.App</mainClass>
                </configuration>
            </plugin>
        </plugins>
        <resources>
            <resource>
                <directory>src/main/resources</directory>
            </resource>
        </resources>
    </build>
    
</project>

这是我一直在使用的创建包的命令。

mvn javafx:jlink -f pom.xml

有人知道如何在运行jlink后获取我的样式表、图片和声音的路径吗？路径绝对足够了，我不需要文件本身。

是否有选项将资源复制到特定位置？

- DevFromAbove

3

您在jlink之前的工作状态应该在jlink之后也“只要正常工作”。看起来您的资源正在错误地打包。您可以展示您的pom.xml文件以及您用于创建自定义运行时镜像的确切命令（一步一步的）吗？ - Slaw

1个回答

网页内容由stack overflow 提供, 点击上面的

可以查看英文原文，
原文链接

- Slaw · Accepted Answer

问题

您有以下代码：

public static final String PATH_TO_IMG = App.class.getResource("/img").toString();

这是试图获取资源"/img"。但根据您的问题，那不是一个资源本身，而是一个目录（即包）。问题似乎出在Class#getResource(String)无法一致地处理String参数表示目录时的行为上。当您的代码不在JRT映像中时，对#getResource(String)的调用将返回一个URL；当您的代码打包在JRT映像中时，则相同的调用将返回null，尽管该目录存在。

我不知道这种行为是一个错误还是简单地未定义。有趣的是ModuleReader#find(String)明显能够找到目录：

查找资源，在模块中返回指向资源的URI。

如果模块读取器可以确定名称定位目录，则生成的URI将以斜杠（'/'）结尾。

对我来说，这意味着你正在尝试做的事情应该是可能的。但是，即使使用该方法在模块被打包为JRT映像时也会失败（通过返回空的Optional）。请注意，如果您查询ModuleReader# list（）方法，当模块不在JRT图像中时，它将包括目录，但是当模块在 JRT映像中时，这些相同的目录不会被包括在内。

示例

我已经在答案末尾放了一个最小示例来演示此问题。

一个解决方案

我假设您正在使用这些常量（例如PATH_TO_IMG）来执行以下操作：

Image image = new Image(PATH_TO_IMG + "foo.png");

避免在各处调用SomeClass.class.getResource("...").toString()。如果这是你的目标，那么我可以想到至少一种解决方案。将你的常量更改为简单地引用资源根目录。例如：

public static final String IMG_ROOT = "/img";

然后创建一个��用方法来解析资源：

public static String getImagePath(String name) {
    var resource = IMG_ROOT + "/" + name;
    var url = App.class.getResource(resource);
    if (url == null) {
        throw new RuntimeException("could not find resource: " + resource);
    }
    return url.toString();
}

然后你可以像这样使用那个实用方法：

Image image = new Image(getImagePath("foo.png"));

可能的替代方案

另一个选择可能是利用JRT FileSystem实现。类似以下内容：

FileSystem jrtFs = FileSystems.getFileSystem(URI.create("jrt:/"));
Path path = jrtFs.getPath("modules", "<module-name>", "img");
// Note: Doesn't seem to include the trailing '/'
String pathToImg = path.toUri().toString();

虽然你需要检测你的代码是否在JRT图像中。

最小示例

考虑到这与JavaFX无关，我创建了一个最小示例来演示这个问题。

Maven 3.8.6
OpenJDK 19.0.1 2022-10-18
在Windows 11上测试通过

源代码

项目结构：

|   pom.xml
|
\---src
    \---main
        +---java
        |   |   module-info.java
        |   |
        |   \---sample
        |           Main.java
        |
        \---resources
            \---data
                    file.txt

pom.xml:

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
    
    <modelVersion>4.0.0</modelVersion>
    <groupId>sample</groupId>
    <artifactId>app</artifactId>
    <version>1.0-SNAPSHOT</version>
    
    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <maven.compiler.release>19</maven.compiler.release>
    </properties>

    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>3.10.1</version>
            </plugin>
            
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-resources-plugin</artifactId>
                <version>3.3.0</version>
            </plugin>

            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-jar-plugin</artifactId>
                <version>3.3.0</version>
            </plugin>

            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-jlink-plugin</artifactId>
                <version>3.1.0</version>
                <configuration>
                    <launcher>app=app/sample.Main</launcher>
                </configuration>
            </plugin>
        </plugins>
    </build>
</project>

module-info.java:

module app {}

Main.java:

package sample;

public class Main {

    public static void main(String[] args) {
        var modRef = Main.class.getModule()
            .getLayer()
            .configuration()
            .findModule(Main.class.getModule().getName())
            .orElseThrow()
            .reference();
        System.out.printf("Module Location = %s%n%n", modRef.location().orElseThrow());

        var dataUrl = Main.class.getResource("/data");
        var fileUrl = Main.class.getResource("/data/file.txt");
        System.out.printf("Data URL = %s%nFile URL = %s%n%n", dataUrl, fileUrl);
    }
}

构建

我运行了以下两个命令来构建项目：

mvn compile jar:jar
mvn jlink:jlink

由于某种原因，执行 mvn compile jar:jar jlink:jlink 导致 jlink 任务失败。

输出

以下是不同打包方式的输出结果：

模块化解压版：

...> java -p target\classes -m app/sample.Main
Module Location = file:///C:/Users/***/Desktop/jlink-tests/target/classes/

Data URL = file:/C:/Users/***/Desktop/jlink-tests/target/classes/data/
File URL = file:/C:/Users/***/Desktop/jlink-tests/target/classes/data/file.txt

模块化 JAR 文件：

...> java -p target\app-1.0-SNAPSHOT.jar -m app/sample.Main
Module Location = file:///C:/Users/***/Desktop/jlink-tests/target/app-1.0-SNAPSHOT.jar

Data URL = jar:file:///C:/Users/***/Desktop/jlink-tests/target/app-1.0-SNAPSHOT.jar!/data/
File URL = jar:file:///C:/Users/***/Desktop/jlink-tests/target/app-1.0-SNAPSHOT.jar!/data/file.txt

JRT 图像：

...> .\target\maven-jlink\default\bin\app
Module Location = jrt:/app

Data URL = null
File URL = jrt:/app/data/file.txt

结果

正如您所看到的，对于getResource("/data/file.txt")的调用每次都有效，但是对于JRT打包版本中的getResource("/data")的调用则无效。