CreateDAO

This is version 6. It is not the current version, and thus it cannot be edited.
[Back to current version]   [Restore this version]

About this Tutorial

We will create an object and then some more classes to persist (save/retrieve/delete) that object from the database. In Java speak, we call the object a Plain Old Java Object (a.k.a. a POJO). This object basically represents a database table. The other classes will be:

• A Data Access Object (a.k.a. a DAO), an Interface and a Hibernate Implementation
• A JUnit class to test our DAO is working

AppFuse uses Hibernate for it's persistence layer. Hibernate is an Object/Relational (O/R) Framework that allows you to relate your Java Objects to database tables. It allows you to very easily perform CRUD (Create, Retrieve, Update, Delete) on your objects.

I will tell you how I do stuff in the Real World in text like this.

Let's get started on creating a new Object, DAO and Test in AppFuse's architecture.

Table of Contents

• [1] Create a new Object and add XDoclet tags
• [2] Create a new database table from the object using Ant
• [3] Create a new DaoTest to run JUnit tests on your DAO
• [4] Create a new DAO to perform CRUD on the object
• [5] Notify Hibernate that this object exists in ServiceLocator (for tests) and in hibernate.cfg.xml (for webapp)
• [6] Run the DaoTest

Create a new Object and add XDoclet tags [#1]

package org.appfuse.persistence;

public class Person extends BaseObject {
	private Long id;
	private String firstName;
	private String lastName;

	/*
	 * Generate your getters and setters using your favorite IDE: 
         * In Eclipse:
	 *   Right-click -> Source -> Generate Getters and Setters
	 */
}

I usually open an existing object (i.e. User.java or Resume.java) and save it as a new file. Then I delete all the methods and properties. This gives me the basic JavaDoc header. I'm sure I could edit Eclipse templates to do this, but since I develop on 3 different machines, this is just easier.

In the code snippet above, we're extending BaseObject because it has the following useful methods: toString(), equals(), hashCode() - the latter two are required by Hibernate.

Now that we have this POJO created, we need to add XDoclet tags to generate the Hibernate mapping file. This mapping file is used by Hibernate to map objects → tables and properties (variables) → columns.

First of all, we add a @hibernate.class tag that tells Hibernate what table this object relates to:

/**
 * @author mraible
 * @hibernate.class table="person"
 */
public class Person extends BaseObject {

We also have to add a primary key mapping or XDoclet will puke when generating the mapping file. Note that all @hibernate.* tags should be placed in the getters' Javadocs of your POJOs.

    /**
     * @return Returns the id.
     * @hibernate.id column="id"
     *  generator-class="native" unsaved-value="null"
     */
    public Long getId() {
        return this.id;
    }

I try to remember to add the Person object to ServiceLocator.java and hibernate.cfg.xml at this point. This is covered in [step 5].

Create a new database table from the object using Ant [#2]

[schemaexport] create table person (
[schemaexport]    id BIGINT NOT NULL AUTO_INCREMENT,
[schemaexport]    primary key (id)
[schemaexport] )

If you want to look at the Person.hbm.xml file that Hibernate generates for you, look in the build/ejb/gen/**/persistence directory. Here's the contents of Person.hbm.xml (so far):

<?xml version="1.0"?>

<!DOCTYPE hibernate-mapping PUBLIC
    "-//Hibernate/Hibernate Mapping DTD 2.0//EN" 
    "http://hibernate.sourceforge.net/hibernate-mapping-2.0.dtd">

<hibernate-mapping>
    <class
        name="org.appfuse.persistence.Person"
        table="person"
        dynamic-update="false"
        dynamic-insert="false"
    >

        <id
            name="id"
            column="id"
            type="java.lang.Long"
            unsaved-value="null"
        >
            <generator class="native">
            </generator>
        </id>

        <!--
            To add non XDoclet property mappings, create a file named
                hibernate-properties-Person.xml
            containing the additional properties and place it in your merge dir.
        -->

    </class>

</hibernate-mapping>

Now we'll add additional @hibernate.property tags for our other columns (firstName, lastName):

    /**
     * @return Returns the firstName.
     * @hibernate.property column="first_name"
     */
    public String getFirstName() {
        return this.firstName;
    }

    /**
     * @return Returns the lastName.
     * @hibernate.property column="last_name"
     */
    public String getLastName() {
        return this.lastName;
    }

Run "ant setup-db" again to get the additional columns added to your table.

[schemaexport] create table person (
[schemaexport]    id BIGINT NOT NULL AUTO_INCREMENT,
[schemaexport]    first_name VARCHAR(255),
[schemaexport]    last_name VARCHAR(255),
[schemaexport]    primary key (id)
[schemaexport] )

Create a new DaoTest to run JUnit tests on your DAO [#3]

To start, create a PersonDaoTest.java class in the test/ejb/**/persistence directory. This class should extend BaseDaoTestCase, which already exists in this package. This parent class is mainly used for automatically 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 "rd" 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.

package org.appfuse.persistence;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

public class PersonDaoTest extends BaseDaoTestCase {
    
    //~ Instance fields ========================================================
    private Log log = LogFactory.getLog(PersonDaoTest.class);
    private Person person = null;
    private PersonDao dao = null;

    //~ Constructors ===========================================================
    public PersonDaoTest(String name) {
        super(name);
    }

    //~ Methods ================================================================
    protected void setUp() throws Exception {
        super.setUp();
        dao = (PersonDao) DAOFactory.getInstance(conn, PersonDao.class);      
    }

    protected void tearDown() throws Exception {
        dao = null;
        super.tearDown();
    }

    public static void main(String[] args) {
        junit.textui.TestRunner.run(PersonDaoTest.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:

    public void testGetPerson() throws Exception {
       person = new Person();
       person.setFirstName("Matt");
       person.setLastName("Raible");
				
       dao.savePerson(person);
       dao.getPerson(person.getId());
       log.info(person);
       assertTrue(person.getFirstName() != null);
    }

    public void testSavePerson() throws Exception {
        person = dao.getPerson(new Long(1));
        person.setFirstName("Matt");
        person.setLastName("Last Name Updated");

        dao.savePerson(person);

        if (log.isDebugEnabled()) {
            log.debug("updated Person: " + person);
        }

        assertTrue(person.getLastName().equals("Last Name Updated"));
    }

    public void testAddAndRemovePerson() throws Exception {
        person = new Person();
        person.setFirstName("Bill");
        person.setLastName("Joy");

        dao.savePerson(person);
        
        assertTrue(person.getFirstName().equals("Bill"));
        assertTrue(person.getId() != null);

        if (log.isDebugEnabled()) {
            log.debug("removing person...");
        }

        dao.removePerson(person);
    }

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 our 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>firstName</column>
    <column>lastName</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 the PersonDaoTest.java file and define your property values inside it:

firstName=Matt
lastName=Raible

person = new Person();
person = (Person) populate(person);

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.

Create a new DAO to perform CRUD on the object [#4]

package org.appfuse.persistence;

public interface PersonDao extends Dao {

    public Person getPerson(Long personId) throws DAOException;

    public void savePerson(Person Person) throws DAOException;

    public void removePerson(Person Person) throws DAOException;
}

The ant task for running tests is called "test-module." 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 squash that bug and create 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/ejb/**/persistence and name it PersonDAOHibernate.java. It should extend BaseDaoHibernate and implement PersonDAO.

package org.appfuse.persistence;

import net.sf.hibernate.Session;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

public class PersonDaoHibernate extends BaseDaoHibernate implements PersonDao {
    
    private Log log = LogFactory.getLog(PersonDaoHibernate.class);

    public PersonDaoHibernate(Object conn) {
        this.ses = (Session) conn;
    }

    public Person getPerson(Long id) throws DAOException {
        return (Person) retrieveObject(ses, Person.class, id);
    }

    public void savePerson(Person person) throws DAOException {
        storeObject(ses, person);
    }

    public void removePerson(Person user) throws DAOException {
        removeObject(ses, Person.class, user.getId(), user);
    }
}

Notify Hibernate that this object exists [#5]

sf = new Configuration().addClass(Person.class)
                        .addClass(Role.class)
                        .addClass(UserRole.class)
                        .addClass(User.class).buildSessionFactory();

    <mapping resource="org/appfuse/persistence/Person.hbm.xml"/>
    <mapping resource="org/appfuse/persistence/Role.hbm.xml"/>
    <mapping resource="org/appfuse/persistence/User.hbm.xml"/>
    <mapping resource="org/appfuse/persistence/UserRole.hbm.xml"/>

Run the DaoTest [#6]

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