Kuchen-Zutat-Beispiel mit Java Server Faces


Inhalt:

Überblick
Use Cases
faces-config.xml
EJB-Injection
Parameterübergabe
ViewState/LifeCycle
Phase Event
Zugriff auf Request aus ManagedBean-Action-Methode
Validierung
Weitere Design-Tips

Dieses Beispiel stellt das KuchenZutat-Beispiel komplett auf JSF um und kämpft dabei mit einer Reihe von Problemen.

Hier gibt es das Projekt als EAR-Export-Datei: KuchenZutatJSF.ear.


Überblick

Die Anwendung enthält vier Seiten:

Es gibt drei Managed Beans:
Die Navigation sieht so aus (alles über parameterlose Action-Methoden abgebildet):


Use Cases

Da die Umsetzung der Anwendungslogik sehr komplex ist, versuche ich hier, die Abläufe der wichtigsten Use Cases zu zitieren. Leider habe ich kein brauchbares freies Sequenz-Diagramm-Tool gefunden, deshalb muss ich hier bei der textuellen Beschreibung bleiben.

Use Case "Kuchen anlegen"


Use Case "Kuchen bearbeiten"
Dieser Use-Case ist dem letzten sehr ähnlich, nur der Start der Aktion sowie das Initialisieren der kuchenAktuell-Membervariablen ist unterschiedlich.
Use Case "Zutat bearbeiten"
Ausgehend von der Kuchenliste wird zuerst die Kuchen-Bearbeiten-Seite aufgerufen (man könnte diesen Use-Case also als "extends" von "Kuchen bearbeiten" modellieren). Deshalb ist der gesamte Schritt 1 und Unterschritte identisch mit "Kuchen bearbeiten". Allerdings folgen hier die Schritte für das Aufbauen der Zutatenliste.
 Der Rest des Use Cases entspricht wieder den Schritten 1.3.1 bis 1.3.3.2 dieses Use Cases.


Die anderen drei Use Cases "Kuchen löschen", "Zutat anlegen" und "Zutat löschen" haben keine schlimmen Besonderheiten und werden deshalb nicht im Detail erklärt.

faces-config.xml

"faces-config.xml" sieht so aus nachdem wir damit fertig sind (drei Managed Beans und drei Navigation-Rules sind eingetragen): 
<?xml version="1.0" encoding="UTF-8"?>
<faces-config xmlns="http://java.sun.com/xml/ns/javaee"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-facesconfig_1_2.xsd"
	version="1.2">
	<managed-bean>
		<managed-bean-name>
		kuchenListeHandler</managed-bean-name>
		<managed-bean-class>
		de.fhw.komponentenarchitekturen.knauf.kuchenzutatjsf.KuchenListeHandler</managed-bean-class>
		<managed-bean-scope>
		request</managed-bean-scope>
	</managed-bean>
	<managed-bean>
		<managed-bean-name>
		kuchenDetailHandler</managed-bean-name>
		<managed-bean-class>
		de.fhw.komponentenarchitekturen.knauf.kuchenzutatjsf.KuchenDetailHandler</managed-bean-class>
		<managed-bean-scope>
		request</managed-bean-scope>
	</managed-bean>
	<managed-bean>
		<managed-bean-name>
		zutatDetailHandler</managed-bean-name>
		<managed-bean-class>
		de.fhw.komponentenarchitekturen.knauf.kuchenzutatjsf.ZutatDetailHandler</managed-bean-class>
		<managed-bean-scope>
		request</managed-bean-scope>
	</managed-bean>

	<navigation-rule>
		<description>"kuchenDetail" führt immer zur Detail-Seite!</description>
		<display-name>KuchenDetail-Seite</display-name>
		<navigation-case>
			<from-outcome>kuchendetail</from-outcome>
			<to-view-id>/kuchendetail.jsp</to-view-id>
		</navigation-case>
	</navigation-rule>
	
	<navigation-rule>
		<description>"kuchenliste" führt immer zur Liste-Seite!</description>
		<display-name>KuchenListe-Seite</display-name>
		<navigation-case>
			<from-outcome>kuchenliste</from-outcome>
			<to-view-id>/kuchenliste.jsp</to-view-id>
		</navigation-case>
	</navigation-rule>
	
	<navigation-rule>
		<description>"zutatDetail" führt immer zur Detail-Seite!</description>
		<display-name>ZutatDetail-Seite</display-name>
		<navigation-case>
			<from-outcome>zutatdetail</from-outcome>
			<to-view-id>/zutatdetail.jsp</to-view-id>
		</navigation-case>
	</navigation-rule>
</faces-config>
Zu beachten ist dass alle Beans im Request-Scope stecken. Das hat den Nachteil dass bei jedem Request die benötigten Daten neu geladen werden. Der Vorteil ist dass nach einem Speichern eines Kuchens und anschließendem Zurückspringen zur Kuchenliste ein neuer Request erfolgt und dadurch die Kuchenliste mitsamt der Änderung neu eingeladen wird. Wäre die Kuchenliste (KuchenListeHandler) in der Session, dann müsste der geänderte Kuchen mühsam in der Liste aktualisiert werden (was von der Managed Bean aus nicht direkt möglich ist).

Die Navigation Rules sind eher simpel gehalten: jede Action-Methode die als Rückgabe "kuchendetail" hat wird automatisch zur View "kuchendetail.jsp" weitergeleitet, und analog für die Rückgaben "zutatdetail" und "kuchenliste".

WTP bietet uns ein grafisches Tool für das Bearbeiten der Links:
Navigation Rules
Über die Palette rechts können wir z.B. neue Links hinzufügen.
Jede "Page" ist mit einer echten JSP-Seite verbunden. Diese wird in der Property "Page Path" angegeben.
Für einen Link können wir in der Property "From Outcome" angeben, für welchen Rückgabewert einer Action-Methode diese Regel gelten soll.

Info: im obigen Beispiel gelten die Navigation Rules für die Rückgabe aller Actions. Wenn man eine Regel nur für eine einzelne Methode angeben will, könnte das so aussehen:
	<navigation-rule>
		<description>"kuchenliste" führt diesmal nur als Rückgabe der Action "kuchenDetailHandler.kuchenSave" zur Liste!</description>
		<display-name>KuchenListe-Seite</display-name>
		<navigation-case>
			<from-action>#{kuchenDetailHandler.kuchenSave}</from-action>
			<from-outcome>kuchenliste</from-outcome>
			<to-view-id>/kuchenliste.jsp</to-view-id>
		</navigation-case>
	</navigation-rule>
Hier greift die Regel nur für die Rückgabe "kuchenliste" der Methode de.fhw.komponentenarchitekturen.knauf.kuchenzutatjsf.KuchenDetailHandler.kuchenSave. Man beachte den EL-Ausdruck zur Referenzierung der Methode (leider ohne WTP-Unterstützung für die Codeergänzung).

Analog sieht es aus, wenn man auf einer JSP-Seite direkt einen Link zu einer anderen View baut. 
	<navigation-rule>
		<description>Der Link "navigationkuchenliste" führt zur Übersichtsseite!</description>
		<display-name>Link "Zur Kuchenliste" auf kuchendetail.jsp</display-name>
		<from-view-id>/kuchendetail.jsp</from-view-id>
		<navigation-case>
			<from-outcome>kuchenliste</from-outcome>
			<to-view-id>/kuchenliste.jsp</to-view-id>
		</navigation-case>
	</navigation-rule>
Dies greift für den CommandLink "Zur Kuchenliste" auf "kuchendetail.jsp" (eigentlich gilt die Regel für alle Links, deren Property "action" auf "kuchenliste" steht). Die Quell-View wird im Element from-view-id angegeben, hier also "/kuchendetail.jsp".

EJB-Injection

Alle drei Managed Beans benötigen die Stateless Session Bean de.fhw.komponentenarchitekturen.knauf.kuchenzutatjsf.KuchenZutatWorkerBean. Diese können wir mittels EJB-Injection einlesen.
Das sieht so aus: 
  @EJB()
  private KuchenZutatWorkerLocal kuchenZutatWorkerBean;
Da ein Zugriff über den Environment Naming Context nicht nötig ist, müssen weder in web.xml noch in jboss-web.xml EJB-Referenzen eingetragen sein
"jboss-web.xml" ist eigentlich nicht nötig, ich habe sie nur der Vollständigkeit halber angelegt. Sie sieht so aus: 
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE jboss-web PUBLIC
    "-//JBoss//DTD Web Application 5.0//EN"
    "http://www.jboss.org/j2ee/dtd/jboss-web_5_0.dtd">
<jboss-web>
	<context-root>KuchenZutatJSFWeb</context-root>
</jboss-web>


Um die EJBs nur an einer Stelle zu deklarieren, habe ich mir eine Basisklasse für alle meine Managed Beans deklariert, die die KuchenZutatWorkerBean per Injection holt und sie in einer privaten Variable speichert. Der Zugriff erfolgt nur durch eine get-Methode. Es wäre durch diese Codestruktur möglich, nach Umstellung nur einer einzigen Klasse und Änderung zweier Deployment Deskriptoren auf händischen JNDI-Lookup zu wechseln (ein Beispiel hierfür findet sich im Vorjahres-Beispiel, in dem die JSF-Library ausgetauscht werden musste und deshalb JBoss Injection nicht unterstützte).
public class BaseHandler
{
  @EJB()
  private KuchenZutatWorkerLocal kuchenZutatWorkerBean;
  
  protected KuchenZutatWorkerLocal getKuchenZutatWorker()
  {
    return this.kuchenZutatWorkerBean;
  }
}


Parameterübergabe

An einigen Stellen muss beim Sprung von einer View zur anderen ein Parameter übergeben werden. Dies kann auf zwei Wegen geschehen (jeweils mit Vor- und Nachteilen).

Weg 1: Hidden Field:
Aus "kuchendetail.jsp" im Formular für das Bearbeiten des aktuellen Kuchens: 
<h:inputHidden id="kuchenid" value="#{kuchenDetailHandler.kuchenId}"></h:inputHidden>

Vorteil: der Wert wird beim Generieren der JSP aus der aktuellen Instanz des KuchenDetail-Handlers gelesen und beim Absenden des Requests dort auch wieder hineingeschrieben.

Nachteil: Falls die Zielseite eine andere Seite ist, dann wird der Wert aus dem Parameter trotzdem in den KuchenDetail-Handler geschrieben. Deshalb nicht allzu geeignet für z.B. die Übergabe einer Kuchen-ID in der Zutatenliste eines Kuchens, wenn das Ziel die Zutatenseite ist.

Fazit: einfaches, aber unflexibles Verfahren, dass nur innerhalb einer Managed Bean funktioniert (zum Beispiel in "kuchendetail.jsp" beim Klick auf "OK").

Weg 2: <f:param>-Tag:
Innerhalb eines <h:commandButton> oder <h:commandLink> können Werte an das Ziel übergeben werden. Dies kann so aussehen (Link zum Bearbeiten einer Zutat auf "kuchendetail.jsp"): 
	<h:commandLink id="kuchenedit" action="#{zutatDetailHandler.editZutat}"
			actionListener="#{zutatDetailHandler.selectKuchenZutat}" value="Bearbeiten">
		<f:param id="kuchenId" value="#{kuchenDetailHandler.kuchenId}"></f:param>
		<f:param id="zutatId" value="#{zutatAktuell.id}"></f:param>
	</h:commandLink>
"zutatAktuell" ist hier eine Variable im PageContext, die beim Befüllen des dataTable aus der Zutatenliste gesetzt wurde.

Vorteil: wird an die Zielseite geschickt.

Nachteil: Keinerlei Automatismus. Die Action-Methode editZutat hat keine Chance auf die Werte zuzugreifen. Deshalb muss der Parameter manuell ausgewertet werden. Dazu wurde das "actionListener"-Attribut gesetzt. Hier wird eine void-Methode angegeben die einen Parameter vom Typ "javax.faces.event.ActionEvent" erwartet.
Diese Methode könnte so aussehen: 
	public void selectKuchenZutat(ActionEvent event)
	{
		UIParameter component = (UIParameter) event.getComponent().findComponent("kuchenId");
		this.intKuchenId = Integer.parseInt(component.getValue().toString());

		UIParameter component = (UIParameter) event.getComponent().findComponent("zutatId");
		this.intZutatId = Integer.parseInt(component.getValue().toString());
	}
Es werden zwei Komponenten mit den Namen "kuchenId" und "zutatId" gesucht, die vom Typ javax.faces.component.UIParameter sind. Deren Werte werden ausgewertet und in Membervariablen der Klasse gesetzt. Diese sind zum Zeitpunkt des Aufrufs von editZutat vorhanden.

Mehr Infos dazu: http://balusc.blogspot.com/2006/06/communication-in-jsf.html
(gemäß dieser Seite ist es scheinbar doch möglich, in der Action-Methode auf "f:param"-Parameter zuzugreifen, das wird bei Gelegenheit ausprobiert ;-) )


ViewState/LifeCycle

Die in diesem Abschnitt beschriebenen Informationen sind sehr wichtig, um den Ablauf in einer JSF-Anwendung zu verstehen, und um sich scheinbare Ungereimtheiten gerade beim Bean-Scope "Request" (also: Bean bei jedem Request neu erzeugen, keinerlei Zustandsspeichern zwischen Aufrufen) zu erklären!
Es sei auf das Kapitel "2.2 Standard Request Processing Lifecycle Phases" in der JSF-1.2-Spezifikation verwiesen.

Das folgende Bild ist von http://java.sun.com/javaee/5/docs/tutorial/doc/figures/jsfIntro-lifecycle.gif geklaut und bietet einen Überblick über den Lifecyle:
Lifecycle
Siehe auch: http://www.fh-wedel.de/~si/seminare/ws06/Ausarbeitung/10.JavaServerFaces/jsf2.html#jsfl

Erster Seitenaufruf:
Beim ersten Aufruf einer Seite springt das JSF-Framework direkt in die "Render Response"-Phase, hier gibt es keine besonderen Fallstricke.

Postback:
Beim sogenannten "Postback" einer Seite (also beim Abschicken irgendeines Formulars) ist der Ablauf folgender:
Aus diesen Phasen ergeben sich einige große Besonderheiten, die vor allem zuschlagen, wenn man Backing Beans im Request-Scope verwendet!
Es gäbe zwei Lösungen des Dilemmas:

Phase Event

Das Einklinken in die Verarbeitungsphasen von JSF geschieht, indem im <f:view>-Tag das beforePhase-Attribut gesetzt wird: 
<f:view beforePhase="#{kuchenDetailHandler.beforePhase}">

Die Methode KuchenDetailHandler.beforePhase sucht in den Request-Parametern nach allem was mit ":kuchenId" endet (JSF setzt die komplette Komponentenhierarchie in den Namen des Request-Parameters, in der Zutatenliste sieht das so aus: tablezutaten:0:formzutatedit:kuchenId für die Zutat in Zeile 0, tablezutaten:1:formzutatedit:kuchenId für die Zutat in Zeile 1. Deshalb habe ich hier keine Chance auf den exakten Namen der Komponente zu prüfen)
Der Code der Methode sieht so aus: 
  public void beforePhase (javax.faces.event.PhaseEvent e)
  {
    //Nur etwas machen in der Phase "ApplyRequestValues"!
    if (e.getPhaseId().equals( PhaseId.APPLY_REQUEST_VALUES))
    {
      Map<String, String> mapRequest = e.getFacesContext().getExternalContext().getRequestParameterMap();
      
      for (Entry<String, String> entryAktuell : mapRequest.entrySet() )
      {
        String strKey =  entryAktuell.getKey();
        
        if (strKey.endsWith(":kuchenId"))
        {      
          this.intKuchenId = Integer.parseInt(entryAktuell.getValue());
        }
      }
    }
  }
Das bedingt leider eine Änderung an der Parameterversorgung des Zutat-Detail-Links: <f:param>-Tags kann ich nicht als Request-Parameter parsen! Man könnte zwar den gesamten Komponentenbaum der aktuellen View durchlaufen, aber damit wüßte man immer noch nicht, welches Formular gerade abgeschickt wird, und woher deshalb die Kuchen-ID kommt. Deshalb verwende ich ein Hidden Field, und suche seinen Wert aus dem ServletRequest: 
	<h:form id="formzutatedit">
		<h:inputHidden id="kuchenId" value="#{kuchenDetailHandler.kuchenId}"></h:inputHidden>
		<h:commandLink id="kuchenedit" action="#{zutatDetailHandler.editZutat}"
				actionListener="#{zutatDetailHandler.selectKuchenZutat}" value="Bearbeiten">
			<f:param id="zutatId" value="#{zutatAktuell.id}"></f:param>
		</h:commandLink>
	</h:form>
Dieses Hidden Field wird zwar dank Value Binding in den KuchenDetailHandler zurückgeschrieben, das stört uns allerdings nicht weiter. Wichtig ist, dass beim Postback eines jeden Formulars schon vor der Validierungsphase die Kuchen-ID ermittelt werden kann.

Diese schicke Lösung hat einen Nachteil: im ZutatDetailHandler kommt die KuchenId in diesem konkreten Fall nicht mehr als UIParameter an, sondern in einem HTML-Hidden Field. Deshalb muss die Logik in ZutatDetailHandler.selectKuchen (diese Methode wird auch aus selectKuchenZutat heraus aufgerufen) erweitert werden: 
	public void selectKuchen(ActionEvent event)
	{
		String strValue = null;
		if (event.getComponent().findComponent("kuchenId").getClass().equals(UIParameter.class) )
		{
			UIParameter component = (UIParameter) event.getComponent().findComponent("kuchenId");
			strValue = component.getValue().toString();	
		}
		else if (event.getComponent().findComponent("kuchenId").getClass().equals(HtmlInputHidden.class) )
		{
			HtmlInputHidden component = (HtmlInputHidden) event.getComponent().findComponent("kuchenId");
			strValue = component.getValue().toString();
		}
		else
		{
			throw new FacesException ("Keine Komponente kuchenId gefunden!");
		}
		this.intKuchenId = Integer.parseInt(strValue);
	}
Hier wird also die Kuchen-ID in zwei unterschiedlichen Komponenten-Typen gesucht.


Zugriff auf Request aus ManagedBean-Action-Methode

Oben gezeigte Techniken zur Parameterübergabe lassen sich eventuell vereinfachen: es ist in der Managed Bean möglich auf Request-Parameter direkt zuzugreifen. Dadurch hebelt man natürlich die JSF-Technik ziemlich aus ;-).
Ein Beispiel ist die Methode KuchenDetailHandler.deleteKuchen, die von der Kuchenliste aufgerufen wird und einen Kuchen löscht. Da die Managed Bean KuchenlisteHandler im Request steckt und schon beim Klick auf den Löschen-Link initialisiert wurde (Postback der View "kuchenliste"), steckt der gelöschte Kuchen noch in der Kuchenliste und würde deshalb trotz allem angezeigt. Lösung des Problems: auf den KuchenlisteHandler zugreifen, der als Attribut im Request steckt, und dort den Kuchen aus der Liste entfernen: 
    ServletRequest request = (ServletRequest) FacesContext.getCurrentInstance().getExternalContext().getRequest();
    KuchenListeHandler kuchenListeHandler = (KuchenListeHandler) request.getAttribute("kuchenListeHandler");
    kuchenListeHandler.clearKuchenliste();

Mit einer ähnlichen Vorgehensweise kann man auf die Session zugreifen um z.B. Daten darin zu speichern: 
    HttpSession session = (HttpSession) FacesContext.getCurrentInstance().getExternalContext().getSession(false);
    session.setAttribute("MyAttribute", "MyValue");


Validierung

Im Beispiel sind alle Eingabefelder als Pflichtelement deklariert (Attribut "required" setzen). Für den Kuchen ist die minimale Länge auf 5 Zeichen gesetzt: 
	<h:inputText label="Name" id="name" value="#{kuchenDetailHandler.name}" required="true">
		<f:validateLength minimum="5"></f:validateLength>
	</h:inputText>
Entstehen Fehlermeldungen beim Validieren dieser Komponente, können sie an beliebiger Stelle der Seite ausgegeben werden: 
	<h:message for="name"></h:message>
Durch das Attribut for wird der Name der Komponente angegeben deren Validierungsfehler hier ausgegeben werden sollen. Wird ein Attribut label des h:input angegeben, so enthält die Fehlermeldung diesen Namen, ansonsten den internen Namen der Komponente in einer eher häßlichen Darstellung.

ACHTUNG: wenn man auf "kuchendetail.jsp" beim Bearbeiten eines bestehenden Kuchens einen Validierungsfehler hat, dann wird die Kuchen-ID NUR in die Managed Bean gesetzt, wenn man sie in der beforePhase aus dem Hidden Field zieht! Das ist nur durch eine beforePhase zu umgehen, siehe Abschnitt ViewState/LifeCycle.


Weitere Design-Tips

Formulare sollten möglichst klein gehalten werden, z.B. sollte ein Navigationslink nicht im gleichen form stecken wie die eigentlichen Eingabefelder. Grund: bei einem Klick auf den Link wird das gesamte Formular validiert, und deshalb könnte ein nicht ausgefülltes Eingabefeld einen Klick auf den Link verbieten.

IDs: Alle Formular-Elemente sollten mit IDs versehen werden (h:form, h:inputHidden, h:inputText usw.). Dadurch ist das Element in Fehlermeldungen oder beim Auswerten des Requests einfacher zuzuordnen.


Stand 11.05.2009
Historie:
15.12.2008: Erstellt aus Vorjahresbeispiel, Anpassungen an JBoss 5 (Workaround für eigene JSF-Implementierung entfernt, Injection) und Eclipse 3.4, Doctype der JSPs wegen Eclipse-Bug umgestellt.
26.12.2008: Use-Case-Beschreibungen zugefügt, kosmetische Korrekturen im Quellcode.
11.01.2009: Abschnitt über LifeCycle/ViewState zugefügt, Code angepaßt (Initialisieren der Kuchen-/Zutat-Variablen beim Setzen der ID)
20.01.2009: Anpassungen für JSFUnit-Beispiel (DataTable in "kuchenliste.jsp" hat ID)
11.05.2009: Link zu Webseite "JSF-Parameterübergabe"