陳亞強 (cyqcims@mail.tsinghua.edu.cn)
北京華園天一科技有限公司高級軟件工程師
2003 年 10 月
對象、關系的映射（ORM）是一種耗時的工作，在Java環(huán)境下，有幾種框架來表示持久數(shù)據(jù)，如實體Bean、OJB、JDO、Hibernate等。Hibernate是一種新的ORM映射工具，它不僅提供了從Java類到數(shù)據(jù)表的映射，也提供了數(shù)據(jù)查詢和恢復等機制。本文介紹怎么在Web應用開發(fā)中配置Hibernate的環(huán)境，并且使用Hibernate來開發(fā)一個具體的實例。
閱讀本文前您需要以下的知識和工具：
本文的參考資料見 參考資料。
介紹
面向對象的開發(fā)方法是當今的主流，但是同時我們不得不使用關系型數(shù)據(jù)庫，所以在企業(yè)級應用開發(fā)的環(huán)境中，對象、關系的映射（ORM）是一種耗時的工作。圍繞對象關系的映射和持久數(shù)據(jù)的訪問，在Java領域中發(fā)展起來了一些API和框架，下面分別簡單介紹。
JDBC可以說是訪問持久數(shù)據(jù)層最原始、最直接的方法。在企業(yè)級應用開發(fā)中，我們可能使用DAO（Data Access Object）模式來把數(shù)據(jù)訪問封裝起來，然后在其它的層中同一調用。這種方式的優(yōu)點是運行效率最高，缺點是把DAO對象和SQL語言緊密耦合在一起使得在大項目中難以維護。但是不管怎么說，使用JDBC來直接訪問持久數(shù)據(jù)層是當今企業(yè)級應用開發(fā)中使用最廣泛的。
實體Bean是J2EE平臺中用來表示和訪問持久數(shù)據(jù)的方式。雖然實體Bean是一種方便快捷的方法，但是在運行時我們需要額外購買EJB容器（當然，如今也有免費的EJB容器，如JBOSS），并且使用不同的應用服務器，需要重新書寫不同的部署描述，使得在不同應用服務器下移植企業(yè)級應用會帶來一些困難。
另外，在Java領域中，還有一些表示持久數(shù)據(jù)的框架，比如JDO和OJB，在這里就不詳細介紹了。
Hibernate是一種新的ORM映射工具，它不僅提供了從Java類到數(shù)據(jù)表之間的映射，也提供了數(shù)據(jù)查詢和恢復機制。相對于使用JDBC和SQL來手工操作數(shù)據(jù)庫，使用Hibernate，可以大大減少操作數(shù)據(jù)庫的工作量。
Hibernate可以和多種Web服務器或者應用服務器良好集成，如今已經支持幾乎所有的流行的數(shù)據(jù)庫服務器（達16種）。
下面我們來介紹怎么結合Hibernate2.0和Apache Tomcat5.0在Web應用中使用Hibernate。
配置
1、 下載安裝Tomcat，并且下載Hibernate的運行環(huán)境（主要包含一些JAR包）。
2、 把要使用的數(shù)據(jù)庫的JDBC驅動程序拷貝到%TOMCAT_HOME%\common\lib目錄下。筆者使用的是MYSQL，對應的驅動程序的JAR包為mm.mysql-2.0.4-bin.jar。
3、 在Tomcat的Webapps目錄下新建一個Web應用，名字為hibernate。
4、 把Hibernate提供的hibernate2.jar和一些第三方的運行庫拷貝到hibernate\WEB\INF\lib目錄下。（這些第三方的運行庫包含在下載的Hibernate lib目錄下）
5、 在%TOMCAT_HOME%\conf\server.xml中Web應用和數(shù)據(jù)源。在server.xml中加入以下的配置描述。
例程1 配置web應用
<Context path="/hibernate" docBase="hibernate" debug="0" reloadable="true" crossContext="true">
<Resource name="jdbc/hibernate" auth="Container" type="javax.sql.DataSource"/>
<ResourceParams name="jdbc/hibernate">
<parameter>
<name>factory</name>
<value>org.apache.commons.dbcp.BasicDataSourceFactory</value>
</parameter>
<parameter>
<name>driverClassName</name>
<value>org.gjt.mm.mysql.Driver</value>
</parameter>
<parameter>
<name>url</name>
<value>jdbc:mysql:///test</value>
</parameter>
<parameter>
<name>username</name>
<value>root</value>
</parameter>
<parameter>
<name>password</name>
<value></value>
</parameter>
<parameter>
<name>maxActive</name>
<value>20</value>
</parameter>
<parameter>
<name>maxIdle</name>
<value>10</value>
</parameter>
<parameter>
<name>maxWait</name>
<value>-1</value>
</parameter>
</ResourceParams>
</Context>
|
在這里，配置了一個名為hibernate的Web應用，并且配置了一個數(shù)據(jù)源，數(shù)據(jù)源的JNDI名稱為jdbc/hibernate。您需要根據(jù)情況修改數(shù)據(jù)源的鏈接屬性。
6、 下一步就是書寫Hibernate的配置描述符?？梢允褂肵ML的配置描述，也可以使用基于屬性的配置描述。在這里使用基于XML的配置描述。在hibernate\WEB-INF\classes目錄下新建一個hibernate.cfg.xml文件。然后加入例程2所示的內容。
<!DOCTYPE hibernate-configuration
PUBLIC "-//Hibernate/Hibernate Configuration DTD//EN"
"http://hibernate.sourceforge.net/hibernate-configuration-2.0.dtd">
<hibernate-configuration>
<session-factory>
<property name="connection.datasource">java:comp/env/jdbc/hibernate</property>
<property name="show_sql">false</property>
<property name="dialect">net.sf.hibernate.dialect.MySQLDialect</property>
<!-- Mapping files -->
</session-factory>
</hibernate-configuration>
|
注意connection.datasource屬性必須和server.xml中配置的數(shù)據(jù)源的屬性一樣。如果不是使用MYSQL，那么需要更改dialect屬性。
到現(xiàn)在，配置基本完成，下面我們來開發(fā)一個最簡單的應用。
開發(fā)持久對象、編寫映射描述
我們使用hibernate來封裝一個簡單的數(shù)據(jù)表。這個表的名字為Courses，它有兩個字段，一個是ID，它是Courses表的主鍵；另一個是name，表示Courses的名字。在數(shù)據(jù)庫中使用以下的腳本來創(chuàng)建這個表：
create table Courses(CourseId varchar(32) not null, name varchar(32), constraint pk_Courses primary key (CourseId) );
接下來的任務就是為Courses表書寫持久對象，如例程3所示。
例程3 Courses的持久對象（Courses.java）
package com.hellking.study.hibernate;
import java.util.Set;
/**
*在hibernate中代表了Course表的類。
*/
public class Course
{
/**每個屬性和表的一個字段對應**/
private String id;
private String name;
/**students表示course中的學生，在后面才會用到，暫時不管**/
private Set students;
/**屬性的訪問方法**/
public void setId(String string) {
id = string;
}
public String getId() {
return id;
}
public void setName(String name)
{
this.name=name;
}
public String getName()
{
return this.name;
}
public void setStudents(Set stud)
{
this.students=stud;
}
public Set getStudents()
{
return this.students;
}
}
|
可以看出，在Course類中也包含了兩個屬性，id和name，它的屬性和表Courses的字段是一一對應的，并且類型一致。
書寫好了持久對象，接下來的任務就是書寫對象、關系映射描述。在hibernate\WEB-INF\classes目錄下新建一個Course.hbm.xml描述文件，內容如例程4所示。
例程4 Course.hbm.xml
<?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="com.hellking.study.hibernate.Course"
table="Courses"
dynamic-update="false"
>
<id
name="id"
column="CourseId"
type="string"
unsaved-value="any"
>
<generator class="assigned"/>
</id>
<property
name="name"
type="string"
update="true"
insert="true"
column="Name"
/>
</class>
</hibernate-mapping>
|
在Course.hbm.xml映射文件中，指定了要映射的類和映射的表，并且指定了表的各個字段和Java對象中各個字段的映射關系，比如Course對象中的id屬性對應了Courses表的courseId字段。
接下來的任務就是在hibernate.cfg.xml中指定這個映射關系。如下所示：
<session-factory>
…
<!-- Mapping files -->
<mapping resource="Course.hbm.xml"/>
</session-factory>
|
編寫業(yè)務邏輯
到此，我們已經封裝了一個名為Courses的表，并且配置完成。接下來的任務就是在Web應用開發(fā)中使用它們，為了演示在Hibernate中對數(shù)據(jù)庫的不同類型的操作，我們開發(fā)的Web應用有以下的功能：
- 增加一個Course；
- 刪除一個Course；
- 按照Course的名字進行模糊搜索；
- 查看系統(tǒng)中所有的Course。
雖然我們可以直接在JSP中使用hibernate，但是往往我們不這樣，而是把這些業(yè)務邏輯封裝在JavaBean中，然后在JSP中通過調用JavaBean以訪問Hibernate封裝的對象。
由于訪問通過使用hibernate有一些共性的操作，在這里我們把這些共性的操作封裝在一個專門的類中，這樣其它的類可以繼承它，如例程5所示。
例程5 HibernateBase.java
package com.hellking.study.hibernate;
import net.sf.hibernate.*;
import net.sf.hibernate.cfg.*;
import java.util.*;
import java.io.IOException;
import java.io.PrintWriter;
public abstract class HibernateBase
{
protected SessionFactory sessionFactory;//會話工廠，用于創(chuàng)建會話
protected Session session;//hibernate會話
protected Transaction transaction; //hiberante事務
public HibernateBase()throws HibernateException
{
this.initHibernate();
}
// 幫助方法
protected void initHibernate()
throws HibernateException {
// 裝載配置，構造SessionFactory對象
sessionFactory = new Configuration().configure().buildSessionFactory();
}
/**
*開始一個hibernate事務
*/
protected void beginTransaction()
throws HibernateException {
session = sessionFactory.openSession();
transaction = session.beginTransaction();
}
/**
*結束一個hibernate事務。
*/
protected void endTransaction(boolean commit)
throws HibernateException {
if (commit) {
transaction.commit();
} else {
//如果是只讀的操作，不需要commit這個事務。
transaction.rollback();
}
session.close();
}
}
|
下面編寫業(yè)務邏輯類，新建一個名為CourseBean的JavaBean，并且CourseBean繼承HibernateBase類，代碼如例程6所示。
例程6 CourseBean.java
package com.hellking.study.hibernate;
import net.sf.hibernate.*;
import net.sf.hibernate.cfg.*;
import java.util.*;
/**
*和course相關的業(yè)務邏輯
*/
public class CourseBean extends HibernateBase
{
public CourseBean()throws HibernateException
{
super();
}
/**
*增加一個Course
*/
public void addCourse(Course st)throws HibernateException
{
beginTransaction();
session.save(st);
endTransaction(true);
}
/**
*查詢系統(tǒng)中所有的Course，返回的是包含有Course持久對象的Iterator。
*/
public Iterator getAllCourses()throws HibernateException
{
String queryString = "select courses from Course as courses";
beginTransaction();
Query query = session.createQuery(queryString);
Iterator it= query.iterate();
return it;
}
/**
*刪除給定ID的course
*/
public void deleteCourse(String id)throws HibernateException
{
beginTransaction();
Course course=(Course)session.load(Course.class,id);
session.delete(course);
endTransaction(true);
}
/**
*按course的名字進行模糊查找，返回的是包含有Course持久對象的Iterator。
*/
public Iterator getSomeCourse(String name)throws HibernateException
{
String queryString = "select c from Course as c where c.name like :name" ;
beginTransaction();
Query query = session.createQuery(queryString);
query.setString("name", "%"+name+"%");
Iterator it= query.iterate();
return it;
}
}
|
在CourseBean封裝了4個業(yè)務方法，你可以根據(jù)情況增加其它的業(yè)務方法。在CourseBean中，通過Hibernate來操作潛在的數(shù)據(jù)庫資源。
要保存Course數(shù)據(jù)到數(shù)據(jù)庫，可以通過：
方法來保存，它相當于使用在JDBC中執(zhí)行以下語句：
Connection con=…
Statement stmt=con.createStatement();
stmt.executeUpdate("insert into courses values('"+course.getId(),+"','"+course.getName()+"')");
con.close();
|
可以看出，通過使用Hibernate，可以大大減少數(shù)據(jù)訪問的復雜度。
在JSP中調用業(yè)務邏輯
添加數(shù)據(jù)
CourseBean這個業(yè)務對象封裝了和Hibernate的交互關系，從而使JSP和Hibernate關系的解藕。我們來看測試主頁面的部分代碼，如例程7所示。
例程7 測試Hibernate開發(fā)的應用（course.jsp）
<%@ page import="java.sql.*,java.util.*" errorPage="error.jsp"%>
<jsp:useBean id="course" class="com.hellking.study.hibernate.Course" scope="page">
<jsp:setProperty name="course" property="*"/>
</jsp:useBean>
<jsp:useBean id="courseBusiness" class="com.hellking.study.hibernate.CourseBean" scope="page"/>
<html><body><center>
<%
try
{
if(course.getId().equals(null)||course.getId().equals(""));
else courseBusiness.addCourse(course);
%>
成功添加了Course：<br>
name：<%=course.getName()%>
Id:<%=course.getId()%>
<%
}
catch(Exception e)
{
}
%>
<hr>
<br>::增加一個course::<br>
<form action="course.jsp" method="get" name="add">
id:<input type=text name="id"><br>
name:<input type=text name="name"><br>
<input type=submit value="submit"><br>
</form>
<hr>
::按名字模糊查找::<br>
<form action="queryCourse.jsp" method="get" name="queryByName">
name:<input type=text name="name"><br>
<input type=submit value="query"><br>
</form>
<hr>
::刪除一個Course::<br>
<form action="deleteCourse.jsp" method="get" name="queryByName">
id:<input type=text name="id"><br>
<input type=submit value="delete"><br>
</form>
<hr>
<a href=viewAll.jsp>::查看所有Course::<a>
</body>
</html>
|
首先通過一個值對象Course（這個類正好是Hibernate使用的持久對象，這里作為值對象來傳遞數(shù)據(jù)）接收獲得的參數(shù)，然后CourseBean的addCourse(Course)方法把數(shù)據(jù)保存到數(shù)據(jù)庫?？梢钥闯?，通過使用Hibernate，把數(shù)據(jù)從表單中添加到數(shù)據(jù)庫非常簡單。
查詢
下面來看模糊查找的JSP代碼，如例程8所示。
例程8 按名字模糊查找Course
<%@ page import="java.sql.*,java.util.*,com.hellking.study.hibernate.Course" errorPage="error.jsp"%>
<jsp:useBean id="courseBusiness" class="com.hellking.study.hibernate.CourseBean" scope="page"/>
…
<% try
{
Iterator it=courseBusiness.getSomeCourse((String)request.getParameter("name"));
while(it.hasNext())
{
Course temp=(Course)it.next();
out.println("<tr><td>"+temp.getId()+"</td>");
out.println("<td>"+temp.getName()+"</td></tr>");
}
}
catch(Exception e)
{
out.println(e.getMessage());
}
%>
….
|
它實際上調用的是CourseBean的Iterator getSomeCourse(String name)方法。我們來回顧一下這個方法中的代碼：
/**
*按course的名字進行模糊查找
*/
public Iterator getSomeCourse(String name)throws HibernateException
{
String queryString = "select c from Course as c where c.name like :name" ;
beginTransaction();
Query query = session.createQuery(queryString);
query.setString("name", "%"+name+"%");
Iterator it= query.iterate();
return it;
}
|
在查詢前，首先調用beginTransaction方法啟動新的Hibernate事務，然后創(chuàng)建一個Query對象，在創(chuàng)建這個對象時，同時指定查詢的語句。
注意，在查詢語句：
select c from Course as c where c.name like :name"
|
中，它雖然和普通的SQL語句相似，但是不同，在數(shù)據(jù)庫中，使用的表的名字是Courses，而在這個查詢語句中使用的是Course，它和持久對象的名字一致，也就是說，這個查詢的概念是查詢持久對象，而不是數(shù)據(jù)庫的記錄。
創(chuàng)建了查詢對象Query后，需要設置查詢的參數(shù)，它和在JDBC中PreparedStatement對象中設置參數(shù)的方法相似。通過"Iterator it= query.iterate()"語句來執(zhí)行查詢，并且返回一個Iterator對象。在這里使用了Hibernate提供的查詢機制，一般的JDBC查詢返回的是ResultSet對象，而這里返回的是包含了CourseBean對象的Iterator。
要查詢系統(tǒng)中所有的Course，也同樣非常簡單，可以通過例程9所示的代碼實現(xiàn)。
例程9 查詢數(shù)據(jù)庫中所有的Course
…
<jsp:useBean id="courseBusiness" class="com.hellking.study.hibernate.CourseBean" scope="page"/>
…
<% try
{
Iterator it=courseBusiness.getAllCourses();
while(it.hasNext())
{
Course temp=(Course)it.next();
out.println("<tr><td>"+temp.getId()+"</td>");
out.println("<td>"+temp.getName()+"</td></tr>");
}
}
catch(Exception e)
{
out.println(e.getMessage());
}
%>
…
|
實際上調用的是CourseBean的getAllCourses方法，它和getSomeCourse方法機制一樣，就不再介紹了。
刪除數(shù)據(jù)
在JSP中，使用以下的代碼來執(zhí)行刪除操作。
例程10 刪除數(shù)據(jù)庫中Courses表的記錄
<jsp:useBean id="courseBusiness" class="com.hellking.study.hibernate.CourseBean" scope="page"/>
…
刪除id為：<%=request.getParameter("id")%>的course：:::<br>
<% try
{
courseBusiness.deleteCourse(request.getParameter("id"));
out.println("刪除成功");
}
catch(Exception e)
{
out.println("不存在這個記錄");
}
%>
|
我們來看CourseBean中執(zhí)行刪除操作的具體代碼：
/**
*刪除給定ID的course
*/
public void deleteCourse(String id)throws HibernateException
{
beginTransaction();
Course course=(Course)session.load(Course.class,id);
session.delete(course);
endTransaction(true);
}
|
在這個方法中，首先開始一個事務，然后通過session.load(Course.class,id)方法來裝載指定ID的持久對象，接下來通過"session.delete(course)"來刪除已經裝載的course，并且結束Hibernate事務。
總結
下面總結一下使用Hibernate的開發(fā)過程：
1、 配置Hibernate（一次即可）；
2、 確定數(shù)據(jù)表；
3、 創(chuàng)建持久對象；
4、 編寫對象和數(shù)據(jù)表的映射描述；
5、 編寫和業(yè)務邏輯。
實際上，上面的過程和使用EJB沒有什么區(qū)別：在使用EJB時，首先當然也是配置環(huán)境，初始化數(shù)據(jù)表；然后創(chuàng)建實體Bean（對象于Hibernate的持久對象）；接下來編寫部署描述符（ejb-jar.xml，廠商專有的部署描述），在這些部署描述符里，指定了EJB和數(shù)據(jù)表的映射關系，如果多個實體Bean存在關聯(lián)關系，需要描述它們之間的關系，這些描述對應于Hibernate中持久對象的描述，如Course.hbm.xml；往往我們并不在應用程序中直接操作實體Bean，而是通過業(yè)務對象（如會話Bean）來操作，這里的會話Bean可以簡單的和Hibernate中執(zhí)行業(yè)務邏輯的JavaBean對應。這里只是簡單的類比，不是絕對的，比如我們同樣可以在會話Bean中訪問Hibernate持久對象，也就是說使用Hibernate，同樣可以把業(yè)務邏輯放在會話Bean中。
通過本文的學習，相信讀者對Hibernate已經有了初步的認識，并且能夠使用Hibernate開發(fā)簡單的應用。在下一篇中，我們將學習怎么使用Hibernate來為復雜的數(shù)據(jù)表進行映射，并且維護它們之間的關系。
參考資料
