JavaServerFaces, Daten mit EclipseLink in einer Datenbank speichern

In diesem Tutorial möchte ich beschreiben wie man in einer JavaServerFaces Webanwendung Daten in einer Datenbank mit Eclipselink speichert.

Als Grundlage für dieses Tutorial möchte ich das Projekt „Timeline“ verwenden, dieses Projekt habe ich bereits im Tutorial Erstellen einer Timeline für Beiträge mit JavaServerFaces vorgestellt.

Zum speichern der Daten verwende ich eine H2 Datenbank. Diese ist relativ schlank und kommt ohne eine Installation daher. Somit ist diese Datenbank gut für die Entwicklung geeignet. Im späteren betrieb kann der Datenbanktreiber und die entsprechende Konfiguration einfach über XML angepasst werden.

erweitern der Maven Dependencies

Damit wir Eclipselink konfigurieren und später verwenden können, müssen wir uns zunächst die Abhängigkeiten in das Projekt holen. Da das Projekt mit Apache Maven aufgebaut ist wird die Datei „pom.xml“ wie folgt ergänzt.

Wie bereits erwähnt verwende ich für dieses Tutorial eine H2 Datenbank, daher benötige ich zusätzlich die Abhängigkeit um den Treiber zu laden. Wenn Sie eine andere Datenbank zbsp. Apache Derby, MySQL verwenden wollen benötigen Sie den entsprechenden Treiber.

erweitern der Verzeichnisstruktur

Neben den Abhängigkeiten benötigen wir noch zusätzlich das Verzeichnis „META-INF“ und die Datei „persistence.xml“. Das Verzeichnis wird unter

Projekt "Timeline" - erweiterte Verzeichnisstruktur für Eclipselink
Projekt „Timeline“ – erweiterte Verzeichnisstruktur für Eclipselink

einrichten der Datei „persistence.xml“

In der Datei „persistence.xml“ wird die Einstellung für die Datenbankverbindung gesetzt. Hier gibt es 2 Arten von Verbindungen, 

  • direkte JDBC Connection und
  • Container-managed Datasource

Für dieses Tutorial verwende ich zunächst eine „direkte JDBC Connection“. Da die Anwendung in einem Apache Tomcat läuft und dieser Server kein EE kann lohnt sich der Weg über die „Container-managed Datasource“ nicht.

Zunächst einmal muss man der Verbindung einen Namen geben, dieser wird im Attribut „name“ gesetzt“.
Der Name muss einzigartig / unique in der Datei „persistence.xml“ sein.

Im Attribut „transaction-type“ wird in diesem Beispiel „RESOUCE_LOCAL“ gesetzt, wenn eine „Container-managed Datasource“ verwendet dann muss dort „JTA“ eingetragen werden.

H2 Datenbankverbindung einrichten

Für die Datenbankverbindung 

Erweitern der Klasse TimelineEntry

Die Klasse „TimelineEntry“ ist aus dem Tutorial Erstellen einer Timeline für Beiträge mit JavaServerFaces bekannt.
Damit wir diese in der Datenbank speichern können müssen wir die Klasse mit der Annotation @Entity  annotieren sowie das Interface Serializable implementieren.

Zusätzlich müssen wir ein Feld für die ID implementieren denn dieses wird als Primaryfield für die spätere Tabelle benötigt.

Einbinden als Entity

Damit diese javax.persistence.Entity vom EntityManager gefunden wird muss diese Klasse in der Datei „persistence.xml“ deklariert werden.

Data Access Object Pattern

Als nächsten Schritt wollen wir unsere DAO für das speichern der Entity erstellen. DAO bedeutet „Data Access Object“ und dahinter versteckt sich ein Pattern zum serialisieren von Daten. Dabei ist es nicht unbedingt von Nöten diese Daten in eine Datenbank zu speichern auch für XML oder JSON Daten kann dieses Pattern angewendet werden.

Zunächst einmal benötigen wir ein Interface „Dao“ mit den Methoden welche für das speichern und laden von Daten benötigt werden.

Da die Methode „save(T t)“ für jede Entity gleich ist erstelle ich eine Abstrakte Klasse welche das Interface „Dao“ implementiert. Zusätzlich kann man hier einmalig die Factory für den EntityManager definieren und erspart sich hier auch wieder doppelten Code. 

Des Weiteren implementieren wir eine Methode welche uns eine Liste aller Entitys für den Generischen Typ liefert. Dieser Methode wird der Name einer NamedQuery übergeben.

Zum Schluss müssen wir uns noch eine Klasse „TimelineEntryDAO“ anlegen welche die Abstrakte Klasse „AbstractDao“ erweitert. Als Generischen Typ übergebe ich die Entity „TimelineEntry“.

Nun müssen wir noch unsere Klasse „TimelineEntry“ um die NamedQuery erweitern

und die Methode „getAll()“ wiefolgt ausprogrammieren

Da der Name einer NamedQuery unique  quasi einziartig sein muss, kann man diese nicht gleich benennen und generisch verwenden.

JUnit Testfall

Um die Funktionalitäten des speicherns und ladens einer Entity zu testen verwende ich einen JUnit Testfall.

Speichern eines TimelineEntrys

 

SQL Client SQuirreL

Wenn die ersten Daten in der H2 Datenbank gespeichert wurden, kann man sich diese mit einem SQL Client anschauen. Ich verwende im nachfolgenden den SQL Client SQuirreL. (Dieser SQL Client ist kostenfrei erhältlich.)

Installation

Der SQL Client kann von SourceForge  kostenfrei geladen werden. Ich verwende das Paket „https://sourceforge.net/projects/squirrel-sql/files/latest/download“ dieses wird in einen beliebigen Ordner heruntergeladen und per doppelklick gestartet.

SQuirreL - "plain" setup Package
SQuirreL – „plain“ setup Package

Schritt 1 – Starten des Wizards

Mit einem doppelklick auf die Datei „squirrel…jar“ wird der Wizard zum installieren des SQL Clients gestartet.

SQuirreL - Installation, Schritt 1
SQuirreL – Installation, Schritt 1

Nachdem man die kurze Einleitung gelesen hat, bestätigt man dieses Fenster mit der Schaltfläche „Next“. Im nachfolgenden Fenster wird auf die Systemvorraussetzung der jeweiligen Version von Squirell hingewiesen.

SQuirreL - Installation, Schritt 2
SQuirreL – Installation, Schritt 2

Auch dieses Fenster bestätigen wir mit der Schaltfläche „Next“. 

Sollte eine kleinere Version von Oracle Java installiert sein als benötigt so sollte der Wizard hier unterbrochen werden und dieses nachgeholt werden.

Schritt 2 – Zielverzeichnis wählen

Im nächsten Fenster wird das Zielverzeichnis gewählt. Ich weiche hier vom vorgegebenen Verzeichnis ab.

SQuirreL - Installation, Schritt 3
SQuirreL – Installation, Schritt 2

Sollte das Verzeichnis nicht existieren so wird man in einem zusätzlichen Dialog gefragt ob das Verzeichnis erstellt werden soll. Diesen Dialog sollte man zunächst mit „OK“ bestätigen.

SQuirreL - Installation, Schritt 3
SQuirreL – Installation, Schritt 2a

Schritt 3 – Installationspakete wählen

Im nachfolgenden Schritt werden nun die Installationspakete ausgewählt, da ich für dieses Tutorial die H2 Datenbank verwende, wähle ich das zusätzliche, optionale Plug „H2“ aus und bestätige die Auswahl mit der Schaltfläche „Next“.

SQuirreL - Installation, Schritt 3
SQuirreL – Installation, Schritt 3

Nachdem nun das Zielverzeichnis und die Installationspakete gewählt wurden, wird der SQL Client installiert.

SQuirreL - Installation, Schritt 4
SQuirreL – Installation, Schritt 4

Wurde die Installation erfolgreich fertiggestellt, so muss dieses Fenster mit der Schaltfläche „Next“ bestätigt werden.

Schritt 4 – Shortcuts setzen

Abschließend kann man optional Shortcuts erstellen lassen. Ich belasse die gesetzten Einstellungen und bestätige dieses Fenster mit der Schaltfläche „Next“.

SQuirreL - Installation, Schritt 4
SQuirreL – Installation, Schritt 4

Schritt 5 – Abschluss der Installation

Im letzten Schritt 5 wird die Installation abgeschlossen, es wird ein kurzer Text angezeigt, das die Installation erfolgreich war und auf den uninstaller hingewiesen. Dieses Fenster kann nur mit einem klick auf der „X“ oben rechts geschlossen werden.

SQuirreL - Installation, Schritt 5
SQuirreL – Installation, Schritt 5

Einrichten der TimelineDB

Kopieren des H2 Datenbanktreibers

Damit man in dem SQL Client eine Verbindung zur Datenbank einrichten kann benötigt man den Treiber. Diesen Treiber haben wir mit dem Apache Maven Projekt bereits aus dem Internet geladen und finden diesen unter C:\Benutzer\<<Benutzername>>\.m2\repository\com\h2database\h2\<<Versionsnummer>>\h2-<<Versionsnummer>>.jar.

Der Treiber kann dann optional von dort geladen werden oder aber in den Ordner „libs“ der SQuirreL installation kopieren. In diesem Tutorial kopiere ich den Treiber in das „lib“ Verzeichnis, dieses hat den Vorteil das man den Treiber nicht extra installieren muss da dieser beim starten der Anwendung SQuirreL geladen wird.

SQuirreL - H2 Datenbanktreiber
SQuirreL – H2 Datenbanktreiber

Starten von SQuirreL

Wurde der SQL Client SQuirreL erfolgreich installiert so wird dieser über die Datei „squirrel-sql.bat“ oder dem zurvor erstellen Shortcut gestartet.

SQuirreL - Verzeichnis
SQuirreL – Verzeichnis

Erstellen eines Aliases für die Datenbankverbindung

Zunächst einmal muss man auf den Reiter „Aliases“ (1) wechseln und danach die Schaltfläche „Create a new Alias“ (2) betätigen.

SQuirreL - erstellen eines Aliases Schritt 1
SQuirreL – erstellen eines Aliases Schritt 1

Im nachfolgenden Dialog geben wir diesem Alias einen Namen und setzen den Benutzernamen (User Name) sowie das Passwort.

Die URL kann man aus der Datei „persistence.xml“ entnehmen, jedoch muss man den Pfad anpassen denn „./“ bezieht sich immer auf das aktuelle Verzeichnis.

SQuirreL - Alias Einstellungen
SQuirreL – Alias Einstellungen

In diesem Fenster kann man die Einstellungen testen indem man einfach auf die Schaltfläche „Test“ klickt und im nachfolgenden Fenster ggf. Benutzername & Passwort eingibst.

SQuirreL - Aufbau einer Testverbindung
SQuirreL – Aufbau einer Testverbindung

Ist dieses erfolgt so kann eine Verbindung mit der Schaltfläche „Connect“ aufgebaut werden.

SQuirreL - Aufbau einer Testverbindung erfolgreich
SQuirreL – Aufbau einer Testverbindung erfolgreich

Aufbau der Verbindung

Wenn die Datenbankverbindung eingerichtet ist, kann diese im Reiter „Aliases“ mit einem doppelklick gestartet werden.

SQuirreL - Struktur der Datenbank Timeline
SQuirreL – Struktur der Datenbank Timeline

 

 

 

 

Schreibe einen Kommentar

Deine E-Mail-Adresse wird nicht veröffentlicht. Erforderliche Felder sind mit * markiert.