用hbm2java生成Hibernate类

核心提示： 对于治理Hiberante 映射文件，现有多种策略，用hbm2java生成Hibernate类， 如： · 一切手工编写 · 把xdoclet标记放在你的java 类中， 让其生成相应的映射文件，Ant任务需要在类路径（class path）中查找以下的.jar 文件：· hiber

　　对于治理Hiberante 映射文件，现有多种策略， 如：
　　· 一切手工编写
　　· 把xdoclet标记放在你的java 类中， 让其生成相应的映射文件。
　　· 从SQL 模式（schema）生成Hibernate 映射文件和Java类。
　　·　手工编写Hibernate 映射文件， 并且从Hibernate 映射生成Java类和SQL模式。
　　·　基于给定的SQL 模式，手工编写Hibernate 映射文件，并利用hbm2java工具生成Java类。

　　在本文中, 我们会着眼于上述方法中的最后那种方法。尽管这样的选择通常只是约略的尝试， 但此方法的确在多数情况下有许多优势：

　　·　Hibernate 映射集中在映射文件中，而不是把这些信息散布在Java源代码中，这使维护变得更加轻易。在某些情况下，XDoclet annotation 不支持所有在Hibernate映射模式中可用的功能，你还可通过映射获得更好的控制。

　　· 数据库模式可分开来维护，而不是从Java 类或Hibernate映射文件生成。这答应那些对Java/Hibernate不甚了解的数据库治理员（DBA）对数据库细节（索引，表空间，表类型等）本身有更好的控制。

　　由映射文件生成Java类

　　这种方式下，Hibernate映射文件主导着一切。所有的映射信息都集中在这些文件中， 就意味着不会在源代码中使用annotations。所有的持久化类都由hbm2java工具生成。之后，那些类就不能被修改。
此过程如图1所示。首先，你持有一组Hibernate映射文件。你或许也需要一个hbm2java配置文件，通常称之为hbm2java.xml。利用这两个引子，hbm2java工具为每个Hibernate映射文件生成一个或多个Java类。hbm2java配置文件对类生成过程的优化是有用的。

　　图1.用hbm2java工具将Hibernate映射生成Java类

　　　　
　　一个简单类生成的例子

　　让我们从一个非常简单的例子开始。假设我们想映射一个BOOK的简单数据库表，表结构定义如下：

Column　　　　　　　　　 Type　　　　　　　　　 Modifiers
------------+-----------------------+-----------
BOOK_ID　　　 character(32)　　　　　　 not null
BOOK_TITLE character varying(80) not null
BOOK_ISBN　 character varying(20) not null

　　为了生成这个类， 我们可以使用以下的Hiberante映射文件。注重怎样利用元属性（meta-attriute）来添加注释或优化类的生成。

　　
　　　　
　　　　　　A Book business object.
　　　　　　@author Duke
　　　　
　　　　
　　　　　　
　　　　　　
　　　　

　　　　
　　　　
　　　　　　
　　　　　　The unique ISBN code for this book.
　　　　　　
　　　　
　　

　　使用此映射文件，hbm2java会生成看起来象这样的类:

/**
 * A Book business object.
 * @author Duke
 */
public class Book {

　　PRivate String id;
　　private String name;
　　private String isbn;

　　public Book() {
　　}

　　public String getId() {
　　　　return id;
　　}

　　private void setId(String id) {
　　　　this.id = id;
　　}

　　public String getName() {
　　　　return name;
　　}

　　public void setName(String name) {
　　　　this.name = name;
　　}

　　/**
　　 * The unique ISBN code for this book.
　　 */
　　public String getIsbn() {
　　　　return isbn;
　　}

　　public void setIsbn(String isbn) {
　　　　this.isbn = isbn;
　　}
}

　　　　

　　为实际项目生成类

　　实际上，hbm2java被设计成用来把Hibernate映射文件转化成一组相应的Java类。假如你想在实际的应用程序中使用这种方法，很显然，对于所有的Hibernate映射文件一次性生成类会更为方便。最好的方法是把类生成结合进你的自动化构建过程中。结合进Ant构建过程中使用Ant调用hbm2java是相当直接的。首先，你需要申明hbm2java任务（task）以便Ant可以调用它：
　

　　 　　　　　　　　classname="net.sf.hibernate.tool.hbm2java.Hbm2JavaTask"
　　　　　　　　classpathref="project.class.path"/>

　
　　接着，你要用到这个任务。例如，通过写一个目标（target）将源目录中的所有*.hbm.xml文件生成源代码。假设${src.hibernate}表示含有Hibernate映射文件的目录，${src.generated}就是你想放源代码的地方。这样Ant任务看起来就象是:

　　　 　　　　　　　 description="Generate Java source code
　　　　　　　　　　　　　　from the Hibernate mapping files">
　　　　 
　　　　　 
　　　　　　 
　　　　　 
　　　　 
　　　 

　
　　用Maven 1 定制构建过程

　　为结合进Maven (　1.0)构建过程，你需要修改maven.xml文件。Maven代码就存放在这个文件中。脚本（script）主要检查了Hibernate映射文件自上次类生成后是否已被更改（使用uptodate 标记），假如没有，就调用此前所描述的Ant中的hbm2java任务。这种情况下，我们做了以下的假设：

　　·　hbm2java.xml配置文件应在src/hibernate目录中
　　·　Hibernate映射文件应在src/hibernate目录中
　　·　在src/generated/src/java目录下生成Java类
　

　　

　　
　　　　
　　

　　　　　　　　　targetfile="${maven.src.dir}/generated/hbm.jar">
　　　 
　　

　　　　　　　 value="${hibernateBuild.uptodate}"/>

　　
　　　　
　　　　　　　
　　　　
　　　　
　　　　　　　

　　　　　　　　　　　　　　　　　　　　 classname="net.sf.hibernate.tool.hbm2java.Hbm2JavaTask"
　　　　　　　　　　　　　 classpathref="maven.dependency.classpath"/>

　　　　　　　　　　　　　　　　　　　　　output="${maven.src.dir}/generated/src/java" >
　　　　　　　　　
　　　　　　　　　　　
　　　　　　　　　
　　　　　　　

　　　　　　　
　　　　　　　　　
　　　　　　　
　　　　
　　

　

　　用Maven 2 定制构建过程

　　若碰巧你正使用Maven 2，事情就更简单一点了。把maven-antrun-plugin插件添加到pom.xml文件中，而不是在maven.xml文件中使用完整的goals属性（pre and post goals）。在此插件中的task那部分，你可以象上述那样直接调用Ant 任务。

　4.0.0
　...
　
　　...
　　
　　　 
　　　　　maven-antrun-plugin
　　　　　
　　　　　　
　　　　　　　generate-sources
　　　　　　　
　　　　　　　　
　　　　　　　　　　　　　　　　　　　　　　 classname="org.hibernate.tool.ant.HibernateToolTask"
　　　　　　　　　　　　　 classpathref="maven.dependency.classpath"/>

　　　　　　　　　
　　　　　　　　　　　
　　　　　　　　　　　　　
　　　　　　　　　　　
　　　　　　　　　
　　　　　　　　
　　　　　　　
　　　　　　　
　　　　　　　　run
　　　　　　　
　　　　　　
　　　　　
　　　　
　　 
　

　
　　　　
　　在Hibernate 3中使用hbm2java

　　Hbm2java 工具已经经受了Hibernate 3 的考验。hbm2java任务与其它相似的任务一起，被集成进了新版Hibernate 工具集中的hibernatetool任务（撰写此文时仍是alpha版）。Ant任务需要在类路径（class path）中查找以下的.jar 文件：

　　·　 hibernate-tools.jar
　　·　 velocity-1.4.jar
　　·　 velocity-tools-generic-1.4.jar
　　·　 jtidy-r8-21122004.jar
　　·　　hibernate3.jar
　　·　 JDBC drivers

　　这样一来，Ant任务就要作如下申明：

　　　　　　classname="org.hibernate.tool.ant.HibernateToolTask"
　　　　classpathref="maven.dependency.classpath"/>

　　最后，你在hibernatetool 任务中调用hbm2java任务，做法如下：
　

　　　　　　classname="org.hibernate.tool.ant.HibernateToolTask"
　　　　classpathref="maven.dependency.classpath"/>