Inhalt

Installation JBoss/Eclipse
Eclipse und WebTools-Plugin konfigurieren:
JBoss-KnowHow:


Installation JBoss/Eclipse

Benötigte Komponenten



Eclipse und WebTools-Plugin konfigurieren

JBoss 5.0.0CR2

In "Window" -> "Preferences..." gehen und links in der Übersicht den Punkt "Server" -> "Runtime Environments" wählen. Über "Add..." einen neuen Server zufügen.
JBoss konfigurieren, Schritt 1
Wir wählen einen Server vom Typ "JBoss v5.2" aus.
Die Checkbox "Also create new local server" können wir ignorieren, den lokalen Server kann man später auch per Hand anlegen.
JBoss konfigurieren, Schritt 1
Im nächsten Schritt als Runtime die Default-Java-Runtime (sollte ein JDK 1.6 sein) auswählen und als "Application Server directory" das Wurzel-Verzeichnis des JBoss auswählen. Liegen wir beim "Application Server Directory" falsch wird uns das durch Fehlermeldungen mitgeteilt.
JBoss konfigurieren, Schritt 2


WebTools-Plugin goes Internet

Jedesmal wenn man eine XML-Datei öffnet oder sie von einem Buildprozess berührt wird versucht der Plugin sie gegen ihre DTD oder ihre Schemadefinition zu validieren.
An der FH müßt ihr den Proxy unter "Window" -> "Preferences" im Punkt "General"-> "Network Connections" eintragen.
Proxy
Die DTDs und XSDs werden nach dem Laden aus dem Internet und in einem lokalen Cache gespeichert. Den Inhalt des Caches kann man unter "Window" -> "Preferences" im Punkt "General" -> "Network Connections" -> "Cache" anschauen, oder im Dateisystem im Workspace-Unterzeichnis ".metadata\.plugins\org.eclipse.wst.internet.cache".
WTP-Cache
ACHTUNG: Falls euer Internetprovider die Angewohnheit hat den ersten Zugriff nach Aufbau der Verbindung auf die eigene Homepage umzuleiten kann es sein dass dies genau die DTD-Definition ist die der WTP-Plugin laden will. Und schon hat er eine HTML-Datei gefressen und meckert über das falsche Format.


Eclipse-Tuning

Folgende Einstellungen empfehle ich, um Eclipse schneller und Resourcenschonender einzustellen:

Automatischen Build ausschalten
Die Option "Build Automatically" im Menü "Project" wird ausgeschaltet:
Build Automatically
Das bedeutet dass man das Compilieren vor einem Deploy per Hand durch "Build Project" bzw. "Build All" anstoßen muss.

Rechtschreibprüfung abschalten
Die integrierte Rechtschreibprüfung (per Default sowieso nur englisches Wörterbuch) wird abgeschaltet da dies sehr viele Resources kostet:
Spellcheck


Eclipse-Codeformatter

Damit der Quellcode zumindest innerhalb einer Projektgruppe bei allen gleich aussieht empfehle ich die Codeformatierungs-Optionen von Eclipse zu vereinheitlichen. Dies geschieht über "Window" -> "Preferences" -> "Java" -> "Code Style" -> "Formatter", wo man ein neues Profile zufügt. Im folgenden die in meinen Beispielen verwendeten Einstellungen:
Eine Mischung aus Tabs und Leerzeichen sieht in einem anderen Editor meistens müllig aus, deshalb nur Leerzeichen für Einrückung verwenden. Und mit nur 2 Leerzeichen sparen wir Platz.
Indentation
Ich bevorzuge öffnende Klammern auf der gleichen Spalte wie die schließende Klammer, also viele Zeilenumbrüche.
Braces
Passend zu den Zeilenumbrüchen vor öffnenden Klammern mag ich sie auch nach schließenden Klammern.
Control Statements
Die maximale Zeilenlänge bis zu einem vom CodeFormatter erzwungenen Zeilenumbruch würde ich von 80 auf 120 erhöhen.
Line Wrapping
Angewendet werden diese Einstellungen automatisch beim Tippen. Man kann aber auch nachträglich eine Datei formatieren, indem man sie öffnet und im Editor-Contextmenü den Punkt "Source" - "Format" wählt:
Format


Für die Formatierung von HTML-/JSP-Seiten finden wir die Formatierungseinstellungen unter "Window" -> "Preferences" -> "Web" -> "HTML" -> "Editor". Auch hier werden Tabs abgeschaltet sowie die Zeilenlänge auf 120 Zeichen hochgedreht.
HTML formatter


Javadoc

In den Preferences werden die JavaDoc-Warnungen eingeschaltet:
JavaDoc

ACHTUNG:
Wenn man diese Warnungen einschaltet und den Quellcode von Eclipse automatisch formatieren läßt (in Quellcodedatei Rechtsklick -> "Source" -> "Format"), dann wird man danach von Warnmeldungen erschlagen. Grund ist, dass nach jedem @param-Tag ein Zeilenumbruch erfolgt: 
  /**
   * Compute the volume of a square stone
   * 
   * @param a
   *          Length of side a, > 0
   * @param b
   *          Length of side b, > 0
   * @param c
   *          Length of side c, > 0
   * @return Volume of the square stone = a * b * c
   * @exception InvalidParameterException
   *              If a or b or c <= 0.
   */
  public double computeCuboidVolume(double a, double b, double c) throws InvalidParameterException
  {
Eclipse denkt dadurch, dass nach dem @param-Tag kein Kommentar steht und stellt sich selbst ein Bein.

Diese unnötigen Zeilenumbrüche lassen sich abschalten, indem man im oben angelegten Code-Formatter-Profil folgende Option abschaltet:
Javadoc-Formatter
Siehe https://bugs.eclipse.org/bugs/show_bug.cgi?id=222900


Projektstruktur

Die Struktur eines Projekts (im Beispiel das Stateless-Beispiel mit EJB-Projekt, Webprojekt und ApplicationClient) sieht auf Festplatte so aus:
Projektstruktur
Wird das Projekt auf einen Server geschoben (im Beispiel ein JBoss) muss die EAR-Datei erstellt werden. Dazu werden alle relevanten Daten in das Verzeichnis "%WORKSPACE%\.metadata\.plugins\org.eclipse.wst.server.core\tmp0\Stateless\" geschoben.
Projektstruktur beim Publish
Hier landen die JAR-Dateien für die einzelnen Module (StatelessClient.jar, StatelessEJB.jar und StatelessWeb.war) sowie der Deployment-Deskriptor der gesamten Anwendung. Aus diesen Daten wird die EAR-Datei erzeugt und auf den Server verschoben.


Debugging

Zum Debuggen dürfen wir den JBoss nicht "normal" starten sondern im Debug-Modus (Rechtsklick auf den Server, "Debug" wählen).
Debug-Modus
Im folgenden beziehe ich mich auf Klassen aus dem ersten Beispiel, "Stateless".
Wir setzen einen Breakpoint in der Methode doPost des GeometricModelServlet. Anschließend im Browser zu dieser URL navigieren: http://localhost:8080/StatelessWeb/servlet/GeometricModelServlet. Wenn wir alles richtig gemacht haben schiebt sich Eclipse in den Vordergrund, und wir werden gefragt ob wir in die Debug-Perspective wechseln wollen (machen wir natürlich).
Debug-Perspective
In der Toolbar können wir jetzt Einzelschritte ausführen, in Funktionen springen oder aus einzelnen Funktionen hinausspringen. Über die Schaltfläche "Resume" können wir die Verarbeitung bis zum nächsten Breakpoint weiterlaufen lassen.
Debug-Fenster

Auf diese Weise können wir auch JSP-Seiten debuggen.


JBoss-Knowhow

Generierte JSP-Java-Klassen

Zu JSP-Seiten generiert der in den JBoss integrierte Tomcat 6.0 Java-Dateien, diese wiederum werden ganz normal compiliert. Die generierten Java-Dateien findet man hier: JBOSS_DIR\server\default\work\jboss.web\localhost\(name der Web-Applikation)\org\apache\jsp. Ein Blick in diese Dateien ist bei Compilefehlern in der JSP-Seite eventuell nötig, wobei in den meisten Fällen die fehlerhaften Zeile der JSP-Datei angegeben wird. Nur bei sehr schweren Syntax-Fehlern kann es nötig sein, einen Blick in die generierte Java-Datei zu werden.

JMXConsole und JNDIView

Unter http://localhost:8080/jmx-console erreicht man die JMXConsole, über die JBoss seine MBeans für die interne Serververwaltung anzeigt. In der Gruppe "jboss" finden wir service=JNDIView
JMXConsole (JNDIView)
Der Service ist auch direkt über diese URL zu erreichen: http://localhost:8080/jmx-console/HtmlAdaptor?action=inspectMBean&name=jboss%3Aservice%3DJNDIView.
Diesen Service öffnen. Wir sehen einige Properties der MBean sowie einige Operations.
JNDIView
Uns interessiert java.lang.String list(). Wir führen sie aus indem wir auf Invoke klicken.
Die folgenden Ausgaben entstanden als das Stateless-Beispiel deployed war:
Im "Global JNDI Namespace" finden wir unsere diversen Beans (Remote- und Local-Interfaces) sowie den Environment Naming Context des Clients hinterlegt. In JBoss 4.2 waren Web-Projekte in einem eigenen Abschnitt aufgelistet, in JBoss 5.0 scheint dieses Feature verloren gegeganen zu sein.
JNDIView (Stateless-Beispiel)

Logging

In allen Beispielen wird das Logging mittels der Klassen des Packages java.util.logging verwendet. Im Code sieht das so aus:
Auf Klassenebene wird ein Logger deklariert (Codefragmente aus dem Stateless-Beispiel):
    protected static final Logger logger = Logger.getLogger(GeometricModelBean.class.getName());

Die Logausgabe erfolgt so:
    logger.info("computeCuboidVolume mit a = " + a + ", b = " + b + ", c = " + c);

Die Logdatei ist beim JBoss im Default in "JBOSS_DIR\server\default\log\server.log" und enthält z.B. nützliche Infos zu den EJB-QL-Abfragen.

Das Verhalten des Logger-Moduls wird über eine Property-Datei konfiguriert. Im Default ist dies "JRE_DIR\lib\logging.properties". Im folgenden der Inhalt des Sun-JDK 1.6.0 (Kommentare teilweise entfernt):

# Global properties

handlers= java.util.logging.ConsoleHandler

.level= INFO

# Handler specific properties.
# Describes specific configuration info for Handlers.

# default file output is in user's home directory.
java.util.logging.FileHandler.pattern = %h/java%u.log
java.util.logging.FileHandler.limit = 50000
java.util.logging.FileHandler.count = 1
java.util.logging.FileHandler.formatter = java.util.logging.XMLFormatter

# Limit the message that are printed on the console to INFO and above.
java.util.logging.ConsoleHandler.level = INFO
java.util.logging.ConsoleHandler.formatter = java.util.logging.SimpleFormatter

# Facility specific properties.
# Provides extra control for each logger.

com.xyz.foo.level = SEVERE
Es wird ein Console-Logger definiert (d.h. alle Logausgaben landen auf System.out). Ein File-Handler wird zwar initialisiert, aber nicht aktiviert. Der FileHandler verwendet das XML-Format.


Um jetzt einen Logger zu aktivieren, der die Ausgabe in eine Datei umleitet und nur Ausgaben unseres Stateless-Loggers anzeigt, wird die Datei so modifiziert (am besten eine Kopie an beliebiger Stelle anlegen und diese ändern !).
# Global properties

handlers= java.util.logging.FileHandler

.level= INFO

# Handler specific properties.
# Describes specific configuration info for Handlers.

java.util.logging.FileHandler.pattern = c:/PFAD/ZUR/LOGDATEI/logdatei.log
java.util.logging.FileHandler.limit = 50000
java.util.logging.FileHandler.count = 1
java.util.logging.FileHandler.formatter = java.util.logging.SimpleFormatter

# Facility specific properties.
# Provides extra control for each logger.
de.fhw.swtvertiefung.knauf.stateless.level = INFO


Der Konsolen-Logger wird durch einen Datei-Logger ersetzt, der statt XML einfachen Text ausgibt. Für alle Klassen deren Package mit "de.fhw.swtvertiefung.knauf.stateless" beginnt wird das Loglevel auf "INFO" gesetzt. Würden wir hier das globale Log-Level (".level = INFO") auf einen Wert wie WARNING oder SEVERE setzen würden wir keine Ausgaben (bzw. nur noch wirkliche Fehler) aus den anderen Packages erhalten.

Dem Logger müssen wir noch erzählen wo unsere Config-Datei liegt. Dies geschieht durch das Kommandozeilenargument
-Djava.util.logging.config.file=c:/PFAD/ZUR/CONFIGDATEI/logging.properties

Für den JBoss-Server ist das Vorgehen so:
Im Default geht die Logausgabe über das java.util.logging-Package auf die Konsole.
Um den Server dazu zu bringen, diese Konfigurationsdatei zu verwenden müssen wir folgendes tun:
Rechtsklick auf einen vorhandenen Server, "Open" wählen. Es erscheint die "Server Overview".
Logging-Konfiguration (1)
Wir klicken auf "Open Launch Configuration". Auf der Karteikarte "Arguments" geben wir den Pfad zur Config-Datei an.
Logging-Konfiguration (2)
Schon haben wir die Logausgaben in der angegebenen Datei. Für den JBoss führt das erfreulicherweise sogar dazu dass NUR die Ausgaben unseres eigenen Packages in dieser Datei ausgegeben werden, die des JBoss landen weiterhin in der Standard-Datei "server.log". Dadurch haben wir alle unseren Logausgaben übersichtlich auf einem Haufen.




Stand 16.02.2009
Historie:
19.10.2008: Erstellt aus Vorjahresdoku und angepaßt an Eclipse 3.4, JBoss 5.0 etc.
22.10.2008: Link zum JBoss-Trailblazer verschoben auf Hauptseite. Installationsdoku minimal überarbeitet, Java 1.6.0_10.
02.12.2008: Eclipse-Paket auf WebTools 3.0.3 und Subclipse 1.4.6 aktualisiert.
10.12.2008: JBoss 5.0GA, Eclipse-Paket für diese JBoss-Version tauglich gemacht.
15.12.2008: Eclipse-Paket aktualisiert: Einstellung "Server vor erstem Publish starten" fehlte
17.12.2008: Eclipse-Paket aktualisiert: log4j.xml für JSR88-Deployer (behebt entsprechende Warnungen beim Publish)
22.12.2008: Eclipse-Paket aktualisiert: JSR88-Deployer kam mit Deployment-Exceptions von JBoss 5.0GA nicht zurecht
10.02.2009: Javadoc-Formatter-Einstellungen
16.02.2009: Link zum Eclipse-Bug der Javadoc-Validierung.