Стили JavaFX теряются при загрузке внешнего Jar (архитектура плагина) - PullRequest
0 голосов
/ 31 декабря 2018

Я пытаюсь создать приложение JavaFX, которое может работать с плагинами, эти плагины - это другие jar-файлы, загружаемые во время выполнения и открываемые для поиска реализации конкретного интерфейса, который я создал, я могу загрузить jar-файл инайти определенный класс, но некоторые стили, которые не могут быть загружены в загруженную банку, позвольте мне объяснить, что я сделал:

Я создал три проекта maven, следующие проекты:

Core : имеет интерфейс, который должен реализовывать плагин (TestPlugin.java), и интерфейс, который должна реализовывать основная программа (TestSceneHandler.java)

TestPlugin.java

public interface TestPlugin {

    void init(TestSceneHandler sceneHandler);

}

TestSceneHandler.java

import javafx.scene.Parent;

public interface TestSceneHandler {

    void setView(Parent node);

}

Плагин : Имеет Core в качестве зависимости и класс, который реализует TestPlugin.java, я оставил Main.java такон может работать в обоих режимах, в приложении sigle и в плагине, но на самом деле это не обязательно1027 *

import javafx.application.Application;
import javafx.scene.Scene;
import javafx.stage.Stage;

public class Main extends Application {

    @Override
    public void start(Stage primaryStage) throws Exception{
        primaryStage.setTitle("Hello World");
        primaryStage.setScene(new Scene(new MyTestViewController(), 300, 275));
        primaryStage.show();
    }


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

pluginView.fxml

<?import javafx.scene.layout.GridPane?>

<?import javafx.scene.control.Label?>
<fx:root  xmlns:fx="http://javafx.com/fxml/1"
          type="javafx.scene.layout.GridPane"
          alignment="center" hgap="10" vgap="10" stylesheets="style.css">
    <Label>
        Hello world
    </Label>
</fx:root>

style.css

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

Приложение : имеет Core в качестве зависимостии класс, реализующий TestSceneHandler.java

Main.java

import javafx.application.Application;
import javafx.scene.Scene;
import javafx.stage.Stage;

public class Main extends Application {

    @Override
    public void start(Stage primaryStage) throws Exception{
        primaryStage.setTitle("Hello World");
        primaryStage.setScene(new Scene(new TestScene(), 300, 275));
        primaryStage.show();
    }


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

sample.fxml

<?import javafx.scene.layout.HBox?>
<?import javafx.scene.control.Label?>
<fx:root xmlns:fx="http://javafx.com/fxml/1"
     type="javafx.scene.layout.BorderPane">

    <top>
        <HBox style="-fx-background-color: orange;">
            <children>
                <Label>
                    This is the header
                </Label>
            </children>
        </HBox>
    </top>

</fx:root>

TestScene.java

import javafx.fxml.FXMLLoader;
import javafx.scene.Parent;
import javafx.scene.layout.BorderPane;

import java.io.*;
import java.net.URL;
import java.net.URLClassLoader;
import java.util.Arrays;
import java.util.Enumeration;
import java.util.jar.JarEntry;
import java.util.jar.JarFile;
import java.util.zip.ZipFile;

public class TestScene extends BorderPane implements TestSceneHandler {

    private static final String ROOT_FOLDER = "Zamba";
    private static final String PLUGIN_FOLDER = "plugins";
    private static final String USER_HOME = System.getProperty("user.home");

    public TestScene() {
        FXMLLoader fxmlLoader = new FXMLLoader(getClass().getResource("/sample.fxml"));
        fxmlLoader.setRoot(this);
        fxmlLoader.setController(this);

        try {
            fxmlLoader.load();
        } catch (IOException exception) {
            throw new RuntimeException(exception);
        }

        File pluginFolder = initFolder();
        readPlugins(pluginFolder);
    }

    private File initFolder() {
        final String ROOT_FOLDER_PATH = USER_HOME + "/" + ROOT_FOLDER;
        final String PLUGIN_FOLDER_PATH = ROOT_FOLDER_PATH + "/" + PLUGIN_FOLDER;

        File appFolder = new File(ROOT_FOLDER_PATH);

        if(!appFolder.exists()) {
            appFolder.mkdir();
        }

        File pluginFolder = new File(PLUGIN_FOLDER_PATH);

        if(!pluginFolder.exists()) {
            pluginFolder.mkdir();
        }

        return pluginFolder;
    }

    /**
     * Determine whether a file is a JAR File.
     */
    public static boolean isJarFile(File file) throws IOException {
        if (!isZipFile(file)) {
            return false;
        }
        ZipFile zip = new ZipFile(file);
        boolean manifest = zip.getEntry("META-INF/MANIFEST.MF") != null;
        zip.close();
        return manifest;
    }
    /**
     * Determine whether a file is a ZIP File.
     */
    public static boolean isZipFile(File file) throws IOException {
        if(file.isDirectory()) {
            return false;
        }
        if(!file.canRead()) {
            throw new IOException("Cannot read file "+file.getAbsolutePath());
        }
        if(file.length() < 4) {
            return false;
        }
        DataInputStream in = new DataInputStream(new BufferedInputStream(new FileInputStream(file)));
        int test = in.readInt();
        in.close();
        return test == 0x504b0304;
    }

    private void readPlugins(File pluginFolder) {
        File[] pluginFolderFiles = pluginFolder.listFiles();
        Arrays.asList(pluginFolderFiles).forEach(file -> {
            System.out.println("Filee: " + file.getAbsolutePath());

            try {
                if(isJarFile(file)) {
                    JarFile jarFile = new JarFile(file);

                    Enumeration<JarEntry> e = jarFile.entries();

                    URL[] urls = { new URL("jar:file:" + file.getAbsolutePath()+"!/") };
                    URLClassLoader cl = URLClassLoader.newInstance(urls);

                    while (e.hasMoreElements()) {
                        JarEntry je = e.nextElement();

                        if(je.isDirectory() || !je.getName().endsWith(".class")){
                            continue;
                        }

                        // -6 because of .class
                        String className = je.getName().substring(0,je.getName().length()-6);
                        className = className.replace('/', '.');

                        Class c = cl.loadClass(className);

                        if(TestPlugin.class.isAssignableFrom(c) && c != TestPlugin.class) {
                            System.out.println("Plugin found!!!");

                            TestPlugin plugin = (TestPlugin)c.newInstance();
                            plugin.init(this);
                        }

                    }

                }
            } catch (Exception e) {
                e.printStackTrace();
            }
        });
    }

    @Override
    public void setView(Parent parent) {
        setCenter(parent);
    }
}

При выполнении проекта Плагин в качестве отдельного приложения это результат:

Correct styles

Но когда он выполняется через приложение проекция, результат следующий:

Invalid styles

Как видите, стили исчезли, и у меня возникла ошибка на консоли:

Plugin found!!!
dic 30, 2018 5:41:30 PM com.sun.javafx.css.StyleManager loadStylesheetUnPrivileged
WARNING: Resource "style.css" not found.

1 Ответ

0 голосов
/ 31 декабря 2018

Проблема вызвана проблемой classpath, так как вы создаете свой собственный ClassLoader для загрузки своих плагинов.Значение атрибута stylesheet в вашем FXML равно style.css.Это то же самое, что и:

GridPane pane = new GridPane();
pane.getStylesheets().add("style.css");

, который будет искать ресурс с именем style.css относительно корня пути к классам.Это потому, что нет схемы;см. документацию для подробностей.Проблема заключается в том, что это поведение использует ClassLoader для классов JavaFX для загрузки ресурса.К сожалению, ваш ресурс не виден этому ClassLoader, а скорее ClassLoader, который вы создали для загрузки плагина.

Исправление для этого заключается в предоставлении полного URL-адреса для файла ресурсов CSS.Это делается с помощью @ (см. Введение в FXML ).При использовании @ расположение относительно файла FXML.Например, если ваш FXML-файл /fxml/PluginView.fxml, а CSS-файл /styles/style.css, у вас будет:

<?import javafx.scene.control.Label?>
<fx:root  xmlns:fx="http://javafx.com/fxml/1"
          type="javafx.scene.layout.GridPane"
          alignment="center" hgap="10" vgap="10" stylesheets="@../styles/style.css">
    <Label>
        Hello world
    </Label>
</fx:root>

Это вызовет getStylesheets().add(...) с чем-то вроде:

jar:file:///path/to/plugin/file.jar!/styles/style.css

Который может быть расположен независимо от используемого ClassLoader.


Другая вероятная проблема в вашем файле style.css.Вы используете .root {}, но класс стилей root автоматически добавляется только к корням Scene.Что вы, вероятно, хотите сделать, это установить свой собственный класс стилей и использовать , который в файле CSS.


Кроме того, вы пишете свой собственный плагин-discovery-and-loadкод.Не говорю, что ты не можешь продолжать делать то, что ты делаешь, но я просто хочу сообщить, что тебе не нужно изобретать велосипед.У Java есть java.util.ServiceLoader именно для такого рода вещей.

...