Eclipse快速上手Hibernate--3. 利用XDoclet开发

这篇文章是上两篇文章《Eclipse快速上手Hibernate--1. 入门实例》和《Eclipse快速上手Hibernate--2. 利用Hbm映射文件开发》的延续，主要说的是如何利用XDocletHbm映射文件产生Hbm映射文件及数据表。可以参考XDoclet文档中关于Hibernate的部分和夏昕编写的《Hibernate开发指南》。同样，这篇文章没有过多谈理论，只是给出了一个完整的实例加以说明。相关配置请参考上两篇文章。

1. 创建项目

· 新建一个Java项目：HibernateBegin_3，注意选中“创建单独的源文件夹和输出文件夹”，同时添加“用户库”：hibernate。

2. 文件User.java

· 新建一个类，包名：javamxj.hibernate，类名：User。然后在生成的代码中添加变量，再利用“生成 Getter 和 Setter”，具体方式同《Eclipse快速上手Hibernate--1. 入门实例 》文章中的编辑User.java的方式一样。

· 添加HibernateDoclet标记，关于如何利用JBoss-IDE添加XDoclet标记的技巧参考《Eclipse快速上手EJB -- 1. Lomboz + JBoss-IDE 配置2 》文中的关于JBoss-IDE的部分，这是添加HibernateDoclet后的代码：

User.java

/*
* 采用HibernateDoclet开发一个简单的Hibernate实例
* 创建日期 2005-3-31
* @author javamxj（分享java快乐）
* @link  Blog: htpp://javamxj.mblogger.cn
*              htpp://blog.csdn.net/javamxj/
*/
package javamxj.hibernate;

/**
* @hibernate.class table = "UserTable3"
*/
public class User {
private int id;
private String username;
private String password;

/**
* @hibernate.id
*   column = "ID"
*   generator-class = "hilo"
*/
public int getId() {
return id;
}
public void setId(int id) {
this.id = id;
}

/**
* @hibernate.property
*    length = "24"
*    not-null = "true"
*/
public String getPassword() {
return password;
}

public void setPassword(String password) {
this.password = password;
}

/**
* @hibernate.property
*    column = "用户名"
*    length = "24"
*    not-null = "true"
*/
public String getUsername() {
return username;
}
public void setUsername(String username) {
this.username = username;
}
}

· 添加类标记“ @hibernate.class table ="UserTable3" ”用来生成数据库的表UserTable3。
· “ @hibernate.id"用来生成主键，注意这里采用是hilo（高低位）生成器，需要额外的数据库表保存主键生成历史状态。
· “ @hibernate.property”描述POJO中属性与数据库表字段之间的映射关系。

● 更新xdoclet-hibernate-module
· 将XDoclet1.2.2中的xdoclet-hibernate-module-1.2.2.jar复制到JBossIDE-1.4.1-e30/eclipse/plugins/org.jboss.ide.eclipse.xdoclet.core_1.4.1目录中，并且删除其目录下的xdoclet-hibernate-module-1.2.1.jar文件，然后在eclipse界面中，窗口 ->首选项 ->JBoss-IDE ->XDoclet ->Code Assist：点击右侧的“Refresh XDoclet Data”栏，即可完成更新。如果要替换其它的模块，步骤与此类似。

3. 项目结构

· 将上篇文章中的“build.xml”复制到项目根目录下，配置文件“hibernate.cfg.xml”复制到src目录下，这时的项目结构如图：



4. 运行任务

· 双击“generate-hbm”任务，然后按一下“F5”功能键刷新一下包“javamxj.hibernate”，应该可以看到这个包下的“User.hbm.xml”。文件如下：

User.hbm.xml

<?xml version="1.0" encoding="GBK"?>

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

<hibernate-mapping
>
<class
name="javamxj.hibernate.User"
table="UserTable3"
dynamic-update="false"
dynamic-insert="false"
select-before-update="false"
optimistic-lock="version"
>

<id
name="id"
column="ID"
type="int"
>
<generator class="hilo">
<!--
To add non XDoclet generator parameters, create a file named
hibernate-generator-params-User.xml
containing the additional parameters and place it in your merge dir.
-->
</generator>
</id>

<property
name="password"
type="java.lang.String"
update="true"
insert="true"
access="property"
column="password"
length="24"
not-null="true"
/>

<property
name="username"
type="java.lang.String"
update="true"
insert="true"
access="property"
column="用户名"
length="24"
not-null="true"
/>

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

</class>

</hibernate-mapping>

● 生成数据表
· 启动MySql，应该确定含有HibernateTest数据库，不过这次不需要建立数据表了。
· 双击“schemaexport”任务，然后刷新项目根目录，会发现出产生的“schema-export.sql”文件。

schema-export.sql

drop table if exists UserTable3 drop table if exists hibernate_unique_key create table UserTable3 ( ID integer not null, password varchar(24) not null, 用户名 varchar(24) not null, primary key (ID) ) create table hibernate_unique_key ( next_hi integer ) insert into hibernate_unique_key values ( 0 )

· 切换到数据库中，会发现已经自动产生了数据表usertable3和hibernate_unique_key：



5. 测试程序

好了，将上篇文章中的test.java文件复制到包“javamxj.hibernate”下，然后右击运行这个文件，可以看到数据表中生成的数据(图中的数据是连续运行4次后产生的)。



6. Log4j

Log4j是一个开放源码的项目。它允许开发员以任意的间隔来控制日志的输出。它通过设在外部的配置文件而达到运行时灵活的设置。

运行Log4j的库文件都已经放到先前建立的hibernate库文件夹中了，你只要找到下载的hibernate 2.1.8压缩文件中的etc目录，复制其中的log4j.properties文件到项目中的src目录即可。

运行test.java，可以看到控制台的输出语句似乎和先前没有用Log4j没有什么区别。

现在打开log4j.properties，找到“log4j.logger.net.sf.hibernate=info”语句，将其改成“log4j.logger.net.sf.hibernate=warn”，再次运行test.java，可以看到控制台的输出语句只有两条了
：
21:03:55,687 WARN Configurator:125 - No configuration found. Configuring ehcache from ehcache-failsafe.xml found in the classpath: jar:file:/D:/java/Hibernate/lib/ehcache-0.9.jar!/ehcache-failsafe.xml
Hibernate: insert into UserTable3 (password, 用户名, ID) values (?, ?, ?)
警告信息是指缓存配置文件没有找到，以后用到时再谈谈这一点。

好了，hibernate结合Log4j的使用就是这么简单。
关于Log4j的使用，比较简单，网上的资料也很多，自己可以google一下。

小结：

Hibernate的开发相当灵活，可以采用多种方式开发。

· 只有Hbm映射文件：映射文件---hbm2java----java---SchemaExport----数据表
· 只有Java： java---XDoclet---Hbm----SchemaExport----数据表
· 如果只有数据表呢？可以采用Middlegen：
数据表---Middlegen---Hbm----hbm2java----java
关于利用Middlegen开发Hibernate的方法，可以参考夏昕编写的《Hibernate开发指南》。

· 至于有关Hibernate的Eclipse插件，也有很多，可以看看《Working with Hibernate in Eclipse》。