Am Ende dieses Tutorials ist ein deploytes Java EE 6 Projekt mit JSF 2, CDI, EJB 3.1 und JPA 2 auf dem JBoss 6 vorhanden und aufrufbar. Dabei wird die Eclipse WTP Untestützung funktionieren, der JBoss direkt aus Eclipse heraus gestartet und Maven als Build Tool verwendet werden.

Kleine Anmerkung vorab: Nicht von der Länge des Tutorials abschrecken lassen – es sind eigentlich nur sehr viele Bilder. Kennt man die Technologien und Tools dauert das Erstellen dieses Projekts nur wenige Minuten.

Aufbau des Tutorials:

• Herunterladen der notwendigen Software und Tools
  • Eclipse herunterladen
  • JBoss AS herunterladen
  • Maven herunterladen
• Eclipse konfigurieren
  • JBoss Tools
  • JBoss 6 AS Server Runtime
  • Maven
  • Maven Extras – WTP
• Java EE 6 Projekt erstellen
  • Projekt mit Maven generieren
  • JSF Capabilities hinzufügen
  • CDI Support hinzufügen
  • Projekt auf den JBoss deployen
• Wie geht es weiter?

Herunterladen und Installieren aller benötigten Software und Tools

Eclipse Helios für Java EE Entwicklung herunterladen

Als erstes wird Eclipse in der Java EE Entwickler Version von eclipse.org heruntergeladen.

Das heruntergeladene Archiv am Ort deiner Wahl entpacken – z.B. einfach im Laufwerk C.

JBoss AS 6

In diesem Tutorial wird der JBoss 6 Final als Application Server verwendet denn dieser implementiert die Java EE Web Profile Spezifikation. Der JBoss AS kann unter jboss.org heruntergeladen werden.

Nach dem Herunterladen das Archiv auch wieder am Ort deiner Wahl entpacken – kann z.B. auch wieder das Laufwerk C: sein.

Maven 3

Um den Projektstart zu vereinfachen und alle Abhängigkeiten automatisch zu beziehen wird Maven 3 verwendet. Später wird auch das Grundgerüst unseres ersten Java EE Hello World Projekts mit Maven generiert. Somit muss Maven 3 “installiert” werden. Maven kann von http://maven.apache.org heruntergeladen werden:

Maven muss auch wieder an einem Ort deiner Wahl entpackt und anschließend das maven/bin Verzeichnis im Pfad (Umgebungsvariable PATH) angegeben werden damit der Befehl mvn in der Kommandozeile gefunden wird.

Installationsanleitung für Linux (Ubunutu 11.04) anzeigen.

Eclipse konfigurieren

Zuvor wurde bereits die die aktuelle Eclipse Helios (3.6) Java EE IDE heruntergeladen sowie entpackt und diese sollte spätestens jetzt gestartet werden. Beim ersten Start von Eclipse wir gefragt wo man seinen Workspace hinlegen möchte. Wieder einfach einen Ort deiner Wahl angeben und das Häckchen bei “nicht noch einmal fragen” setzen.

Für das Java EE Projekt mit Maven Unterstützung werden zum einen die JBoss Tools und zum anderen das Maven2Eclipse Plugin benötigt. Dabei spielen die JBoss Tools bei der Entwicklung von Java EE Projekten unter Eclipse generell eine sehr wichtige Rollen denn sie decken die meisten Themen wie z.B. JSF 2.0, CDI oder JPA sehr gut ab.

JBoss Tools Eclipse Plugin

Die aktuelle Version 3.2 der JBoss Tools gibt es dabei noch gar nicht so lange denn sie wurde erst Mitte Februar Final. Die JBoss Tools werden am einfachsten über die offizielle Update Seite installiert: http://download.jboss.org/jbosstools/updates/stable/helios/
Dazu in Eclipse im “Hauptmenü->Help->Install New Software…” klicken. Im aufkommenden Dialog den Button “Add” klicken um die Update Seite hinzuzufügen:

Diesen Dialog mit dem Button “Add” beenden und anschließend wird man erst einmal durch den Schriftzug “Pending…” sehen, dass das Repository geladen wird. Das kann unter Umständen eine ganze Weile dauern:

Sobald das Repository geladen wurde ist eine Liste mit allen möglichen Gruppen zu sehen. Die bisher bekanntesten Tools wie z.B. die JBoss AS Tools, Seam Tools oder Hibernate Tools befinden sich in der Gruppe “Web und Java EE Development”. Man könnte jetzt alles durchgehen und nur die benötigten Tools selektieren aber der Einfachheit halber selektiere ich “All JBoss Tools 3.2.0″:

Anschließend den Button “Next” klicken. Jetzt werden die Abhängigkeiten geprüft und das dauert auch wieder eine kleine Ewigkeit.
Sobald die Prüfung fertig ist sieht man noch einmal die Liste aller Tools die installiert werden sollen. In der Liste taucht sicherlich das ein oder andere Tool auf welches nicht wirklich benötigt wird aber es schadet auch nicht. Den Dialog mit “Next” beenden.
Auf dem letzten Dialog die Lizensvereinbarungen akzeptieren und den Button “Finish” klicken. Anschließend beginnt die Installation der JBoss Tools:

Die Installation verlangt einen Eclipse Neustart.

JBoss Server Runtime konfigurieren

Das spätere Projekt soll direkt von Eclipse heraus in den JBoss Server deployt werden. Dazu muss der JBoss als Server Runtime Environment in Eclipse konfiguriert werden. Um das zu tun die Eclipse Eigenschaften aufrufen “Hauptmenü->Window->Preferences” und die Optionen mit dem Wort “Server” filtern. Unter dem Punkt “Runtime Environments” wird der JBoss Server als Runtime hinzugefügt:

Den Button “Add” klicken und im nächsten Dialog unter “JBoss Community” den “JBoss 6.0 Runtime” auszuwählen. Der Einfachheit halber direkt die Checkbox “Create a new local server” selektieren – das erspart die anschließende Konfiguration einer Server Instanz:

Mit dem Button “Next” in den letzten Dialog wechseln und dort das Verzeichnis auswählen indem der JBoss entpackt wurde (z.B. C:\jboss-6.0.0). Als JRE muss das in Eclipse konfigurierte JDK ausgewählt werden. Unter Configuration default auswählen. Den Wizzard mit dem Button “Finish” beenden:

Nun ist die konfigurierte Server Runtime aufgelistet und kann verwendet werden:

In dem Server-Panel ist auch die lokale Instanz zu sehen:

Als letzte Konfiguration der eingebetteten JBoss Server Instanz wird jetzt noch das Deployment-Verzeichnis geändert. Per default wird die deployte Anwendung im lokalen Workspace in einen versteckten Ordner deployt. Ich mag es lieber wenn meine Anwendung auch mit direkt in den JBoss deploy Ordner deployt wird und dann auch dort zu finden ist.
Um das Deployment-Verzeichnis zu ändern mit einem Doppelklick auf die JBoss Server Instanz die Konfiguration öffnen. Anschließend am unterem Ende des Fensters auf den Tab “Deployment” klicken. Auf der Deployment Seite nun die Einstellung “Use JBoss deploy folder” selektieren und die Einstellungen speichern:

Nun kann der Server endlich durch klick auf den grünen Pfeil gestartet werden – er sollte ohne Probleme hochfahren. In der Console sollte am Ende die Startdauer zu sehen sein:

Im Browser lässt sich der JBoss auch bereits aufrufen:

Wunderbar – der Server läuft =).

Maven Unterstützung in Eclipse

Um Maven direkt aus Eclipse heraus verwenden zu können benötigt man das m2eclipse Plugin von Sonatype. Die Plugin Installation wird wieder über das “Hauptmenü->Help->Install New Software…” gestartet. In meiner Helios Version war die Update URL für das m2eclipse Plugin bereits konfiguriert. Ansonsten einfach folgende Update URL hinzufügen: http://m2eclipse.sonatype.org/sites/m2e
Ist dieses Update URL selektiert wird das Repository geladen. In diesem Fall ist nur ein Plugin selektierbar und das muss natürlich selektiert werden:

Den Dialog mit “Next” weiterführen.
Anschließend kommen wieder die Installationsdetails und die Lizensbedingungen. Den Wizzard mit “Finish” beenden und abwarten bis man aufgefordert wird Eclipse neu zu starten.
Es kann sein, dass nach dem Neustart das Maven Plugin meldet, dass Eclipse mit einem JDK gestartet werden muss:

In diesem Fall die Datei eclipse.ini öffnen (liegt direkt neben der Datei eclipse.exe) und unter dem Ausdruck openFile und oberhalb von -vmargs den Verweis auf die JDK angeben:

Mehr zu der Datei eclipse.ini findest du auch im Eclipse Wiki.

Nach dem Neustart kann in den Eclipse Preferences (Hauptmenü->Window->Preferences) die Maven Einstellungen konfigurieren. Darunter auch welches Maven verwendet werden soll. Das Plugin bringt eine Embedded-Version mit. In Eclipse reicht diese embedded Version eigentlich aus. Es empfiehlt sich aber die eigene Installation zu verwenden, so dass man auf der Kommandozeile die gleiche Maven Version verwendet wie in Eclipse. Dazu in “Maven->Installations” mit dem Button Add die eigene Installation hinzufügen:

Nachdem das Maven Plugin installiert wurde und man evtl. die Maven Installation angepasst hat dauert es einen Moment bis Maven seinen Index aktualisiert hat. Sofern das Maven Index Update noch läuft sieht man dies in dem Progress Panel:

Maven Extras – m2eclipse-extras

Es fehlt noch das Maven Integration for Eclipse WTP Plugin um mit Maven mit dem Eclipse Web Tools Project zu verbinden. Dazu noch einmal im Hauptmenü “Help->Install New Software..2 klicken und die Update URL auswählen oder hinzufügen: http://m2eclipse.sonatype.org/sites/m2e-extras

Anschließend den Wizzard wieder wie gewohnt durchgehen und das Plugin installieren.

Das erste Java EE 6 Projekt

Nun ist Eclipse konfiguriert und vorbereitet – es ist Zeit für das erste Java EE 6 Projekt mit Eclipse WTP und Maven Unterstützung.

Projekt mit Maven generieren

Um ein neues Projekt anzulegen im Hauptmenü “File->New->Other” klicken und im geöffneten Startfenster des Wizzards “Maven Project” auswählen:

Mit den Button “Next” weiter. Im zweiten Dialog “Select Project Name and Location” die Voreinstellung “Use default Workspace Location” selektiert lassen und Button “Next” klicken.
Im folgenden Dialog “Select an Archetype” nach “knappsack” filtern und ee6-sandbox-archetype auswählen. Falls dieser Archetype nicht verfügbar ist kann es sein, dass der Maven Index Update noch nicht vollständig durchlaufen ist – in diesem Fall sieht man in Eclipse unten rechts im Progress View, dass ein Prozess läuft und es hilft nur warten..
Die “knappsack” Archetypes wurden von Andy Gipson erstellt und ermöglichen einen sehr einfachen Start in das Projekt.
Wer ein Beispielprojekt mit einem vollständigem CRUD Beispiel haben möchte sollte das Archetype jee6-sandbox-demo-archetype verwenden.

Nach dem Selektieren des Archetypes den Dialog mit “Next” verlassen.

Auf der nächsten Seite müssen jetzt die Archetype Parameter gesetzt werden. Das ist zum Einen die Group Id und zum Anderen die Artifact Id. In die Group id kommt der übergeordnete Name der Package Struktur und als Artifact Id wird der Projektname gewählt:

Mit dem Button “Finish” den Wizzard beenden. Das Projekt wird nun generiert und das kann einen Moment dauern:

Nun ist das Projekt erstellt und man kann sich die Java, xhtml und Konfigurationsdateien ansehen die durch den gewählten Maven Archetype generiert wurden:

Diese generierten Java und xhtml Dateien sollen den Einstieg in JSF 2, CDI und JPA 2 vereinfachen.

Konfiguration in web.xml auf Servlet 3.0 umstellen

Der ausgewählte Maven Archetype hat in der web.xml als Servlet Spezifikationsversion 2.5 konfiguriert aber wir wollen 3.0 verwenden. Deswegen die web.xml Datei öffen: ALT-Shift-R -> web.xml oder im Verzeichnis src/main/webapp/WEB-INF. In dieser Datei steht auch schon als Kommentar der Hinweis, dass man für den JBoss Servlet Version 3 verwenden soll. Dazu die Zeile 10 löschen und die oberen Zeilen mit version=”3.0″ verwenden. Mein web-app Element sieht wie folgt aus:

JSF Capabilities dem Projekt hinzufügen

Öffnet man eine .xhtml Seite so öffnet sich der Visuell Editor von den JBoss Tools. Allerdings erscheint eine Fehlermeldung, dass die JSF Capabilities / JSF Unterstützung für dieses Projekt noch nicht konfiguriert ist:

Entweder in dieser Fehlermeldung direkt auf den Button “Add JSF Capabilities” klicken oder mit der rechten Maustaste auf das Projekt und aus dem Kontextmenü “Configure->Add JSF Capabilities” klicken. In beiden Varienten öffnet sich ein Wizzard mit dem ersten Dialog “Project Location”. Der vorgegebene Pfad für die web.xml Datei sollte eigentlich stimmen:

Mit den Button “Next” auf den nächsten Dialog “Project Folders” wechseln. Die vorgegebenen Pfade sollten auch hier stimmen. Die Checkbox “Add Libraries” darf nicht selektiert werden denn sonst kommt es später zu Fehlern.
Als Servlet Version muss 3.0, wie zuvor bereits in der web.xml abgeändert, ausgewählt werden.
Der Haken bei der Checkbox für “Target Server” bewirkt, dass dieses Projekt direkt dem konfigurierten JBoss hinzugefügt und mit deployt wird:

Den Wizzard mit dem Button “Finish” beenden. Man wird anschließend gefragt ob man in die Web Developer Perspektive wechseln möchte. Je nach Geschmack kann man sich die Web Developer Perspektive anschauen und verwenden oder wieder in die Java EE Perspektive wechseln.

Nun sollten sich alle .xhtml Seiten ohne Warnung im Visual Editor öffnen lassen und auch Autocomplete für JSF Tags möglich sein:

CDI (Context and Dependency Injection) Unterstützung dem Projekt hinzufügen

Als letztes müssen noch die CDI Unterstützung konfiguriert werden. Man merkt es daran, dass in der .xhtml Seite noch kein Autocomplete für die EL (Expression Language) zulässt. Wenn man z.B. in der home.xhtml den Cursor in die Expression #{demoCourseList} in Zeile 11 setzt und F3 drückt sollte die entsprechende Producer Methode der CDI Bean springen:

Die CDI Unterstützung wird genauso hinzugefügt wie die JSF Capabilites im Abschnitt zuvor. Im Kontextmenü des Projektes (rechte Maustaste auf den obersten Knoten des Projekts) Configure->Add CDI (Context and Dependency Injection) support.. klicken. Im geöffneten CDI Preferences Dialog die Checkbox selektiert lassen und den Button “Apply” drücken. Anschließend den Preferences Dialog mit dem Button “OK” wieder verlassen:

Nun den gleichen Versuch wie vorher schon in der home.xhtml machen und mit dem Cursor auf die Expression #{demoCourseList} in Zeile 11 setzen und F3 drücken. Nun öffnet sich der Java Editor genau an der richtigen Methode mit dem dazugehörigem CDI Producer:

Außerdem funktioniert nun auch Autocomplete direkt in der .xhtml Seite in einer Expression:

Projekt auf den JBoss deployen

Jetzt kommt der erste Test ob das generierte Projekt sich auch deployen und im Browser anzeigen lässt. Dazu im Server Panel überprüfen ob das Projekt dem Server hinzugefügt wurde – dazu einfach den JBoss aufklappen und vergewissern ob das jee6project zu sehen ist. Falls nicht muss das Projekt noch hinzugefügt werden: “rechte Maustaste auf JBoss 6.0 Runtime Server->Add and Remove…”. Anschließend den Server starten:

In der Console erscheinen dann irgendwann die folgenden Zeilen:

Nun die deployte Anwendung im Browser unter http://localhost:8080/jee6project aufrufen:

Die Seite die dargestellt wird stammt aus dem gewählten Knappsack Maven Archetype und soll die ersten Schritte in Java EE 6 bzw. in CDI vereinfachen.
Um zu prüfen ob die WTP Unterstützung funktioniert kann man das Hot Deployment ausprobieren. Hot Deployment funktioniert auf alle Web Resourcen wie z.B. .xhmtl, .css oder Bilddateien.
Um das zu testen einfach die home.xhtml öffnen und einen Text eingeben:

Nach dem speichern die Seite im Browser aktualisieren und der Text sollte direkt angezeigt werden.

Prinzipiell ist das Tutorial an dieser Stelle zu Ende – der JBoss läuft und das Java EE 6 Projekt ist deployt. Es lohnt sich als nächstes den Code durchzusehen und zu verändern. Im folgenden Abschnitt wird noch kurz auf ein paar Dinge im Source Code rund um CDI eingegangen.

Wie geht es weiter?

An diesem Punkt angekommen solltest du ein laufendes Java EE 6 Projekt im Web Profile auf dem JBoss Application Server haben. Nun kannst du dich mit Eclipse, Maven oder Java EE 6 weiter beschäftigen.
Hast du mit Java EE 6 noch überhaupt keine Erfahrungen solltest du dir dieses Projekt genauer ansehen und dich mit den bereits verwendeten Annotationen und Aufbau vertraut machen.

Viel Spaß beim ausprobieren =).

Somit geht es diese Woche mit dem “Links Thread #1″ los:

• The possibilities of Servlet 3.0 and JavaEE 6 (Michael Galpin)
  Developing with Comet and Java – Implementing the Servlet 3.0 specification. [Link]
• DTO in anger (Nicolas Fränkel)
  In JEE architecture using lighweight frameworks, creating a DTO layer is an anti-pattern. [Link]
• Speed up your Data-Driven JSF/Seam Application by Two Orders of Magnitude (Dan Allen)
  Sehr lesenswerter Artikel über gängige Performance Probleme und mögliche Optimierungen bei JSF/Seam Anwendungen. [Link Teil 1][Link Teil 2]
• JPA implementation patterns: Using UUIDs as primary keys (Albert Sikkema)
  Interessanter Ansatz mit Pro und Cons anstatt @GeneratedValue eine UUID in einer abstracten Oberklasse selbst zu generieren [Link]
• JSF Applications – JBoss Seam or Spring Web Flow? (Edem Morny)
  Schöne Zusammenfassung der wichtigsten Punkte bei der Entwicklung einer Web Anwendung im Zusammenhang mit einem Vergleich zwischen Seam und Spring Web Flow. [Link]
• Seam and Spring Comparison (Andy Gibson)
  Ein sehr schön ausgearbeiteter und ausführlicher Vergleich dieser beiden Frameworks. [Artikel Link] [Diskussion]
• Configuring a Seam EJB project for development with Maven and JBoss Tools (Maarten Winkels) [Link]