CreateDAO_de

[mysqld]
default-table-type=innodb
default-character-set=utf8

Wenn man PostgreSQL nutzt und komische Fehlermeldungen über batch processing erhält, kann man versuchen dies abzustellen indem man die Zeile <prop key="hibernate.jdbc.batch_size">0</prop> zur Datei src/dao/**/hibernate/applicationContext-hibernate.xml hinzufügt.

AppFuse nutzt Hibernate als Standard Persistenz Schicht. Hibernate ist ein Object/Relational (O/R) Framework, welches es einem ermöglicht, Java Objekte und Datenbanktabellen zu verknüpfen. Das Framework erlaubt es einem, sehr einfach CRUD (Create, Retrieve, Update, Delete) Methoden auf seine Objekte anzuwenden.

Man kann auch iBATIS als Persistenz Framework verwenden. Weitere Informationen, um iBATIS in AppFuse zu installieren, findet man in der README.txt in extras/ibatis. Falls man IBatis über Hibernate nutzen will, gehe ich davon aus, dass man gute Gründe dafür hat und sich mit dem Framework auskennt. Ich nehme auch an, dass man sich selbst vorstellen kann, wie man dieses Tutorial in Zusammenhang mit IBatis nutzen sollte. ;-)

Font Konventionen (in Arbeit)

Zeichenketten die über die Kommandozeile ausgeführt werden sollen, sehen folgendermasen aus: ant test-all.

Verweise auf Dateien, Verzeichnisse und Pakete, welche im Sourceverzeichnis existieren: build.xml.

und Vorschläge, wie man Dinge in der "realen Welt" durchführt, sind blau und schräg gestellt.

Beginnen wir mit dem Erstellen eines neuen Objekts, der DAO Klasse und der Tests in Appfuse Projekt Struktur.

Inhaltsverzeichnis

• [1] Ein neues Objekt erzeugen und XDoclet tags hinzufügen
• [2] Aus dem Objekt mit Hilfe von Ant eine neue Datenbanktabelle erzeugen
• [3] Eine neuen DaoTest erzeugen, um die DAO Klasse mit Hilfe von JUnit zu testen
• [4] Eine neue DAO Klasse erzuegen, um CRUD Methoden auf dem Objekt auszuführen
• [5] Spring für das Person Objekt und die PersonDao konfigurieren
• [6] Den DaoTest ausführen

Ein neues Objekt erzeugen und XDoclet tags hinzufügen [#1]

Als Erstes benötigen wir ein Objekt. welches wir persistent speichern wollen. Dafür erzeugen wir ein einfaches "Person" Objekt (im src/dao/**/model Verzeichnis), welches eine ID, einen Vornamen und einen Nachnamen (als Properties) besitzt.

Hinweis: Der Java Code in diesem Tutorial kann man nicht mit mit dem Firefox Browser kopieren. Als Notlösung führt man CTRL+Click (Command+Click mit OS X) auf dem Code Block aus und kopiert ihn anschliessend.

Diese Klasse sollte vom BaseObject abgeleitet sein, welches folgende 3 abstrakten methoden enthält: (equals(), hashCode() und toString()). Diese benötigt man, um die Person Klasse zu implementieren. Die ersten beiden benötigt Hibernate. Diese Methoden können sehr einfach mit Commonclipse erzeugt werden. Mehr Informationen über dieses Tool findet man auf Lee Grey's Seite. Ein anderes Eclipse PligIn, das man nutzen könnte, ist Commons4E. Ich habe es noch nicht verwendet, deshalb kann ich nichts zur genauen Funktionalität sagen.

Wenn man IntelliJ IDEA verwendet, kann man die equals() und hashCode() erzeugen, aber nicht die toString() Methode. Es gibt aber ein ToStringPlugin, das anscheinend ganz gut funktioniert.

Nachdem wir jetzt das POJO erzeugt haben, müssen wir die XDoclet Tags hinzufügen, mit deren Hilfe das Hibernate Mapping Datei erzeugt wird. Diese Mapping Datei wird von Hibernate verwendet, um Objekte → Tabellen und Properties (Variablen) → Spalten zu verbinden.

Zuerst fügen wir einen @hibernate.class Tag ein, der Hibernate erklärt, welche Tabelle mit diesem Objekt verbunden ist:

Desweiteren müssen wir einen Primär Schlüssel Mapping angeben, da dies zwingend zur Erzeugung der Mapping Datei von XDoclet benötigt wird. Man beachte, dass alle @hibernate.* tags in den JavaDoc Bereich der Getter des POJOs gehören.

Ich verwende generator-class="increment" anstattgenerate-class="native", weil ich einige Probleme entdeckt habe, wenn man "native" mit anderen Datenbanken nutzt. Falls man plant, nur MySQL zu nutzen, empfehle ich die "native" Einstellung zu nutzen. Dieses Tutorial ntzt "increment".

Aus dem Objekt mit Hilfe von Ant eine neue Datenbanktabelle erzeugen [#2]

[schemaexport] create table person (
[schemaexport]    id bigint not null,
[schemaexport]    primary key (id)
[schemaexport] );

Falls man sich die Person.hbm.xml Datei, die Hibernate für einen erzeugt hat, ansehen will, findet man diese im Verzeichnis build/dao/gen/**/model. Hier der (bisherige) Inhalt der Datei Person.hbm.xml:

Jetzt fügen wir zusätzliche @hibernate.property tags für die anderen Spalten (first_name, last_name) hinzu:

Der einzige Grund, warum in diesem Beispiel das column Attribut hinzugefügt wird, ist, dass der Spaltenname sich vom Attributnamen unterscheidet. Falls die beiden gleich sein sollten, muss man kein column Attribut angeben. Für weitere Informationen kann man einen Blick in die @hibernate.property Referenz dieses Tags werfen.

Jetzt führt man wieder ant setup-db aus, um die neuen Spalten der Tabelle hinzuzufügen.

[schemaexport] create table person (
[schemaexport]    id bigint not null,
[schemaexport]    first_name varchar(50),
[schemaexport]    last_name varchar(50),
[schemaexport]    primary key (id)
[schemaexport] );

Falls man die Größe der Spalten verändern will, kann man das length Attribut im @hibernate.property tag ändern. Falls man dieses Feld als 'benötigt' (NOT NULL) markieren will, fügt man not-null="true" hinzu.

Eine neuen DaoTest erzeugen, um die DAO Klasse mit Hilfe von JUnit zu testen [#3]

Now we'll create a DaoTest to test that our DAO works. "Wait a minute," you say, "we haven't created a DAO!" You are correct. However, I've found that Test-Driven Development breeds higher quality software. For years, I thought write your test before your class was hogwash. It just seemed stupid. Then I tried it and I found that it works great. The only reason I do all this test-driven stuff now is because I've found it rapidly speeds up the process of software development.

To start, create a PersonDaoTest.java class in the test/dao/**/dao directory. This class should extend BaseDaoTestCase, a subclass of Spring's AbstractDependencyInjectionSpringContextTests which already exists in this package. This parent class is used to load Spring's ApplicationContext (since Spring binds the layers together), and for (optionally) loading a .properties file (ResourceBundle) that has the same name as your *Test.class. In this example, if you put a PersonDaoTest.properties file in the same directory as PersonDaoTest.java, this file's properties will be available via an "rb" variable.

I usually copy (open → save as) an existing test (i.e. UserDaoTest.java) and find/replace [Uu]ser with [Pp]erson, or whatever the name of my object is.

The code you see above is what we need for a basic Spring integration test that initializes and destroys our PersonDao. Spring will use autowiring byType to call the setPersonDao() method and set the "personDao" bean as a dependency of this class.

Now we need to actually test that the CRUD (create, retrieve, update, delete) methods work in our DAO. To do this we created methods that begin with "test" (all lower case). As long as these methods are public, have a void return type and take no arguments, they will be called by our <junit> task in our Ant build.xml file. Here's some simple tests for testing CRUD. An important thing to remember is that each method (also known as a test), should be autonomous. Add the following methods to your PersonDaoTest.java file:

In the testGetPerson method, we're creating a person and then calling a get. I usually enter a record in the database that I can always rely on. Since DBUnit is used to populate the database with test data before our tests are run, you can simply add the new table/record to the metadata/sql/sample-data.xml file:

<table name='person'>
    <column>id</column>
    <column>first_name</column>
    <column>last_name</column>
    <row>
      <value>1</value>
      <value>Matt</value>
      <value>Raible</value>
    </row>
</table>

This way, you can eliminate the "create new" functionality in the testGetPerson method. If you'd rather add this record directly into the database (via SQL or a GUI), you can rebuild your sample-data.xml file using ant db-export and then cp db-export.xml metadata/sql/sample-data.xml.

In the above example, you can see that we're calling person.set*(value) to populate our object before saving it. This is easy in this example, but it could get quite cumbersome if we're persisting an object with 10 required fields (not-null="true"). This is why I created the ResourceBundle in the BaseDaoTestCase. Simply create a PersonDaoTest.properties file in the same directory as PersonDaoTest.java and define your property values inside it:

I tend to just hard-code test values into Java code - but the .properties file is an option that works great for large objects.

firstName=Matt
lastName=Raible

At this point, the PersonDaoTest class won't compile yet because there is no PersonDao.class in our classpath, we need to create it. PersonDAO.java is an interface, and PersonDAOHibernate.java is the Hibernate implementation of that interface. Let's go ahead and create those.

Eine neue DAO Klasse erzuegen, um CRUD Methoden auf dem Objekt auszuführen [#4]

Notice in the class above there are no exceptions on the method signatures. This is due to the power of Spring and how it wraps Exceptions with RuntimeExceptions. At this point, you should be able to compile all the source in src/dao and test/dao using ant compile-dao. However, if you try to run ant test-dao -Dtestcase=PersonDao, you will get an error: No bean named 'personDao' is defined. This is an error message from Spring - indicating that we need to specify a bean named personDAO in applicationContext-hibernate.xml. Before we do that, we need to create the PersonDao implementation class.

The ant task for running dao tests is called test-dao. If you pass in a testcase parameter (using -Dtestcase=name), it will look for **/*${testcase}* - allowing us to pass in Person, PersonDao, or PersonDaoTest - all of which will execute the PersonDaoTest class.

Let's start by creating a PersonDaoHibernate class that implements the methods in PersonDao and uses Hibernate to get/save/delete the Person object. To do this, create a new class in src/dao/**/dao/hibernate and name it PersonDAOHibernate.java. It should extend BaseDaoHibernate and implement PersonDAO. Javadocs eliminated for brevity.

Now, if you try to run ant test-dao -Dtestcase=PersonDao, you will get the same error. We need to configure Spring so it knows that PersonDaoHibernate is the implementation of PersonDAO, and we also need to tell it about the Person object.

Spring für das Person Objekt und die PersonDao konfigurieren [#5]

First, we need to tell Spring where the Hibernate mapping file is located. To do this, open src/dao/**/dao/hibernate/applicationContext-hibernate.xml and add "Person.hbm.xml" to the following code block.

Now we need to add some XML to this file to bind PersonDaoHibernate to PersonDao. To do this, add the following at the bottom of the file:

You could also use autowire="byName" to the <bean> and get rid of the "sessionFactory" property. Personally, I like having the dependencies of my objects documented (in XML).

Den DaoTest ausführen [#6]

Yeah Baby, Yeah: BUILD SUCCESSFUL
Total time: 9 seconds

Next Up: Part II: Creating new Managers - A HowTo for creating Business Facades, which are similar to Session Facades, but don't use EJBs. These facades are used to provide communication from the front-end to the DAO layer.