(1)创建Hibernate的配置文件。
(2)创建持久化类。
(3)创建对象-关系映射文件。
(4)通过Hibernate API编写访问数据库的代码。
本章通过一个简单的例子helloapp应用,演示如何运用Hibernate来访问关系数据库。helloapp应用的功能非常简单:通过Hibernate保存、更新、删除、加载及查询Customer对象。图1显示了Hibernate在helloapp应用中所处的位置。
图1 Hibernate在helloapp应用中所处的位置
helloapp应用既能作为独立的Java程序运行,还能作为Java Web应用运行,该应用的源代码位于配套光盘的sourcecode/chapter2/helloapp目录下。
2.1 创建Hibernate的配置文件
Hibernate从其配置文件中读取和数据库连接有关的信息,这个配置文件应该位于应用的classpath中。Hibernate的配置文件有两种形式:一种是XML格式的文件;还有一种是Java属性文件,采用"健=值"的形式。
下面介绍如何以Java属性文件的格式来创建Hibernate的配置文件。这种配置文件的默认文件名为hibernate.properties,例程2-1为示范代码。
例程2-1 hibernate.properties
hibernate.dialect=
net.sf.hibernate.dialect.MySQLDialect
hibernate.connection.driver_class=
com.mysql.jdbc.Driver
hibernate.connection.url=jdbc:mysql:
//localhost:3306/SAMPLEDB
hibernate.connection.username=root
hibernate.connection.password=1234
hibernate.show_sql=true
以上hibernate.properties文件包含了一系列属性及其属性值,Hibernate将根据这些属性来连接数据库,本例为连接MySQL数据库的配置代码。表2-1对以上hibernate.properties文件中的所有属性做了描述。
表2-1 Hibernate配置文件的属性
Hibernate能够访问多种关系数据库,如MySQL、Oracle和Sybase等。尽管多数关系数据库都支持标准的SQL语言,但是它们往往还有各自的SQL方言,就像不同地区的人既能说标准的普通话,还能讲各自的方言一样。
hibernate.dialect属性用于指定被访问数据库使用的SQL方言,当Hibernate生成SQL查询语句,或者使用native对象标识符生成策略时,都会参考本地数据库的SQL方言。本书第5章(映射对象标识符)介绍了Hibernate的各种对象标识符生成策略。
在Hibernate软件包的etc目录下,有一个hibernate.properties文件,它提供了连接各种关系数据库的配置代码样例。
2.2 创建持久化类
持久化类是指其实例需要被Hibernate持久化到数据库中的类。持久化类通常都是域模型中的实体域类。持久化类符合JavaBean的规范,包含一些属性,以及与之对应的getXXX()和setXXX()方法。例程2-2定义了一个名为Customer的持久化类。
例程2-2 Customer.java
package mypack;
import java.io.Serializable;
import java.sql.Date;
import java.sql.Timestamp;
public class Customer implements Serializable
{
private Long id;
private String name;
private String email;
private String password;
private int phone;
private boolean married;
private String address;
private char sex;
private String description;
private byte[] image;
private Date birthday;
private Timestamp registeredTime;
public Customer(){}
public Long getId()
{
return id;
}
public void setId(Long id)
{
this.id = id;
}
public String getName()
{
return name;
}
public void setName(String name)
{
this.name=name;
}
//此处省略email、password和phone
等属性的getXXX()和setXXX()方法
……
}
持久化类符合JavaBean的规范,包含一些属性,以及与之对应的getXXX()和setXXX()方法。getXXX()和setXXX()方法必须符合特定的命名规则,"get"和"set"后面紧跟属性的名字,并且属性名的首字母为大写,例如name属性的get方法为getName(),如果把get方法写为getname()或者getNAME(),会导致Hibernate在运行时抛出以下异常:
net.sf.hibernate.PropertyNotFoundException:
Could not find a getter
for property name in class mypack.Customer
如果持久化类的属性为boolean类型,那么它的get方法名既可以用"get"作为前缀,也可以用"is"作为前缀。例如Customer类的married属性为boolean类型,因此以下两种get方法是等价的:
public boolean isMarried()
{
return married;
}
或者:
public boolean getMarried()
{
return married;
}
Hibernate并不要求持久化类必须实现java.io.Serializable接口,但是对于采用分布式结构的Java应用,当Java对象在不同的进程节点之间传输时,这个对象所属的类必须实现Serializable接口,此外,在Java Web应用中,如果希望对HttpSession中存放的Java对象进行持久化,那么这个Java对象所属的类也必须实现Serializable接口。
Customer持久化类有一个id属性,用来惟一标识Customer类的每个对象。在面向对象术语中,这个id属性被称为对象标识符(OID,Object Identifier),通常它都用整数表示,当然也可以设为其他类型。如果customerA.getId().equals(customerB.getId())的结果是true,就表示customerA和customerB对象指的是同一个客户,它们和CUSTOMERS表中的同一条记录对应。
Hibernate要求持久化类必须提供一个不带参数的默认构造方法,在程序运行时,Hibernate运用Java反射机制,调用java.lang.reflect.Constructor.newInstance()方法来构造持久化类的实例。
如果对这个持久化类使用延迟检索策略,为了使Hibernate能够在运行时为这个持久化类创建动态代理,要求持久化类的默认构造方法的访问级别必须是public或protected类型,而不能是default或private类型。
在本书第10章(Hibernate的检索策略)介绍了Hibernate的延迟检索策略及动态代理的概念。
在Customer类中没有引入任何Hibernate API,Customer类不需要继承Hibernate的类,或实现Hibernate的接口,这提高了持久化类的独立性。如果日后要改用其他的ORM产品,比如由Hibernate改为OJB,不需要修改持久化类的代码。
本书第1章介绍了J2EE的持久化方案,无论是基于CMP的实体EJB,还是基于BMP的实体EJB,它们的共同特点是都必须运行在EJB容器中。而Hibernate支持的持久化类不过是普通的Java类,它们能够运行在任何一种Java环境中。
创建数据库Schema 在本例中,与Customer类对应的数据库表名为CUSTOMERS,它在MySQL数据库中的DDL定义如下:
create table CUSTOMERS (
ID bigint not null primary key,
NAME varchar(15) not null,
EMAIL varchar(128) not null,
PASSWORD varchar(8) not null,
PHONE int ,
ADDRESS varchar(255),
SEX char(1) ,
IS_MARRIED bit,
DESCRIPTION text,
IMAGE blob,
BIRTHDAY date,
REGISTERED_TIME timestamp
);
CUSTOMERS表有一个ID字段,它是表的主键,它和Customer类的id属性对应。CUSTOMERS表中的字段使用了各种各样的SQL类型,参见表2-2。
表2-2 CUSTOMERS表的字段使用的SQL类型
2.4 创建对象-关系映射文件
Hibernate采用XML格式的文件来指定对象和关系数据之间的映射。在运行时,Hibernate将根据这个映射文件来生成各种SQL语句。在本例中,将创建一个名为Customer.hbm.xml的文件,它用于把Customer类映射到CUSTOMERS表,这个文件应该和Customer.class文件存放在同一个目录下。例程2-3为Customer.hbm.xml文件的代码。
例程2-3 Customer.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="mypack.Customer"
table="CUSTOMERS">
<id name="id" column="ID" type="long">
<generator class="increment"/>
</id>
<property name="name"
column="NAME" type="string"
not-null="true" />
<property name="email"
column="EMAIL" type="string"
not-null="true" />
<property name="password"
column="PASSWORD" type="string"
not-null="true"/>
<property name="phone"
column="PHONE" type="int" />
<property name="address"
column="ADDRESS" type="string" />
<property name="sex"
column="SEX" type="character"/>
<property name="married"
column="IS_MARRIED" type="boolean"/>
<property name="description"
column="DESCRIPTION" type="text"/>
<property name="image"
column="IMAGE" type="binary"/>
<property name="birthday"
column="BIRTHDAY" type="date"/>
<property name="registeredTime"
column="REGISTERED_TIME"
type="timestamp"/>
</class>
</hibernate-mapping>
2.4.1 映射文件的文档类型定义(DTD)
在例程2-3的Customer.hbm.xml文件的开头声明了DTD(Document Type Definition,文档类型定义),它对XML文件的语法和格式做了定义。Hibernate的XML解析器将根据DTD来核对XML文件的语法。
每一种XML文件都有独自的DTD文件。Hibernate的对象-关系映射文件使用的DTD文件的下载网址为:http://hibernate.sourceforge.net/hibernate-mapping-2.0.dtd。此外,在Hibernate软件包的src\net\sf\hibernate目录下也提供了hibernate-mapping-2.0.dtd文件。在这个文件中,描述顶层元素的代码如下:
<!ELEMENT hibernate-mapping (meta*,
import*, (class|subclass|joined-subclass)*,
query*,
sql-query*)>
描述顶层元素的子元素的代码如下:
<!ELEMENT class (
meta*,
(cache|jcs-cache)?,
(id|composite-id),
discriminator?,
(version|timestamp)?,
(property|many-to-one|one-to-one
|component|dynamic-component|any
|map|set|list|bag|idbag|array
|primitive-array)*,
((subclass*)|(joined-subclass*))
)>
元素是对象-关系映射文件的根元素,其他元素(即以上DTD代码中括号以内的元素,如子元素)必须嵌入在元素以内。在元素中又嵌套了好多子元素。
在以上DTD代码中,还使用了一系列的特殊符号来修饰元素,表2-3描述了这些符号的作用。在创建自己的对象-关系映射文件时,如果不熟悉某种元素的语法,可以参考DTD文件。
表2-3 DTD中特殊符号的作用
根据表2-3可以看出,在元素中,、、和等子元素可以不存在,或者存在一次或者多次;在元素中,子元素必须存在且只能存在一次,元素可以不存在,或者存在一次或者多次。
此外,在映射文件中,父元素中的各种子元素的定义必须符合特定的顺序。例如,根据元素的DTD可以看出,必须先定义子元素,再定义子元素,以下映射代码颠倒了和子元素的位置:
<class name="mypack.Customer"
table="CUSTOMERS">
<property name="name"
column="NAME" type="string"
not-null="true" />
<property name="email"
column="EMAIL"
type="string" not-null="true" />
<id name="id" column="ID" type="long">
<generator class="increment"/>
</id>
……
</class>
Hibernate的XML解析器在运行时会抛出MappingException:
[java] 21:27:51,610 ERROR XMLHelper:
48 - Error parsing XML:
XML InputStream (24)
The content of element type "class"
must match "(meta*,(cache|jcs-cache)?,
(
id|composite-id),
discriminator?,(version|timestamp)?,
(property|many-to-one|one-to-one|component|
dynamic-component|any|map|set
|list|bag|idbag|array|primitive-array)*,
(subclass*|joined-subclass*))".
[java] net.sf.hibernate.MappingException:
Error reading resource:
mypack/Customer.hbm.xml
at net.sf.hibernate.cfg.Configuration.addClass
(Configuration.java:357)
2.4.2 把Customer持久化类映射到CUSTOMERS表
例程2-3的Customer.hbm.xml文件用于映射Customer类。如果需要映射多个持久化类,那么既可以在同一个映射文件中映射所有类,也可以为每个类创建单独的映射文件,映射文件和类同名,扩展名为"hbm.xml"。后一种做法更值得推荐,因为在团队开发中,这有利于管理和维护映射文件。
元素指定类和表的映射,它的name属性设定类名,table属性设定表名。以下代码表明和Customer类对应的表为CUSTOMERS表:
<class name="mypack.Customer"
table="CUSTOMERS">
如果没有设置元素的table属性,Hibernate将直接以类名作为表名,也就是说,在默认情况下,与mypack.Customer类对应的表为Customer表。
元素包含一个子元素及多个子元素。子元素设定持久化类的OID和表的主键的映射。以下代码表明Customer类的id属性和CUSTOMERS表中的ID字段对应。
<id name="id" column="ID" type="long">
<generator class="increment"/>
</id>
元素的子元素指定对象标识符生成器,它负责为OID生成惟一标识符。本书第5章(映射对象标识符)详细介绍了Hibernate提供的各种对象标识符生成器的用法。
子元素设定类的属性和表的字段的映射。子元素主要包括name、type、column和not-null属性。
1.元素的name属性
元素的name属性指定持久化类的属性的名字。
2.元素的type属性
元素的type属性指定Hibernate映射类型。Hibernate映射类型是Java类型与SQL类型的桥梁。表2-4列出了Customer类的属性的Java类型、Hibernate映射类型,以及CUSTOMERS表的字段的SQL类型这三者之间的对应关系。
表2-4 Java类型、Hibernate映射类型以及SQL类型之间的对应关系
从表2-4看出,如果Customer类的属性为java.lang.String类型,并且与此对应的CUSTOMERS表的字段为VARCHAR类型,那么应该把Hibernate映射类型设为string,例如:
<property name="name"
column="NAME" type="string"
not-null="true" />
如果Customer类的属性为java.lang.String类型,并且与此对应的CUSTOMERS表的字段为TEXT类型,那么应该把Hibernate映射类型设为text,例如:
<property name="description"
column="DESCRIPTION" type="text"/>
如果Customer类的属性为byte[]类型,并且与此对应的CUSTOMERS表的字段为BLOB类型,那么应该把Hibernate映射类型设为binary,例如:
<property name="image" column="IMAGE"
type="binary"/>
如果没有显式设定映射类型,Hibernate会运用Java反射机制先识