Swing2JavaFX - Migrationsstrategien

Transkript

1 Swing2JavaFX - Migrationsstrategien In der Zeit vor JavaFX waren Java-Entwickler für die Implementierung einer Oberfläche für Desktopanwendungen auf die Frameworks AWT, Swing und SWT angewiesen. Aufbauend auf dem älteren AWT wurde 1998 Swing eingeführt, welches aktuell noch in vielen Softwareprojekten Verwendung findet. Trotz anfänglicher Performance-Schwierigkeiten wurde Swing, dank seiner modularen Struktur, Plattformunabhängigkeit, zu Beginn noch stetigen Verbesserungen und Weiterentwicklungen, ein Erfolg. Doch in Zeiten von Android, ios und Windows 8 sehen Swing-Anwendungen zum einen nicht mehr zeitgemäß aus und werden zum anderen auch nicht mehr aktiv von Oracle unterstützt. Die Neuerungen für Swing in Java 7 hielten sich in Grenzen (Nimbus Look & Feel, JLayer-Komponente) und für Java 8 sind ebenfalls keine großen Weiterentwicklungen in Aussicht. Auch die Implementierung von (aufwendigen) Effekten und Animationen, die für andere Oberflächen-Frameworks Standard sind (Schatten, Smooth Scrolling, Reflektionen u.v.m.), können sich mit Swing sehr aufwendig gestalten oder nicht umgesetzt werden. Trotzdem sind Swing-Oberflächen noch in vielen älteren Projekten im Einsatz und haben sich in der Praxis bewährt. Ziel dieser Untersuchung ist die Analyse und Gegenüberstellung der unterschiedlichen Migrationsstrategien, um vorhandene Swing-Applikationen mit JavaFX-Komponenten auszustatten oder vollständig zu ersetzen. 1. Migrationsstrategien Für die Migration einer Swing-Anwendung nach JavaFX existieren grundlegend vier verschiedene Strategien. Strategie Neuentwicklung Divide & Conquer JavaFX ohne FXML JavaFX mit FXML JFXPanel (JavaFX in Swing) SwingNode (Swing in JavaFX) Abbildung 1: Mögliche Migrationsstrategien 1

2 Eine erste Unterscheidung erfolgt in einer vollständigen Migration der Oberfläche oder ein in einer schrittweisen Umstellung, hier Divide & Conquer genannt. Beide Varianten haben dabei ihre Vor- und Nachteile. Neuentwicklung Entwicklung einer klaren Architektur mit und nach JavaFX Divide & Conquer Vorteile Allzeit lauffähige (Teil-) (JavaFX- Anwendung durch Schrittweise Umstellung Keine Swing-Altlasten Absehbare Zeit und Budget für die Umstellung einzelner Komponenten Benötigte Zeit und Budget bis lauffähige Anwendung Lauffähige JavaFX-Version existiert erst nach der kompletten Migration Nachteile Swing-Altlasten bleiben erhalten Mögliche Architekturanpassung, um die JavaFX-Komponenten einsetzen zu können Tabelle 1: Vor- und Nachteile einer Neuentwicklung und D&C Entscheidet sich das Projektteam für eine Ausrichtung muss noch die genaue Umsetzungsstrategie gewählt werden. 2. Divide & Conquer Als allgemeine Vorbedingung für die Anwendung der Divide & Conquer Strategie gilt eine klare Trennung von Oberfläche/GUI und Logik/Datenmodell. So kann verhindert werden, dass bei der Umstellung auf JavaFX zusätzliche Zeit in die erneute Implementierung der Programmlogik investiert werden muss. Divide & Conquer besitzt selbst nochmals zwei Unterteilungen: JFXPanel SwingNode 2.1. JFXPanel Mit dem JFXPanel wurde in Swing schon relativ früh die Möglichkeit geschaffen JavaFX- Komponenten einzubetten. Das JFXPanel ist dafür Teil der Swing-Hierarchie und direkt unter JComponent angeordnet. Abbildung 2: Vererbungshierarchie des JFXPanel 2

3 Somit kann das JFXPanel in jedem JFrame hinzugefügt und als Teil der Swing-Oberfläche angezeigt werden. Um JavaFX-Elemente zu verwenden, besitzt das JFXPanel folgende Methoden: setscene getscene Mit setscene kann dem JFXPanel eine JavaFX-Komponente hinzugefügt werden. Zu beachten ist, dass der Aufruf auf dem JavaFX-Event-Thread ausgeführt wird, da sonst eine Exception auftritt (Exception in thread "AWT-EventQueue-0" java.lang.illegalstateexception: Not on FX application thread; currentthread = AWT-EventQueue-0). In Listing 1 ist die korrekte Anwendung dargestellt. Listing 1 public class FXSceneForSwing extends JFXPanel { Platform.runLater(new Runnable() public void run() { setscene(new Scene(/* Setzen der Scene */)); ); In Swing besteht die Möglichkeit JavaFX-Komponenten, beispielsweise Tabellen (TableView), darzustellen. Die JavaFX-Tabelle behält dabei alle Eigenschaften, wie das automatische Sortieren von Zeilen oder das Umgruppieren der Spalten, bei. Auch das Look & Feel von JavaFX wird übernommen, so dass eine optische Abgrenzung zu den Swing-Komponenten existiert. 3

4 Abbildung 3: JavaFX-TableView in Swing mit Zeilen- und Spaltensortierung Die Benutzung von JavaFX-Properties und das Propertybinding können nicht ohne zusätzliche Änderungen geschehen. Entweder man verzichtet auf diese hilfreichen Features komplett und vollzieht die Änderungen an der Oberfläche (beispielsweise Listener-Prinzip in Swing) oder erweitert seine Modellklasse. Die Erweiterung des Datenmodells der Tabelle ist in Listing 2 dargestellt. Dafür wurden alle einfachen Strings durch Properties (SimpleStringProperty) mit den entsprechenden getter- Methoden ersetzt. Damit andere Swing-GUI-Komponenten weiterhin einsetzbar bleiben, müssen die bestehenden getter-methoden angepasst und mit einem zusätzlichen get() versehen werden. Dadurch wird der eigentliche Datentyp, hier String, zurückgegeben. Dieses Modell kann auch als Hybridmodell verstanden werden. Listing 2 private SimpleStringProperty libraryname; private SimpleStringProperty libraryversion; private SimpleStringProperty mavenlibraryname; private SimpleStringProperty licensename; private SimpleStringProperty licenseurl; public SimpleStringProperty libraryname () { return this.libraryname; public String getlibraryname() { 4

5 return this.libraryname.get(); Die Kommunikation zwischen Swing und JavaFX-Komponenten ist ebenfalls problemlos möglich. Dazu kann auf der linken Seite (Abbildung 3 und 4) über einen JFileChooser ein Ordner ausgewählt und alle Bilder in einer JList angezeigt werden. Selektiert man ein Bild, erfolgt die Anzeige in der JavaFX-Komponente ImageView. Die Ausgabe des Dateipfad und der Größe geschieht über die Komponente Label. Aktualisierungen der Oberflächen finden über das Observer-Pattern statt, indem ein registrierter Listener im Datenmodell Änderungen zurück an die Oberflächen weiterleitet. Diese Änderungen und das Laden des Bildes müssen in dem JavaFX-Event-Thread ausgeführt werden. Durch Verzicht auf JavaFX-Properties ist keine Anpassung des Datenmodells nötig. Listing 3 /** * Updatemethode des Listeners um die Änderungen aus dem Datenmodell zu bekommen public void updatedetailimagemodel(final DetailImageModel imagemodel) { Platform.runLater(new Runnable() public void run() { //Setzen des Dateipfades pathfield.settext(imagemodel.getpath()); //Setzen der Größe sizefield.settext(imagemodel.getsize()); //Laden des Bildes und Anzeige in der ImageView image.setimage(new Image(new File(imageModel.getPath().toURL().toExternalForm, true)); ); 5

6 Abbildung 4: Anzeige eines Bildes in einer JavaFX-Komponente in Swing Mit dem JFXPanel besitzt der Entwickler die Chance, alle JavaFX-Komponenten ohne Probleme in seiner Swing-Anwendung einzusetzen SwingNode Die SwingNode bietet ab Java 8 die Möglichkeit, Swing-Komponenten in JavaFX zu verwenden. Die SwingNode ist ein Teil der JavaFX-Hierarchie und direkt unter Node angeordnet. Abbildung 5: Vererbungshierarchie der SwingNode Für die Integration von Swing-Komponenten in JavaFX existieren folgende Methoden: setcontent getcontent Durch setcontent kann der SwingNode eine JComponent hinzugefügt werden. Das Setzen der Komponente muss auf dem Swing - EDT (Event-Dispatchter-Thread) erfolgen, da ansonsten standardmäßig der JavaFX Thread verwendet wird, was eine Exception zur Folge haben könnte. 6

7 Listing 4 public class SwingPanelForFX extends SwingNode { SwingUtilities.invokeLater(new Runnable() public void run() { setcontent(/* Setzen des JPanels */); ); Mithilfe der SwingNode ist es möglich einer JavaFX-Anwendung Swing-Komponenten, wie eine JTable, hinzuzufügen. Deutlich erkennbar durch das kantige Standard Look & Feel von Swing in Abbildung 5. Dabei bleiben alle ursprünglichen Eigenschaften der JTable erhalten. Abbildung 5: Swing-JTable ind JavaFX Mit der verwendeten Vorabversion von Java-8 (jdk-8-ea-bin-b103-windows-i586-15_aug_2013.exe) existieren noch einige Probleme in der Darstellung und Benutzung der Swing-Komponenten. So ist es noch nicht möglich, den Scroll-Balken der JTable zu verwenden. Das Scrollen bei langen Tabellen ist weder mit dem Mausrad, noch mit der Tastatur möglich 7

8 (Abbildung 6). Weiterhin besteht die Gefahr, dass die Swing-Komponente bei Größenveränderungen des Containers nicht korrekt gerendert werden. Dieser Fehler tritt allerdings sehr selten auf. Weitere Probleme bei anderen Swing-Komponenten sind in der Vorabversion nicht auszuschließen. 8

9 Abbildung 6: Scroll-Balken der JTable funktioniert nicht Die Kommunikation zwischen JavaFX und Swing-Komponenten funktioniert auch in dieser Richtung problemlos, das heißt Bilder in JavaFX auszuwählen und in einer Swing Komponente anzuzeigen. Die möglichen Bilder werden über einen DirectoryChooser geladen und in einer 9

10 ListView dargestellt. Das Laden und Anzeigen des Bildes in der JLabel-Komponente funktioniert nur solange einwandfrei, wie kein schneller Wechsel zwischen den Bildern in der ListView erfolgt. Dies kann dazu führen, dass das selektierte Bild nicht korrekt gerendert wird. Abbildung 7: Anzeige eines Bildes in einer JLabel-Komponente in JavaFX Besondere Aufmerksamkeit sollte man der Anbindung des Datenmodells widmen. Da die Verwendung von JavaFX-Properties in Swing nicht möglich ist, müssen nachträglich andere Pattern, wie MVC, benutzt werden. Weil dies sonst zu einem erhöhten Implementierungsaufwand im Backend-Bereich führt. Listing 5 /** * Updatemethode des Listeners um die Änderungen aus dem Datenmodell zu bekommen public void updatedetailimagemodel(final DetailImageModel imagemodel) { SwingUtilities.invokeLater(new Runnable() public void run() { //Setzen des Dateipfades pathfield.settext(imagemodel.getpath()); //Setzen der Größe sizefield.settext(imagemodel.getsize()); 10

11 //Laden des Bildes und Anzeige in einem JLabel ImageIcon icon = new ImageIcon(imageModel.getPath()); imagelabel.seticon(icon); ); Durch die Entwicklung der SwingNode schließt Oracle den Kreis für die Migration von Swing nach JavaFX und gibt dem Entwickler alle Werkzeuge an die Hand, um bestehende Swing- Applikationen zu modernisieren Fazit Beide Varianten, Swing in JavaFX und JavaFX in Swing, sind technisch möglich und bieten den Entwicklern die Möglichkeit, bestehende Swing-Anwendungen nach JavaFX zu migrieren. Von der Benutzung von Swing-Komponenten in JavaFX ist aktuell noch abzuraten, bis alle auftretenden Fehler beseitigt wurden. Das voraussichtliche Datum wird wohl der Java-8- Release Termin sein. Besonders geeignet ist diese Form der Migration von Swing nach JavaFX für Anwendungen die in kleinen Abschnitten portiert werden sollen. Daraus ergeben sich folgende Vorteile, wie die schnelle Umsetzung neuer Features, die zeitnahe Erprobung der Komponenten durch Endanwender sowie deren Feedback, welche in die weitere Entwicklung einfließen können. Jede Komponente kann dabei Schritt für Schritt ausgetauscht und das JavaFX-Wissen dadurch erweitert werden. Die Weiterverwendung bestehender, komplexer Swing-Komponenten und der dadurch vermiedene Nachbau in JavaFX können den Entwicklungsaufwand senken. Nachteil dieser Strategie sind die Swing-Altlasten, welche während der Migration in der Anwendung verbleiben, wie zum Beispiel Listener im Datenmodell. Falls die Verwendung von JavaFX-Properties gefordert ist, ist eine aufwendige Erweiterung des Datenmodells unumgänglich. 3. Neuentwicklung Wie bei der Migration kann man die Neuentwicklung in zwei Teilbereiche unterscheiden: JavaFX ohne FXML JavaFX mit FXML Da eine Neuentwicklung in JavaFX ohne FXML dem üblichen Vorgehen entspricht, wird in diesem Abschnitt FXML vorgestellt FXML Mit JavaFX 2.0 wurde erstmalig die Möglichkeit geschaffen, die grafische Oberfläche über eine XML-Beschreibungssprache (FXM) zu entwerfen. Dabei können nicht nur die grafischen 11

12 Komponenten definiert, sondern auch das dazugehörige Layout und die Java-Controllerklasse, die unter anderem Button-Events entgegennimmt, angegeben werden. Listing 6 <GridPane fx:controller="de.saxsys.swing2javafx.javafx.fxml.testfxmlcontroller" xmlns:fx=" alignment="center" hgap="10" vgap="10"> <padding> <Insets top="25" right="25" bottom="10" left="25"/> </padding> <Text text="willkommen bei FXML" GridPane.columnIndex="0" GridPane.rowIndex="0"/> <TextField fx:id="pathfield" GridPane.columnIndex="0" GridPane.rowIndex="1"/> <TextField fx:id="sizefield" GridPane.columnIndex="0" GridPane.rowIndex="2"/> <ImageView fx:id="imageview" GridPane.columnIndex="0" GridPane.rowIndex="3"/> </GridPane> Listing 6 zeigt die Definition einer Oberfläche unter Verwendung einer selbst implementierten Controller-Klasse (TestFXMLController). Die JavaFX-Komponenten beinhalten zusätzlich das Attribut, fx:id, über das der Controller Änderungen des Datenmodells direkt an die referenzierten Komponenten weiterleiten kann. Voraussetzung bei privaten Objekten in der Controller-Klasse ist die (Listing 7). Listing 7 public class TestFXMLController private ImageView private TextField private TextField sizefield; Das Laden der FXML-Datei geschieht über den in Java enthaltenen FXMLLoader. Auch der in der FXML definierte Controller kann über diese Klasse geladen und als Java-Objekt bereitgestellt werden (Listing 8). Listing 8 URL location = getclass().getresource("/de/saxsys/swing2javafx/javafx/fxml/test.fxml"); FXMLLoader fxmlloader = new FXMLLoader(location); 12

13 Parent root = (Parent) fxmlloader.load(); Tab fxmltab = new Tab("FX-FXML"); fxmltab.setcontent(root); TestFXMLController fxmlcontroller = (TestFXMLController) fxmlloader.getcontroller(); Abbildung 8: FXML in JavaFX FXML wurde entwickelt, um JavaFX-Oberflächen deklarativ zu beschreiben. Durch den Verbund mit dem JFXPanel ist es möglich FXML auch in Swing-Applikationen zu verwenden (Abbildung 9). FXML FXMLLoader JavaFX JFXPanel Swing Abbildung 9: Einbettung von FXML in Swing In Listing 9 kann der Verbund FXML in Swing nachvollzogen werden. Listing 9 public class FXFXMLPaneForSwing extends JFXPanel { public FXFXMLPaneForSwing(final Controller controller) { 13

14 try { URL location = getclass().getresource("/de/saxsys/swing2javafx/javafx/fxml/test. fxml"); FXMLLoader fxmlloader = new FXMLLoader(location); final Parent root = (Parent) fxmlloader.load(); TestFXMLController fxmlcontroller = (TestFXMLController) fxmlloader.getcontroller(); controller.adddetaillistener(fxmlcontroller); // wichtig, immer auf den richtigen Gui-Thread arbeiten, sonst Exception Platform.runLater(new Runnable() public void run() { FXFXMLPaneForSwing.this.setScene(new Scene(root)); ); catch (IOException e) { e.printstacktrace(); 14

15 Abbildung 10: FXML in Swing 3.2. Fazit Eine vollständige Migration einer Swing-Applikation nach JavaFX besitzt gegenüber einer Schritt für Schritt Anpassung den klaren Vorteil, dass die Architektur auf JavaFX ausgerichtet wird und die Übernahme von Swing-Altlasten vermieden werden kann. Ob FXML im Projekt Verwendung findet, entscheidet jedes Entwicklerteam eigenständig. Oracle bietet damit die Möglichkeit, Oberflächen deklarativ zu beschreiben und auszutauschen, indem eine andere FXML geladen wird. 4. Technischer Hintergrund In der folgenden Tabelle sind die wichtigsten Swing-Komponenten und deren entsprechendes Äquivalent in JavaFX aufgelistet Übersicht Swing-JavaFX-Komponenten (nicht vollständig) Swing-Klasse Allgemeine Komponente JavaFX-Klasse JFrame Fenster Stage GridBagLayout, GridLayout, Layoutmanager GridPane, StackPane, 15

16 BorderLayout, FlowLayout, JMenuBar Menuleiste MenuBar JMenu Menu Menu JMenuItem Menueintrag MenuItem JLabel Label Label JTextField Textfeld TextField JTextArea Textbereich TextArea BorderPane, HBox, VBox, JPasswordField Passwortfeld PasswortField JButton Button Button JRadioButton RadioButton RadioButton JCheckBox CheckBox CheckBox JComboBox ComboxBox ComboBox, ChoiceBox JFileChooser Dateibrowser FileChooser, DirectoryChooser JColorChooser Farbenbrowser ColorPicker JProgressBar Fortschrittsanzeige ProgressBar, ProgressIndicator JTabbedPane Fenster mit mehreren Tabs TabPane und TabItem JList Liste ListView JTable Tabelle TableView TableModel Datenmodell der Tabelle ObservableList JTree Baum TreeView JOptionPane Tabelle 2: Swing-JavaFX-Komponenten Webbrowser Dialogfenster WebView 16

17 4.2. Zum Autor: Daniel Winter studierte Informatik an der FH Zittau/Görlitz und arbeitet seit 2011 als Consultant für Softwareentwicklung bei der Saxonia Systems AG Sein aktueller Fokus liegt in den Möglichkeiten der Code-Qualitätsverbesserung bei Projekten jedweder Art, sowie JavaFX und Swing. 17