CreateDAO_zh

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

关于本教程

我们将建立一个对象以及处理（保存/检索/删除）这些类到数据库的一些代码。用Java术语，我们叫它Plain Old Java Object(a.k.a. a POJO)。这个对象通常代表了数据库中的一个表，其他的类包括:

• 一个数据访问对象Data Access Object (a.k.a. a DAO), 一个 Interface和一个Hibernate实现
• 一个 JUnit 类来测试我们的DAO对象

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

AppFuse使用Hibernate 作为持久化层， Hibernate是一套对象/关系Object/Relational (O/R)框架，他允许你把Java对象和数据库之间联系起来，它可以很方便的对你的对象执行CRUD (Create, Retrieve, Update, Delete)操作。

你也可以选择使用iBATIS作为持久化层，如果要在AppFuse里安装iBATIS， 请查看extras/ibatis中的README.txt。如果你选择iBATIS而不是Hibernate， 希望你有自己的原因并且熟悉这个框架，我也希望你能够领会到如何将教程应用到iBATIS ;-)

字体惯例 (进行中)

要在命令行下执行的命令是这个样子: ant test-all.

对目录或者包中的文件的引用是这个样子: build.xml.

我在“真实世界”中实际操作的方式用蓝色斜体表示。

让我们继续在AppFuse项目的结构下创建一个新的对象、DAO和测试。

目录

• [1] 建立一个对象，并且作XDoclet标记
• [2] 使用Ant根据对象建立数据库中的表
• [3] 创建一个DaoTest来运行DAO对象的JUnit测试
• [4] 创建一个新的DAO来执行关于这个对象的CRUD操作
• [5] 在spring里配置Person和PersonDao
• [6] 运行DaoTest

建立一个对象，并且作XDoclet标记 [#1]

我们要做的第一件事情就是建立一个需要持久化的对象，我们要在src/dao/**/model目录下建立一个简单的Person对象，这个对象包括id、firstName和lastName属性。

注意： 直接拷贝本教程的代码 在FireFox下无效，但我们可以通过CTRL+Click选定一个代码所在的工作区(OS X下是Command+Click)，然后再拷贝。

这个类必须扩展BaseObject，而这个BaseObject有三个抽象方法(equals(), hashCode()和toString())需要你在Person类里实现，前两个是Hibernate的需要。为了完成这部分工作最简单的方式是使用Commonclipse，关于这个工具更多的信息可以在Lee Grey的网站里看到，另外一个你可以使用的Eclipse的插件是Commons4E，我还没有使用过，这里不便对其功能作出评论。

如果你使用IntelliJ IDEA，你可以自动产生equals()和hashCode()，但没有toString()，有一个 ToStringPlugin插件做得非常不错

现在我们已经创建了这个POJO对象，我们需要增加XDoclet标记来产生Hibernate的映射文件，这些文件用来映射对象→ 表和属性(变量) → 字段。

首先，我们增加@hibernate.class 来告诉Hibernate我们将要和那个表作关联：

我们也要增加主键的映射,否则XDoclet会在产生映射文件时出错,注意所有的@hibernate.*标签必须在getters'的Javadocs里面。

我使用generator-class="increment"而不使用generate-class="native" 是因为我对数据库使用"native"时发现了一些问题，如果你只是希望使用MySQL，推荐使用"native"值，本教程使用increment。

使用Ant根据对象产生数据库表[#2]

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

如果你查看Hibernate生成的文件Person.hbm.xml，可以到build/dao/gen/**/model目录，这里是Person.hbm.xml的内容(目前的内容):

现在我们要为其它的字段(first_name, last_name)添加额外的@hibernate.property标签：

在这个例子里，添加column属性的唯一原因是因为这个字段名与它的属性名不相同，如果他们相同，你没有必要来指定column属性，关于其它可以使用的标签请看@hibernate.property。

再次运行ant setup-db把新加的属性加到数据库表里。

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

如果期望修改字段的长度，修改@hibernate.property标签的length属性，如果希望把字段改为必添字段(NOT NULL)，可以增加属性not-null="true"。

建立新的DaoTest来对你的DAO运行JUnit测试[#3]

现在，我们要创建一个DaoTest来测试我们的DAO的工作，“等会儿”，你说，“我们还不曾创建DAO呢！”，你说得对。无论如何，我发现测试驱动开发大大的促进了软件质量，在许多年里我一直认为在写代码之前写测试是胡说八道，这看起来很愚蠢，但当我尝试之后我认为这样非常好，现在我按照测试驱动的方式工作完全因为我发现这样可以大大提高我软件开发的效率。

开始，我们在test/dao/**/dao目录下建立类PersonDaoTest.java，这个类必须扩展BaseDaoTestCase，而BaseDAOTestCase这个类是JUnit类TestCase的子类，这个类用来加载Spring的ApplicationContext（因为Spring把各个层绑定）和单元测试类同一目录下同你的测试类文件同名的.properties文件（ResourceBundle），这个属性文件的属性可以通过“rb”属性来访问。

我经常拷贝(打开→另存为)一个已存在的测试(如UserDaoTest.java)，然后查找/替换 [Uu]ser为[Pp]erson，或者任何其它需要替换的内容。

以上是我们使用JUnit测试而初始化和销毁PersonDao的基本代码，对象“ctx”引用了Spring的ApplicationContext，它在BaseDaoTestCase类的静态代码区里被初始化。

现在我们需要实际测试DAO中的CRUD(create, retrieve, update, delete)方法，为此我们需要为每个方法建立以test（全部小写）开头的测试方法，只要这个方法是公共的，返回类型是void,它们就会被我们build.xml中的Ant的<junit>任务调用，如下是一些简单的CRUD测试，需要注意的一点是所有的方法（或者叫做测试）必须是自治的，添加如下代码到文件PersonDaoTest.java：

在testGetPerson方法，我们创建了一个person并且调用get方法，我通常会增加一条我所需要的记录到数据库，因为在测试运行之前DBUnit会为数据库准备测试数据，我们可以简单的在metadata/sql/sample-data.xml里添加测试所必须的记录

<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>

通过这种方式你可以在testGetPerson方法里消除创建新纪录的动作，如果你愿意直接插入记录到数据库（使用SQL或者GUI），你可以用ant db-export和cp db-export.xml metadata/sql/sample-data.xml重新构建你的sample-data.xml文件。

在上面的例子里，你可以看到我们调用person.set*(value)来准备我们需要保存的对象，在这个例子里很简单，但是当你要插入10条必添字段(not-null="true")时就比较麻烦了，这就是我为什么要在BaseDaoTestCase使用ResourceBundle文件，只要在PersonDaoTest.java同一个目录创建一个PersonDaoTest.properties并且在里面定义你的属性值：

我通常只是在Java里硬编码，但是这个.properties对于大对象很有用。

firstName=Matt
lastName=Raible

在目前情况下，还不可以编译PersonDaoTest，因为在类路径里还没有PersonDao.class，我们需要创建它。PersonDAO.java是一个接口，PersonDAOHibernate.java是它的Hibernate实现，让我们继续，开始创建。

创建一个对对象执行CRUD操作的新DAO[#4]

注意，在以上的方法声明上并没有exceptions说明，这是因为Spring使用RuntimeExceptions来包裹Exceptions的方式，此时，你已经可以使用ant compile-dao来编译src/dao和test/dao下的所有源文件，然而当你运行ant test-dao -Dtestcase=PersonDao进行测试时，你会得到一个错误：No bean named 'personDao' is defined，这是一个Spring的错误，说明你必须在applicationContext-hibernate.xml指定一个名字为personDAO的bean，在此之前我们需要创建PersonDao的实现类。