創建數據庫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類型之間的對應關系
Customer類的屬性Java類型 Hibernate映射類型CUSTOMERS表的字段SQL類型namejava.lang.StringstringNAMEVARCHAR(15)emailjava.lang.StringstringEMAILVARCHAR(128)passwordjava.lang.StringstringPASSWORDVARCHAR(8)phoneintintPHONEINTaddressjava.lang.StringstringADDRESSVARCHAR(255)sexcharcharacterSEXCHAR(1)marriedbooleanbooleanIS_MARRIEDBITdescriptionjava.lang.StringtextDESCRIPTIONTEXTimagebyte[]binaryIMAGEBLOBbirthdayjava.sql.DatedateBIRTHDAYDATEregisteredTimejava.sql.TimestamptimestampREGISTERED_TIMETIMESTAMP
從表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反射機制先識別出持久化類的屬性的Java類型,然後自動使用與之對應的默認的Hibernate映射類型。例如,Customer類的address屬性為java.lang.String類型,與java.lang.String對應的默認的映射類型為string,因此以下兩種設置方式是等價的:
<property name="address" column="ADDRESS"/>
或者:
<property name="address" type="string" />
對於Customer類的description屬性,盡管它是java.lang.String類型,由於CUSTOMERS表的DESCRIPTION字段為text類型,因此必須顯式地把映射類型設為text。
3.元素的not-null屬性
如果元素的not-null屬性為true,表明不允許為null,默認為false。例如以下代碼表明不允許Customer類的name屬性為null:
<property name="name" column="NAME" type="string" not-null="true" />
Hibernate在持久化一個Customer對象時,會先檢查它的name屬性是否為null,如果為null,就會拋出以下異常:
net.sf.hibernate.PropertyValueException:
not-null property references
a null or transient value:
mypack.Customer.name
如果數據庫中CUSTOMERS表的NAME字段不允許為null,但在映射文件中沒有設置not-null屬性:
<property name="name" column="NAME" type="string" />
那麼Hibernate在持久化一個Customer對象時,不會先檢查它的name屬性是否為null,而是直接通過JDBC API向CUSTOMERS表插入相應的數據,由於CUSTOMERS表的NAME字段設置了not null約束,因此數據庫會拋出錯誤:
708 ERROR JDBCExceptionReporter:
58 - General error, message from server:
"Column 'NAME' cannot be null"
值得注意的是,對於實際Java應用,當持久化一個Java對象時,不應該依賴Hibernate或數據庫來負責數據驗證。在四層應用結構中,應該由表述層或者業務邏輯層負責數據驗證。例如對於Customer對象的name屬性,事實上在表述層就能檢查name屬性是否為null,假如表述層、業務邏輯層和Hibernate持久化層都沒有檢查name屬性是否為null,那麼數據庫層會監測到NAME字段違反了數據完整性約束,從而拋出異常,如圖2-2所示,包含非法數據的Customer對象從表述層依次傳到數據庫層,隨後從數據庫層拋出的錯誤信息又依次傳到表述層,這種做法顯然會降低數據驗證的效率。
圖2-2 由數據庫層負責數據驗證
既然如此,把元素的not-null屬性設為true,有何意義呢?這主要是便於在軟件開發和測試階段能捕獲表述層或者業務邏輯層應該處理而未處理的異常,提醒開發人員在表述層或者業務邏輯層中加入必要的數據驗證邏輯。
4.元素的column屬性
元素的column屬性指定與類的屬性映射的表的字段名。以下代碼表明和address屬性對應的字段為ADDRESS字段:
<property name="address" column= "ADDRESS" type="string"/>
如果沒有設置< property >元素的column屬性,Hibernate將直接以類的屬性名作為字段名,也就是說,在默認情況下,與Customer類的address屬性對應的字段為address字段。
元素還可以包括子元素,它和元素的column屬性一樣,都可以設定與類的屬性映射的表的字段名。以下兩種設置方式是等價的:
<property name="address" column= "ADDRESS" type="string"/>
或者:
<property name="address" type="string">
<column name="ADDRESS" />
</property>
元素的子元素比column屬性提供更多的功能,它可以更加詳細地描述表的字段。例如,以下子元素指定CUSTOMERS表中的NAME字段的SQL類型為varchar(15),不允許為null,並且為這個字段建立了索引:
<property name="name" type="string">
<column name="NAME" sql-type="varchar(15)"
not-null="true" index="idx_name" />
</property>
子元素主要和hbm2ddl工具聯合使用。當使用hbm2ddl工具來自動生成數據庫Schema時,hbm2ddl工具將依據子元素提供的信息來定義表的字段。關於hbm2ddl工具的用法參見本書第3章(hbm2java和hbm2ddl工具)。如果數據庫Schema是通過手工方式創建的,就不必通過子元素設定字段的詳細信息,通常只需設定它的name屬性和not-null屬性就可以了,例如:
<property name="name" type="string">
<column name="NAME" not-null="true" />
</property>
或者:
<property name="name" column="NAME"
type="string" not-null="true" />
除了not-null屬性以外,子元素的多數屬性(如sql-type或index屬性)都不會影響Hibernate的運行時行為。
圖2-3顯示了Customer.hbm.xml配置的對象-關系映射。
圖2-3 Customer.hbm.xml配置的映射
Hibernate采用XML文件來配置對象-關系映射,有以下優點:
1、Hibernate既不會滲透到上層域模型中,也不會滲透到下層數據模型中。
2、軟件開發人員可以獨立設計域模型,不必強迫遵守任何規范。
3、數據庫設計人員可以獨立設計數據模型,不必強迫遵守任何規范。
4、對象-關系映射不依賴於任何程序代碼,如果需要修改對象-關系映射,只需修改XML文件,不需要修改任何程序,提高了軟件的靈活性,並且使維護更加方便。