WebApps – Migration von JSF 2.2 MyFaces, RichFaces zu Primefaces, REST, JPA 2, JEE7 auf JBoss WildFly 10

Sonntag, 27. März 2016 von  
unter Fachartikel Architektur

Die Motivation

Im vorigen Blog-Eintrag hier wurde die Migration der Beispiel-Applikation employeetimetracker der JSF 2.2 Implementierung Apache MyFaces auf Primefaces besprochen. Wie angekündigt, werden in diesem Blog-Eintrag hier die Migrationen der MyFaces JSF 2.2 Beispiel-Applikationen library und bookstore auf die sehr vorteilhafte Primefaces-Technologie beschrieben.

Über die JSF Technologie gibt es bereits einen Blog-Eintrag in diesem Blog hier, worin die Generierung einer JSF 1.2-Applikation auf Basis der JPA-Entities für den JPA-Provider EclipseLink mittels der NetBeans IDE für das Deployment auf dem GlassFish 3 Application Server erklärt wurde. Die in diesen Blog-Einträgen hier und hier mittels JBoss Forge Eclipse PlugIn erstellten Applikationen bookstore und library werden zu den Primefaces-Applikationen bookstore-primefaces und library-primefaces migriert und unterstützen den Einsatz der robusten, aber stets elegant gestylten, etablierten, optimalen Primefaces Frontend-Technologie.

Die Beispiel-Applikationen bookstore-primefaces und library-primefaces werden dann auf dem neusten JBoss WildFly 10 Final deployt. Dabei ist die Verwendung der beiden neuen JBoss WildFly JEE7-Application Server in diesem Blog-Eintrag hier bereits beschrieben worden. Hatten die MyFaces-Beispiel-Applikationen noch extra Suchfelder und Schwächen bei der Sortierung der Ergebnislisten, so bieten nach der Umstellung die Primefaces-Views das Durchsuchen, Sortieren und eine wählbare Pagination der Ergebnisliste bereits als Komfortfunktionen der Standard Primefaces-Funktionalitäten an.

Migration der Beispiel Applikationen auf Primefaces

Wie die Applikationen bookstore, library und bookstore-angularjs, library-angular mittels JBoss Forge erstellt werden, ist bereits in diesen Blog-Einträgen hier und hier beschrieben worden, und wie in der pom.xml des jeweiligen Beispielprojekts nach erfolgtem Download erkennbar ist, werden auch hier in den Applikationen bookstore-primefaces und library-primefaces die folgenden JEE 7 Artefakte für den JBoss WildFly identifiziert, verwendet und importiert:

Maven JEE 7 JBoss-Artefakte und Maven Dependencies

WildFly JBoss Java EE 7 Specification APIs with Tools:
– jboss-javaee-7.0-with-tools
WildFly JBoss Java EE 7 Specification APIs with Resteasy:
– jboss-javaee-7.0-with-resteasy
WildFly JBoss Java EE 7 Specification APIs with Hibernate:
– jboss-javaee-7.0-with-hibernate

Weiterhin werden die folgenden JEE Dependencies (für das Servlet API, Annotationen, JAX-RS Implementierungen, JBoss RESTEasy, Jackson, Hibernate, JPA und EJB) verwendet:

– jboss-annotations-api_1.1_spec
– jboss-jaxrs-api_2.0_spec
– resteasy-jackson2-provider

– hibernate-jpa-2.1-api
– jboss-ejb-api_3.2_spec
– hibernate-jpamodelgen
– jboss-servlet-api_3.1_spec

Und ebenfalls die CDI 1.1 Dependency:

– cdi-api_1.1

Einsatz von CDI

Über CDI und JavaEE gibt es bereits Blog-Einträge in diesem Blog hier und hier. Die Aktivierung von CDI erfolgt, wie beschrieben, mittels beans.xml im WEB-INF Verzeichnis.

Auch über die Architektur und verwendeten Design Patterns der Beispiel-Applikationen gibt es bereits Informationen in einem Blog-Eintrag hier und bereits vorausgegangenen Blog-Einträgen.

Primefaces:

Die Einbindung der erforderlichen Primefaces-UI-Bibliothek primefaces-5.2.jar erfolgt ganz simpel über die entsprechende Maven Primefaces Dependency in der pom.xml. Es ist also im Gegensatz zu diesem Blog-Eintrag hier kein extra /lib-Verzeichnis und keine build.xml für einen Ant Build-Prozess mehr erforderlich, denn es wird einfach der folgende Eintrag zur pom.xml für den Maven Build hinzugefügt:

    <dependency>
      <groupId>org.primefaces</groupId>
      <artifactId>primefaces</artifactId>
      <version>5.2</version>
    </dependency>

Allein durch Änderung dieses Eintrags in der pom.xml kann jederzeit auch auf die gewünschte Primefaces-Version umgestellt werden. Bei der Umstellung der ca. 80 XHTML-Views von MyFaces auf Primefaces sind der Primefaces Showcase und der Primefaces Users Guide (PDF) sehr hilfreich. Ebenfalls wurde das sehr gute bei DZone erhältliche PDF zur JSTL (Java Server Pages Standard Tag Library) verwendet und zwei weitere Dokumente über genauere Details zum JSF 2-Lifecycle, die sich hier und hier zum Download finden.

Aktiviert werden die Primefaces-Tags in der gewünschten XHTML-Seite mittels folgendem Eintrag im Dokumenten-Kopf der XHTML-View xmlns:p=“http://primefaces.org/ui und die zusätzliche Funktionalität der JSTL-Tags wird entsprechend, wie in den MyFaces-Views auch, per xmlns:c=“http://java.sun.com/jsp/jstl/core verfügbar gemacht. Der größte Aufwand der Migration besteht dann im Austausch der Standard MyFaces-Tags (h: Präfix) durch die Primefaces-Tags (p: Präfix) ist also für die simplen Beispiel-Applikationen leicht umsetzbar. Dabei zu beachten ist noch, dass zum Durchsuchen, Sortieren der Ergebnislisten per <p:dataTable>-Tag dieses zur korrekten Funktion besser in eine <h:form> eingebettet wird.

Durch die Verwendung von CDI 1.1 haben die JSF ManagedBeans stattdessen die Annotation @Named und bleiben, bis auf ein paar Helper-Methoden zur Ausgabeformatierung, nahezu identisch zu den ManagedBeans der MyFaces-Applikationen bookstore und library. Auch gibt es noch ein paar zusätzliche toString()-Methoden auf einigen JPA-Entities, die eine geänderte String-Repräsentation der Entity-Attribute liefern. Weitere Informationen zu JSF 2.2, CDI und dem @ViewScope gibt es auch in diesem sehr interessanten Blog von Arne Limburg hier. Die dort beschriebenen Themen finden sich auch in den ManagedBeans der JSF 2.2 Beispiel-Applikation wieder.

Für die Migration von RichFaces 4 Applikationen auf Primefaces gibt es in diesem Blog hier ebenfalls eine sehr nützliche Anleitung.

forge.taglib.xml:

Die in den Beispiel-Applikationen verwendete, moderne Forge TagLib kann sehr einfach erweitert werden, indem eine zusätzlich benötigte Methode in der ViewUtils-Klasse ergänzt wird und deren Signatur in der forge.taglib.xml im Verzeichnis src/main/webapp/WEB-INF/classes/META-INF/ bekanntgemacht wird. Die TagLib wird in der entsprechenden .xhtml-View über den Eintrag xmlns:forgeview=“http://jboss.org/forge/view“ mit dem Prefix forgeview unter der DOCTYPE-Definition im ui:composition eingebunden und mittels forgeview-Prefix per Expression Language (EL) an der gewünschten Stelle mit den richtigen Input-Parametern aufgerufen. Hier die forge.taglib.xml für library-primefaces:

<?xml version=„1.0“ encoding=„UTF-8“?>
<!DOCTYPE facelet-taglib PUBLIC „-//Sun Microsystems, Inc.//DTD Facelet Taglib 1.0//EN“ „http://java.sun.com/dtd/facelet-taglib_1_0.dtd“>
<facelet-taglib xmlns=„http://java.sun.com/JSF/Facelet“>
   <namespace>http://jboss.org/forge/view</namespace>
   <function>
               <function-name>asList</function-name>
               <function-class>de.binaris. library.view.ViewUtils</function-class>
               <function-signature>
                              java.util.List asList(java.util.Collection)
               </function-signature>
   </function>
  
   <function>
       <function-name>display</function-name>
       <function-class>de.binaris. library.view.ViewUtils</function-class>
       <function-signature>
           java.lang.String display(java.lang.Object)
       </function-signature>
   </function>
               
   <function>
               <function-name>count</function-name>
               <function-class>de.binaris. library.view.ViewUtils</function-class>
               <function-signature>
                              int count(java.util.Collection)
               </function-signature>
   </function>
               
   <function>
               <function-name>listExcludingSelectedOne</function-name>
               <function-class>de.binaris. library.view.ViewUtils</function-class>
               <function-signature>
                              java.util.List listExcludingSelectedOne(java.util.Collection,java.lang.Object)
               </function-signature>
   </function>  
</facelet-taglib>

Hier auch die ViewUtils-Klasse unter Verwendung generischer Typen T und Collections List<T>:

ViewUtils:

package de.binaris.library.view;
 
import java.beans.PropertyDescriptor;
import java.lang.reflect.Field;
import java.lang.reflect.Method;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
 
import javax.persistence.Id;
 
/**
* Utilities for working with Java Server Faces views.
*/
public final class ViewUtils {
 
   public static <T> List<T> asList(Collection<T> collection) {
 
     if (collection == null) {
         return null;
     }
     return new ArrayList<T>(collection);
   }
 
   public static String display(Object object) {
     if (object == null) {
         return null;
     }
     try {
         // Invoke toString if declared in the class. If not found,
         // the NoSuchMethodException is caught and handled
         object.getClass().getDeclaredMethod("toString");
         return object.toString();
     }
     catch (NoSuchMethodException noMethodEx) {
         try {
           for (Field field : object.getClass().getDeclaredFields()) {
               // Find the primary key field and display it
               if (field.getAnnotation(Id.class) != null) {
                 // Find a matching getter and invoke it to display the key
                 for (Method method : object.getClass().getDeclaredMethods()) {
                     if (method.equals(new PropertyDescriptor(field.getName(),                    
                                         object.getClass()).getReadMethod()))
                     {
                       return method.invoke(object).toString();
                     }
                 }
               }
           }
           for (Method method : object.getClass().getDeclaredMethods()) {
               // Find the primary key as a property instead of a field, and display it
               if (method.getAnnotation(Id.class) != null) {
                 return method.invoke(object).toString();
               }
           }
         } catch (Exception ex) {
           // Unlikely, but abort and stop view generation if any exception is thrown
           throw new RuntimeException(ex);
         }
     }
     return null;
   }
 
   public static <T> int count(Collection<T> collection) {
     if (collection == null) {
               return 0;
     }
     return collection.size();
   }
 
   public static <T> List<T> listExcludingSelectedOne(Collection<T> collection, T selected) {
     if (collection == null) {
         return null;
     }
     if (selected == null) {
       return new ArrayList<T>(collection);
     }
     List<T> list = new ArrayList<T>(collection);
     list.remove(selected);
     return list;
   }
 
   private ViewUtils() {
     // Can never be called, only by getInstance – Singleton pattern
   }
}

Über Tags, TagLibs und die Erweiterung bestehender und die Definition eigener Tags gibt es bereits einen Blog-Eintrag in diesem Blog hier und durch die soeben gezeigten Beispiele ist erkennbar, wie simpel es ist, eigene Tags für die .xhtml-Views heutiger JSF-Applikationen zu definieren.

Alle XML und XHTML-Dateien der Primefaces-Beispielapplikation finden sich in den Deployment-Archiven bookstore.war und library.war in den /target-Unterverzeichnissen der Projekte bookstore-primefaces und library-primfaces.

Die Konfiguration des JBoss WildFly Application Servers 10 Final erfolgt analog der Konfigurationen der JBoss Application Server WildFly 8.1, 8.2 und 9 Final und betrifft die Datasource, die MySQL-Datenbank Inno DB 5.x, Hibernate 5, das Logging und den Connection Pool und ist, genau wie die Test-Frameworks und die Aktivierung der RESTful WebService-Schnittstelle in diesem Blog-Eintrag hier und vorigen Blog-Einträgen bereits beschrieben.

Bei dieser Gelegenheit darf auch das sehr effektive, interessante und erfolgreiche Seminar

“TDD mit Java”

hier und hier von Binaris Informatik ebenfalls erwähnt werden.

Die Primefaces Beispiel-Applikationen arbeiten über die RESTful WebService-Schnittstelle auf denselben Datenbanken, wie die MyFaces-Applikationen bookstore, library und die AngularJS Beispiel-Applikation bookstore-angularjs, library-angularjs über ihre RESTful WebServices, weshalb für die Primefaces Beispiel-Applikationen dieselben mit HeidiSQL erstellten Datenbank-Skripte hier und hier verwendet werden können, wie für die Beispiel-Applikationen der vorigen Blog-Einträge hier und hier.

Die fertig migrierten Versionen der Beispiel-Applikation bookstore-primefaces können hier (WildFly9) und hier (WildFly10), sowie der Beispiel-Applikation library-primefaces hier (WildFly9) und hier (WildFly10) betrachtet werden.

Hier die migrierten Beispiel-Projekte für die Entwicklungsumgebungen JBoss Developer Studio, intelliJ 15:

JBoss Developer Studio Projekt: bookstore-primefaces
intelliJ Projekt: bookstore-primefaces

JBoss Developer Studio Projekt: library-primefaces
intelliJ Projekt: library-primefaces

Hier der WildFly 10 Final als Zip-Archiv zum Download und Entpacken: Für Linux hier und für Windows hier. Voraussetzung ist jeweils Java 8.

Die fertig konfigurierte Version des WildFly 10.Final mit vielen Beispiel-Applikationen der vorigen Blog-Einträge hier zum Download bereit kann runtergeladen, entpackt und gestartet werden. Dabei ist nur der Pfad für JAVA_HOME in der standalone.xml anzupassen, damit dieser auf das tatsächliche JDK 8-Verzeichnis des Server-Systems zeigt.

Die Primefaces Beispiel-Applikationen dieses Blog-Eintrags können danach selbst erneut deployt werden, ohne den bereits gestarteten WildFly 10 Application Server überhaupt stoppen oder erneut starten zu müssen. Bei laufendem Server einfach ins Server-Unterverzeichnis /standalone/deployments

– eine leere Textdatei namens bookstore-primefaces.war.dodeploy speichen und
– das Archiv bookstore-primefaces.war aus dem bookstore/target-Verzeichnis speichern

– eine leere Textdatei namens library-primefaces.war.dodeploy speichen und
– das Archiv library-primefaces.war aus dem library/target-Verzeichnis speichern

Sofort werden die Beispiel-Applikationen deployt und in wenigen Sekunden gestartet und können entweder hier und hier oder unter den folgenden Urls aufgerufen werden:

http://localhost:8080/bookstore-primefaces
http://localhost:8080/library-primefaces

Wie man sieht, macht es viel Freude, die XHTML-Views der beschriebenen Beispiel-Applikationen von MyFaces oder RichFaces auf die vorteilhafte Primefaces-Technologie umzustellen. Es besteht also durchaus die Möglichkeit, dass noch weitere Blog-Einträge zu Primefaces und den die JEE7-Spezifikation implementierenden Technologien folgen.

Allen interessierten Leserinnen und Lesern weiterhin viel Freude bei der agilen Softwareentwicklung mittels Scrum und dem Test Driven Development mit Java, sowie eine schöne Sommerzeit.

Kommentare

Ein Kommentar zu “WebApps – Migration von JSF 2.2 MyFaces, RichFaces zu Primefaces, REST, JPA 2, JEE7 auf JBoss WildFly 10”

  1. Von WebApps – Migration mit JSF 2.2 Primefaces, REST, JPA 2, JEE7 auf JBoss WildFly 10 : Softwareentwicklung, Projektmanagement & Schulung | binaris informatik GmbH am Samstag, 30. April 2016 23:32

    […] vorigen Blog-Eintrag hier wurde die Migration der Beispiel-Applikationen library und bookstore mit der JSF […]