JavaFX 21在GraalVM Native Image中CSS样式表资源未打包？ResourceBundles与RuntimeResourceAccess配置 - 智猿学院-前后端，数据库，人工智能，云计算等领域前沿技术讲座

好的，现在我们开始。

JavaFX 21 与 GraalVM Native Image：CSS 资源与 RuntimeResourceAccess 配置

各位，今天我们来深入探讨一个在使用 JavaFX 21 和 GraalVM Native Image 时经常遇到的问题：CSS 样式表资源未被正确打包到 Native Image 中。这个问题看似简单，但背后涉及 GraalVM Native Image 的构建机制、JavaFX 的资源加载方式以及 ResourceBundle 的特殊处理。我们将从问题的现象、原因分析到解决方案，一步步剖析，并提供可操作的代码示例。

问题现象：CSS 样式丢失

在使用 GraalVM Native Image 构建 JavaFX 应用后，运行时发现应用的样式完全错乱，原本通过 CSS 样式表定义的各种视觉效果全部消失。检查构建后的可执行文件，发现 CSS 文件确实没有被包含进去。

问题原因：静态分析与动态资源加载

GraalVM Native Image 的构建过程依赖于静态分析。它会扫描应用程序的代码，找出所有需要被包含到 Native Image 中的类、资源和依赖项。然而，JavaFX 常常使用动态资源加载的方式，例如使用 getClass().getResource() 或 getClass().getResourceAsStream() 来加载 CSS 文件。这种动态加载在静态分析时难以被准确识别，导致 CSS 文件被漏掉。

此外，如果 CSS 文件是通过 ResourceBundle 间接引用的，问题会更加复杂。ResourceBundle 本身也需要额外的配置才能被正确处理。

ResourceBundle 的特殊性

ResourceBundle 用于国际化和本地化，它允许应用程序根据不同的语言环境加载不同的资源文件。如果 CSS 文件的路径存储在 ResourceBundle 中，Native Image 构建器需要知道这个 ResourceBundle 的存在以及它包含的资源文件，才能将 CSS 文件包含进去。

解决方案：RuntimeResourceAccess 配置

解决这个问题的关键在于通过 RuntimeResourceAccess 配置显式地告诉 Native Image 构建器哪些资源需要在运行时被访问。我们需要使用 reflect-config.json 文件或者通过编程方式来指定这些资源。

1. 使用 reflect-config.json 文件

reflect-config.json 文件是 GraalVM Native Image 构建器读取的配置文件，用于指定需要在运行时进行反射、动态代理和资源访问的类和资源。

首先，我们需要创建一个 reflect-config.json 文件，并将其放置在 src/main/resources/META-INF/native-image/<groupId>/<artifactId> 目录下，其中 <groupId> 和 <artifactId> 分别是你的 Maven 或 Gradle 项目的 Group ID 和 Artifact ID。

例如，如果你的 Group ID 是 com.example，Artifact ID 是 javafx-app，那么 reflect-config.json 文件应该放置在 src/main/resources/META-INF/native-image/com.example/javafx-app/ 目录下。

然后，在 reflect-config.json 文件中添加以下内容，以注册 CSS 文件：

[
  {
    "name": "com.example.MainApplication",
    "methods": [
      {
        "name": "loadCSS",
        "parameterTypes": []
      }
    ]
  },
  {
    "name": "javafx.scene.Parent",
    "methods": [
      {
        "name": "getStylesheets",
        "parameterTypes": []
      }
    ]
  },
  {
    "name": "java.util.ArrayList",
    "methods": [
      {
        "name": "add",
        "parameterTypes": [
          "java.lang.Object"
        ]
      }
    ]
  },
  {
    "name": "java.lang.String",
    "methods": []
  },
  {
    "name": "java.lang.Class",
    "methods": [
      {
        "name": "getResource",
        "parameterTypes": [
          "java.lang.String"
        ]
      }
    ]
  }
]

这个配置允许 com.example.MainApplication 类中的 loadCSS 方法被反射调用，并允许访问 javafx.scene.Parent 的 getStylesheets 方法，以及对 java.util.ArrayList 进行操作，并允许访问 java.lang.Class 的 getResource 方法。

接下来，我们需要配置资源访问。创建一个 resource-config.json 文件，放在与 reflect-config.json 相同的目录下：

{
  "resources": {
    "includes": [
      {
        "pattern": "\.css$"
      },
      {
        "pattern": "messages.*\.properties$"
      }
    ]
  },
  "bundles": [
    {
      "name": "messages"
    }
  ]
}

这个配置文件告诉 Native Image 构建器包含所有以 .css 结尾的文件和 messages.properties 开头的文件，并将 messages 作为 ResourceBundle 进行处理。

2. 使用编程方式配置 RuntimeResourceAccess

除了使用配置文件，我们还可以通过编程方式配置 RuntimeResourceAccess。这需要在构建过程中使用 GraalVM Native Image 提供的 API。

首先，确保你的项目依赖了 GraalVM SDK。可以在 Maven 或 Gradle 中添加相应的依赖项。

例如，在 Maven 中添加以下依赖项：

<dependency>
    <groupId>org.graalvm.sdk</groupId>
    <artifactId>graal-sdk</artifactId>
    <version>${graalvm.version}</version>
    <scope>provided</scope>
</dependency>

然后，在你的代码中，可以使用 Feature 接口来注册需要在运行时访问的资源。

import org.graalvm.nativeimage.hosted.Feature;
import org.graalvm.nativeimage.hosted.RuntimeResourceAccess;
import org.graalvm.nativeimage.ImageInfo;

public class CSSResourceFeature implements Feature {

    @Override
    public void duringSetup(Feature.SetupAccess access) {
        if (!ImageInfo.inImageBuildtimeCode()) {
            return;
        }

        // 注册 CSS 资源
        RuntimeResourceAccess.addResource("com/example/style.css");
    }
}

在这个例子中，CSSResourceFeature 类实现了 Feature 接口，并在 duringSetup 方法中注册了 com/example/style.css 资源。

为了让 GraalVM Native Image 构建器识别这个 Feature，需要在 META-INF/native-image/com.example/javafx-app/native-image.properties 文件中注册它：

Args = --features=com.example.CSSResourceFeature

代码示例：完整的 JavaFX 应用

下面是一个完整的 JavaFX 应用示例，演示了如何加载 CSS 文件并配置 RuntimeResourceAccess。

package com.example;

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

import java.io.IOException;
import java.util.Objects;

public class MainApplication extends Application {

    @Override
    public void start(Stage stage) throws IOException {
        Parent root = FXMLLoader.load(Objects.requireNonNull(getClass().getResource("main-view.fxml")));
        Scene scene = new Scene(root, 600, 400);
        scene.getStylesheets().add(Objects.requireNonNull(getClass().getResource("style.css")).toExternalForm());
        stage.setTitle("JavaFX App");
        stage.setScene(scene);
        stage.show();
    }

    public static void main(String[] args) {
        launch();
    }

    public void loadCSS() {
        // This method is intentionally left blank but is used in the reflect-config.json
        // This is to ensure that the class loader has access to the resources.
    }
}

package com.example;

import javafx.fxml.FXML;
import javafx.scene.control.Label;

public class MainController {

    @FXML
    private Label welcomeText;

    @FXML
    protected void onHelloButtonClick() {
        welcomeText.setText("Welcome to JavaFX Application!");
    }
}

main-view.fxml:

<?xml version="1.0" encoding="UTF-8"?>

<?import javafx.geometry.Insets?>
<?import javafx.scene.layout.VBox?>

<?import javafx.scene.control.Label?>
<?import javafx.scene.control.Button?>
<VBox alignment="CENTER" spacing="20.0" xmlns="http://javafx.com/javafx" xmlns:fx="http://javafx.com/fxml"
        fx:controller="com.example.MainController">
    <padding>
        <Insets bottom="20.0" left="20.0" right="20.0" top="20.0"/>
    </padding>

    <Label fx:id="welcomeText"/>
    <Button text="Hello!" onAction="#onHelloButtonClick"/>
</VBox>

style.css:

.root {
    -fx-background-color: lightblue;
}

.label {
    -fx-font-size: 20px;
    -fx-text-fill: darkblue;
}

.button {
    -fx-background-color: steelblue;
    -fx-text-fill: white;
    -fx-font-size: 16px;
}

在这个示例中，MainApplication 类加载了 style.css 文件。为了确保这个 CSS 文件被包含到 Native Image 中，我们需要配置 reflect-config.json 和 resource-config.json 文件，如上所述。

ResourceBundle 与 CSS 路径

如果 CSS 文件的路径存储在 ResourceBundle 中，我们需要确保 ResourceBundle 被正确配置，并且 CSS 文件也被包含进去。

例如，假设我们有一个 messages.properties 文件，其中包含 CSS 文件的路径：

css.path=com/example/style.css

然后，在 Java 代码中，我们使用 ResourceBundle 来加载 CSS 文件的路径：

ResourceBundle bundle = ResourceBundle.getBundle("messages");
String cssPath = bundle.getString("css.path");
scene.getStylesheets().add(Objects.requireNonNull(getClass().getResource(cssPath)).toExternalForm());

在这种情况下，我们需要在 resource-config.json 文件中指定 messages 作为 ResourceBundle，并包含 CSS 文件：

{
  "resources": {
    "includes": [
      {
        "pattern": "\.css$"
      },
      {
        "pattern": "messages.*\.properties$"
      }
    ]
  },
  "bundles": [
    {
      "name": "messages"
    }
  ]
}

构建 Native Image

配置完成后，我们可以使用 GraalVM Native Image 构建器来构建 Native Image。

首先，确保你已经安装了 GraalVM 和 Native Image 组件。

然后，使用 Maven 或 Gradle 构建你的项目，并运行 Native Image 构建器。

例如，使用 Maven：

mvn clean install -Pnative

或者，使用 Gradle：

./gradlew clean build nativeCompile

构建完成后，你将在 target/native-image 目录下找到可执行文件。

调试与测试

构建完成后，运行可执行文件，检查 CSS 样式是否正确加载。如果样式仍然丢失，可以使用 GraalVM 提供的调试工具来诊断问题。

例如，可以使用 native-image-agent 来收集运行时信息，并生成 reflect-config.json 和 resource-config.json 文件。

java -agentlib:native-image-agent=config-output-dir=./config -jar your-app.jar

运行应用程序后，config 目录下将生成 reflect-config.json 和 resource-config.json 文件。你可以检查这些文件，并根据需要进行修改。

总结：正确的资源配置是关键

正确配置 GraalVM Native Image 的 RuntimeResourceAccess 是确保 CSS 样式表资源被正确打包的关键。通过 reflect-config.json 文件或编程方式，显式地告诉 Native Image 构建器哪些资源需要在运行时被访问，可以有效地解决 CSS 样式丢失的问题。同时，要特别注意 ResourceBundle 的特殊性，确保它也被正确配置。

通过以上步骤，你应该能够成功地将 CSS 样式表资源打包到 GraalVM Native Image 中，并构建出高性能的 JavaFX 应用。

进一步的注意事项

动态加载的复杂性： 对于更复杂的动态加载场景，可能需要使用 GraalVM 提供的更高级的 API，例如 org.graalvm.nativeimage.hosted.RuntimeReflection。
第三方库的依赖： 如果你的 JavaFX 应用依赖于第三方库，并且这些库也使用了动态资源加载，你需要确保这些库的资源也被正确配置。
持续集成与自动化： 将 Native Image 构建过程集成到你的持续集成流程中，可以帮助你尽早发现和解决问题。

最后，再次强调：

确保 reflect-config.json 和 resource-config.json 文件放置在正确的目录下。
仔细检查配置文件中的模式，确保它们能够匹配到所有的 CSS 文件和 ResourceBundle。
使用调试工具来诊断问题，并根据需要修改配置文件。

希望这篇讲座能够帮助你解决在使用 JavaFX 21 和 GraalVM Native Image 时遇到的 CSS 资源问题。记住，细致的配置和充分的测试是成功的关键。

保持优化，享受编程！

要点概括：显式配置，细致检查，充分测试

通过 RuntimeResourceAccess 配置显式地告诉 Native Image 构建器哪些资源需要在运行时被访问是解决 CSS 样式丢失问题的关键。ResourceBundle 的特殊性需要特别注意。细致的配置和充分的测试是成功的保证。

JavaFX 21 与 GraalVM Native Image：CSS 资源与 RuntimeResourceAccess 配置

发表回复 取消回复

发表回复取消回复