陳亞強 (cyqcims@mail.tsinghua.edu.cn)
北京華園天一科技有限公司高級軟件工程師
2003 年 10 月
對象、關(guān)系的映射(ORM)是一種耗時(shí)的工作,在Java環(huán)境下,有幾種框架來(lái)表示持久數據,如實(shí)體Bean、OJB、JDO、Hibernate等。Hibernate是一種新的ORM映射工具,它不僅提供了從Java類(lèi)到數據表的映射,也提供了數據查詢(xún)和恢復等機制。本文介紹怎么在Web應用開(kāi)發(fā)中配置Hibernate的環(huán)境,并且使用Hibernate來(lái)開(kāi)發(fā)一個(gè)具體的實(shí)例。
閱讀本文前您需要以下的知識和工具:
本文的參考資料見(jiàn) 參考資料。
介紹
面向對象的開(kāi)發(fā)方法是當今的主流,但是同時(shí)我們不得不使用關(guān)系型數據庫,所以在企業(yè)級應用開(kāi)發(fā)的環(huán)境中,對象、關(guān)系的映射(ORM)是一種耗時(shí)的工作。圍繞對象關(guān)系的映射和持久數據的訪(fǎng)問(wèn),在Java領(lǐng)域中發(fā)展起來(lái)了一些API和框架,下面分別簡(jiǎn)單介紹。
JDBC可以說(shuō)是訪(fǎng)問(wèn)持久數據層最原始、最直接的方法。在企業(yè)級應用開(kāi)發(fā)中,我們可能使用DAO(Data Access Object)模式來(lái)把數據訪(fǎng)問(wèn)封裝起來(lái),然后在其它的層中同一調用。這種方式的優(yōu)點(diǎn)是運行效率最高,缺點(diǎn)是把DAO對象和SQL語(yǔ)言緊密耦合在一起使得在大項目中難以維護。但是不管怎么說(shuō),使用JDBC來(lái)直接訪(fǎng)問(wèn)持久數據層是當今企業(yè)級應用開(kāi)發(fā)中使用最廣泛的。
實(shí)體Bean是J2EE平臺中用來(lái)表示和訪(fǎng)問(wèn)持久數據的方式。雖然實(shí)體Bean是一種方便快捷的方法,但是在運行時(shí)我們需要額外購買(mǎi)EJB容器(當然,如今也有免費的EJB容器,如JBOSS),并且使用不同的應用服務(wù)器,需要重新書(shū)寫(xiě)不同的部署描述,使得在不同應用服務(wù)器下移植企業(yè)級應用會(huì )帶來(lái)一些困難。
另外,在Java領(lǐng)域中,還有一些表示持久數據的框架,比如JDO和OJB,在這里就不詳細介紹了。
Hibernate是一種新的ORM映射工具,它不僅提供了從Java類(lèi)到數據表之間的映射,也提供了數據查詢(xún)和恢復機制。相對于使用JDBC和SQL來(lái)手工操作數據庫,使用Hibernate,可以大大減少操作數據庫的工作量。
Hibernate可以和多種Web服務(wù)器或者應用服務(wù)器良好集成,如今已經(jīng)支持幾乎所有的流行的數據庫服務(wù)器(達16種)。
下面我們來(lái)介紹怎么結合Hibernate2.0和Apache Tomcat5.0在Web應用中使用Hibernate。
配置
1、 下載安裝Tomcat,并且下載Hibernate的運行環(huán)境(主要包含一些JAR包)。
2、 把要使用的數據庫的JDBC驅動(dòng)程序拷貝到%TOMCAT_HOME%\common\lib目錄下。筆者使用的是MYSQL,對應的驅動(dòng)程序的JAR包為mm.mysql-2.0.4-bin.jar。
3、 在Tomcat的Webapps目錄下新建一個(gè)Web應用,名字為hibernate。
4、 把Hibernate提供的hibernate2.jar和一些第三方的運行庫拷貝到hibernate\WEB\INF\lib目錄下。(這些第三方的運行庫包含在下載的Hibernate lib目錄下)
5、 在%TOMCAT_HOME%\conf\server.xml中Web應用和數據源。在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> |
在這里,配置了一個(gè)名為hibernate的Web應用,并且配置了一個(gè)數據源,數據源的JNDI名稱(chēng)為jdbc/hibernate。您需要根據情況修改數據源的鏈接屬性。
6、 下一步就是書(shū)寫(xiě)Hibernate的配置描述符??梢允褂肵ML的配置描述,也可以使用基于屬性的配置描述。在這里使用基于XML的配置描述。在hibernate\WEB-INF\classes目錄下新建一個(gè)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中配置的數據源的屬性一樣。如果不是使用MYSQL,那么需要更改dialect屬性。
到現在,配置基本完成,下面我們來(lái)開(kāi)發(fā)一個(gè)最簡(jiǎn)單的應用。
開(kāi)發(fā)持久對象、編寫(xiě)映射描述
我們使用hibernate來(lái)封裝一個(gè)簡(jiǎn)單的數據表。這個(gè)表的名字為Courses,它有兩個(gè)字段,一個(gè)是ID,它是Courses表的主鍵;另一個(gè)是name,表示Courses的名字。在數據庫中使用以下的腳本來(lái)創(chuàng )建這個(gè)表:
create table Courses(CourseId varchar(32) not null, name varchar(32), constraint pk_Courses primary key (CourseId) );
接下來(lái)的任務(wù)就是為Courses表書(shū)寫(xiě)持久對象,如例程3所示。
例程3 Courses的持久對象(Courses.java)
package com.hellking.study.hibernate; import java.util.Set; /** *在hibernate中代表了Course表的類(lèi)。 */ public class Course { /**每個(gè)屬性和表的一個(gè)字段對應**/ private String id; private String name; /**students表示course中的學(xué)生,在后面才會(huì )用到,暫時(shí)不管**/ private Set students; /**屬性的訪(fǎng)問(wèn)方法**/ 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類(lèi)中也包含了兩個(gè)屬性,id和name,它的屬性和表Courses的字段是一一對應的,并且類(lèi)型一致。
書(shū)寫(xiě)好了持久對象,接下來(lái)的任務(wù)就是書(shū)寫(xiě)對象、關(guān)系映射描述。在hibernate\WEB-INF\classes目錄下新建一個(gè)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映射文件中,指定了要映射的類(lèi)和映射的表,并且指定了表的各個(gè)字段和Java對象中各個(gè)字段的映射關(guān)系,比如Course對象中的id屬性對應了Courses表的courseId字段。
接下來(lái)的任務(wù)就是在hibernate.cfg.xml中指定這個(gè)映射關(guān)系。如下所示:
<session-factory> … <!-- Mapping files --> <mapping resource="Course.hbm.xml"/> </session-factory> |
編寫(xiě)業(yè)務(wù)邏輯
到此,我們已經(jīng)封裝了一個(gè)名為Courses的表,并且配置完成。接下來(lái)的任務(wù)就是在Web應用開(kāi)發(fā)中使用它們,為了演示在Hibernate中對數據庫的不同類(lèi)型的操作,我們開(kāi)發(fā)的Web應用有以下的功能:
- 增加一個(gè)Course;
- 刪除一個(gè)Course;
- 按照Course的名字進(jìn)行模糊搜索;
- 查看系統中所有的Course。
雖然我們可以直接在JSP中使用hibernate,但是往往我們不這樣,而是把這些業(yè)務(wù)邏輯封裝在JavaBean中,然后在JSP中通過(guò)調用JavaBean以訪(fǎng)問(wèn)Hibernate封裝的對象。
由于訪(fǎng)問(wèn)通過(guò)使用hibernate有一些共性的操作,在這里我們把這些共性的操作封裝在一個(gè)專(zhuān)門(mén)的類(lèi)中,這樣其它的類(lèi)可以繼承它,如例程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;//會(huì )話(huà)工廠(chǎng),用于創(chuàng )建會(huì )話(huà) protected Session session;//hibernate會(huì )話(huà) protected Transaction transaction; //hiberante事務(wù) public HibernateBase()throws HibernateException { this.initHibernate(); } // 幫助方法 protected void initHibernate() throws HibernateException { // 裝載配置,構造SessionFactory對象 sessionFactory = new Configuration().configure().buildSessionFactory(); } /** *開(kāi)始一個(gè)hibernate事務(wù) */ protected void beginTransaction() throws HibernateException { session = sessionFactory.openSession(); transaction = session.beginTransaction(); } /** *結束一個(gè)hibernate事務(wù)。 */ protected void endTransaction(boolean commit) throws HibernateException { if (commit) { transaction.commit(); } else { //如果是只讀的操作,不需要commit這個(gè)事務(wù)。 transaction.rollback(); } session.close(); } } |
下面編寫(xiě)業(yè)務(wù)邏輯類(lèi),新建一個(gè)名為CourseBean的JavaBean,并且CourseBean繼承HibernateBase類(lèi),代碼如例程6所示。
例程6 CourseBean.java
package com.hellking.study.hibernate; import net.sf.hibernate.*; import net.sf.hibernate.cfg.*; import java.util.*; /** *和course相關(guān)的業(yè)務(wù)邏輯 */ public class CourseBean extends HibernateBase { public CourseBean()throws HibernateException { super(); } /** *增加一個(gè)Course */ public void addCourse(Course st)throws HibernateException { beginTransaction(); session.save(st); endTransaction(true); } /** *查詢(xún)系統中所有的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的名字進(jìn)行模糊查找,返回的是包含有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個(gè)業(yè)務(wù)方法,你可以根據情況增加其它的業(yè)務(wù)方法。在CourseBean中,通過(guò)Hibernate來(lái)操作潛在的數據庫資源。
要保存Course數據到數據庫,可以通過(guò):
方法來(lái)保存,它相當于使用在JDBC中執行以下語(yǔ)句:
Connection con=… Statement stmt=con.createStatement(); stmt.executeUpdate("insert into courses values('"+course.getId(),+"','"+course.getName()+"')"); con.close(); |
可以看出,通過(guò)使用Hibernate,可以大大減少數據訪(fǎng)問(wèn)的復雜度。
在JSP中調用業(yè)務(wù)邏輯
添加數據
CourseBean這個(gè)業(yè)務(wù)對象封裝了和Hibernate的交互關(guān)系,從而使JSP和Hibernate關(guān)系的解藕。我們來(lái)看測試主頁(yè)面的部分代碼,如例程7所示。
例程7 測試Hibernate開(kāi)發(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>::增加一個(gè)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> ::刪除一個(gè)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> |
首先通過(guò)一個(gè)值對象Course(這個(gè)類(lèi)正好是Hibernate使用的持久對象,這里作為值對象來(lái)傳遞數據)接收獲得的參數,然后CourseBean的addCourse(Course)方法把數據保存到數據庫??梢钥闯?,通過(guò)使用Hibernate,把數據從表單中添加到數據庫非常簡(jiǎn)單。
查詢(xún)
下面來(lái)看模糊查找的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()); } %> …. |
它實(shí)際上調用的是CourseBean的Iterator getSomeCourse(String name)方法。我們來(lái)回顧一下這個(gè)方法中的代碼:
/** *按course的名字進(jìn)行模糊查找 */ 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; } |
在查詢(xún)前,首先調用beginTransaction方法啟動(dòng)新的Hibernate事務(wù),然后創(chuàng )建一個(gè)Query對象,在創(chuàng )建這個(gè)對象時(shí),同時(shí)指定查詢(xún)的語(yǔ)句。
注意,在查詢(xún)語(yǔ)句:
select c from Course as c where c.name like :name" |
中,它雖然和普通的SQL語(yǔ)句相似,但是不同,在數據庫中,使用的表的名字是Courses,而在這個(gè)查詢(xún)語(yǔ)句中使用的是Course,它和持久對象的名字一致,也就是說(shuō),這個(gè)查詢(xún)的概念是查詢(xún)持久對象,而不是數據庫的記錄。
創(chuàng )建了查詢(xún)對象Query后,需要設置查詢(xún)的參數,它和在JDBC中PreparedStatement對象中設置參數的方法相似。通過(guò)"Iterator it= query.iterate()"語(yǔ)句來(lái)執行查詢(xún),并且返回一個(gè)Iterator對象。在這里使用了Hibernate提供的查詢(xún)機制,一般的JDBC查詢(xún)返回的是ResultSet對象,而這里返回的是包含了CourseBean對象的Iterator。
要查詢(xún)系統中所有的Course,也同樣非常簡(jiǎn)單,可以通過(guò)例程9所示的代碼實(shí)現。
例程9 查詢(xún)數據庫中所有的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()); } %> … |
實(shí)際上調用的是CourseBean的getAllCourses方法,它和getSomeCourse方法機制一樣,就不再介紹了。
刪除數據
在JSP中,使用以下的代碼來(lái)執行刪除操作。
例程10 刪除數據庫中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("不存在這個(gè)記錄"); } %> |
我們來(lái)看CourseBean中執行刪除操作的具體代碼:
/** *刪除給定ID的course */ public void deleteCourse(String id)throws HibernateException { beginTransaction(); Course course=(Course)session.load(Course.class,id); session.delete(course); endTransaction(true); } |
在這個(gè)方法中,首先開(kāi)始一個(gè)事務(wù),然后通過(guò)session.load(Course.class,id)方法來(lái)裝載指定ID的持久對象,接下來(lái)通過(guò)"session.delete(course)"來(lái)刪除已經(jīng)裝載的course,并且結束Hibernate事務(wù)。
總結
下面總結一下使用Hibernate的開(kāi)發(fā)過(guò)程:
1、 配置Hibernate(一次即可);
2、 確定數據表;
3、 創(chuàng )建持久對象;
4、 編寫(xiě)對象和數據表的映射描述;
5、 編寫(xiě)和業(yè)務(wù)邏輯。
實(shí)際上,上面的過(guò)程和使用EJB沒(méi)有什么區別:在使用EJB時(shí),首先當然也是配置環(huán)境,初始化數據表;然后創(chuàng )建實(shí)體Bean(對象于Hibernate的持久對象);接下來(lái)編寫(xiě)部署描述符(ejb-jar.xml,廠(chǎng)商專(zhuān)有的部署描述),在這些部署描述符里,指定了EJB和數據表的映射關(guān)系,如果多個(gè)實(shí)體Bean存在關(guān)聯(lián)關(guān)系,需要描述它們之間的關(guān)系,這些描述對應于Hibernate中持久對象的描述,如Course.hbm.xml;往往我們并不在應用程序中直接操作實(shí)體Bean,而是通過(guò)業(yè)務(wù)對象(如會(huì )話(huà)Bean)來(lái)操作,這里的會(huì )話(huà)Bean可以簡(jiǎn)單的和Hibernate中執行業(yè)務(wù)邏輯的JavaBean對應。這里只是簡(jiǎn)單的類(lèi)比,不是絕對的,比如我們同樣可以在會(huì )話(huà)Bean中訪(fǎng)問(wèn)Hibernate持久對象,也就是說(shuō)使用Hibernate,同樣可以把業(yè)務(wù)邏輯放在會(huì )話(huà)Bean中。
通過(guò)本文的學(xué)習,相信讀者對Hibernate已經(jīng)有了初步的認識,并且能夠使用Hibernate開(kāi)發(fā)簡(jiǎn)單的應用。在下一篇中,我們將學(xué)習怎么使用Hibernate來(lái)為復雜的數據表進(jìn)行映射,并且維護它們之間的關(guān)系。
參考資料