对象-关系映射(O/R映射)是许多软件开发项目的常见需求。数据持久化过程中所涉及到的活动是非常乏味且易于出错的。如果考虑到不可避免的需求变化,我们就面临很大的麻烦:数据存储结构必须与源代码保持同步。再加上移植性问题,事情就变得非常复杂。
而Hibernate可以帮助我们轻松地在永久性存储介质中保存数据,而不需要在选择存储、安装或配置类型方面浪费太多精力。Hibernate允许我们存储任何类型的对象,因此,应用程序不需要知道其数据将使用Hibernate进行持久化。当然,这里提到的任何事情都可以逆向应用:现在从存储器获取已经准备好的对象是很平常的事情。更新和删除数据也是如此。
开始之前
在开始之前,您需要Hibernate的发行版,可以在Hibernate web站点(www.hibernate.org)上找到它。我们将使用2.0.3版本。对于数据库,我们将使用Hypersonic SQL 1.7.1版本,它可以在hsqldb.sourceforge.net上找到。 Hibernate还支持许多开源或商业数据库,例如MySQL、PostgreSQL、Oracle、DB2等。对于受支持的任何数据库,安装这个教程都很简单。完整列表参见官方文档。
注意:如果您不希望类被持久化在数据库中(比如说,您只希望进行串行化),那么Hibernate API为您提供了net.sf.hibernate.persister.EntityPersister类和net.sf.hibernate.persister.ClassPersister接口。通过编写子类或实现它们,您可以编写自己的持久化类,并根据需要使用它们。
下载了所有必需的安装包后,我们必须设置测试环境。基本上,我们所需做的就是把下载的.jar文件放到CLASSPATH中。这包括Hibernate发行版中的hibernate2.jar和Hypersonic的lib/ 目录下的hsqldb.jar。Hibernate还需要其他的几个库,这些库都可以在<hibernate-dist>/lib目录中找到。并不是该目录下的所有.jars文件都需要,但是如果您使用所有文件,也没有什么坏处。在我们开始研究Hibernate之前,我们将首先定义我们的问题域。
注意:Hibernate使用Apache的commons-logging。它是一个智能工具,如果找到log4j,它就会默认地使用它。Log4j是一个出色的日志记录库,我们将在这个教程中使用它。如果您还没有这个软件(您真的应该安装这个软件!),可以从Log4j homepage下载,并将它添加到CLASSPATH中。使用Hibernate团队所提供的示例log4j.properties,它可以在<hibernate-dist>/src目录下找到。
问题引入
每个开发人员都至少执行过一次类似的任务:创建一个订单,把一些产品放在其中,它就变成订单项,然后保存该订单。
我们使用这些简单的SQL命令来设置数据库:
CREATE TABLE ORDERS(
ID VARCHAR NOT NULL PRIMARY KEY,
ORDER_DATE TIMESTAMP NOT NULL,
PRICE_TOTAL DOUBLE NOT NULL)
CREATE TABLE PRODUCTS(
ID VARCHAR NOT NULL PRIMARY KEY,
NAME VARCHAR NOT NULL,
PRICE DOUBLE NOT NULL,
AMOUNT INTEGER NOT NULL)
CREATE TABLE ORDER_ITEMS(
ID VARCHAR NOT NULL PRIMARY KEY,
ORDER_ID VARCHAR NOT NULL,
PRODUCT_ID VARCHAR NOT NULL,
AMOUNT INTEGER NOT NULL,
PRICE DOUBLE NOT NULL)
这个数据模型非常简单。对于一个实际的“生产质量”数据模型,我们会需要外键、索引、额外的字段等等。对于本教程,上面的数据模型就可以了。
Java代码
尽管这些业务需求简单且易于理解,但是编写一堆准备好的语句的传统方法将很快令人厌烦。而Hibernate将会把我们解放出来。我们所需的只是一组简单的映射文件。但首先我们需要编写Java类。
注意:我们将把所有将要持久化的类放到test.hibernate包中,把所有辅助类放到test包中。
Product
这个简单的类只定义了必要的字段:ID、产品名称、产品价格和这种产品的当前库存量。由于Hibernate使用无格式的简单JavaBeans,我们需要做的只是为每个重要字段(在我们的示例中,所有字段都是重要字段)创建getter和setter方法,以及默认的构造函数。
package test.hibernate;
public class Product {
private String id;
private String name;
private double price;
private int amount;
public String getId() {
return id;
}
public void setId(String string) {
id = string;
}
// 默认的构造函数及其他
// 为了简洁起见,getter/setter方法没有显示
// ...
}
我们还需要重写toString()方法。这将帮助我们使用简单的System.out.println(obj)调用来跟踪应用程序流:
public String toString() {
return
"[Product] " + name + "(" + id +
") price=" + price + " amount=" + amount;
}
这就是全部的product类代码。但Product没有实现任何接口,也没有继承任何类,Hibernate又如何知道持久化该类型的对象呢?答案很简单:Hibernate可以处理任何类型的Java对象,只要它能够遵循JavaBeans约定。
Order
我们需要创建的下一个类是Order,它甚至比Product更简单:它只包含ID、创建日期、总价格和该Order所包括的OrderItems的Set。当然,还需要创建getter和setter方法以及默认的构造函数。
package test.hibernate;
import java.util.Date;
import java.util.HashSet;
import java.util.Set;
public class Order {
private String id;
private Date date;
private double priceTotal;
private Set orderItems = new HashSet();
// 自动设置该Order的创建时间
public Order() {
this.date = new Date();
}
public String getId() {
return id;
}
public void setId(String string) {
id = string;
}
// 为了简洁起见,其他getter/setter方法没有显示
// ...
}
同样也要重写toString()方法。不要忘记对orderItems执行循环!
OrderItem
这个类稍微复杂一些,但仍然很易懂。我们的业务需求决定我们需要一定量的产品,我们将会把它们放到一个订单中。那些产品将自动变成订单项。这时就需要自定义构造函数了。
package test.hibernate;
public class OrderItem {
/**
* 创建有效的订单项。自动设置订单项的价格,并更正产品的库存可用量
*
* @param order 该订单项属于的订单
* @param product 该订单项为哪种产品而创建
* @param amount
*/
public OrderItem(Order order,
Product product,
int amount) {
this.order = order;
this.product = product;
this.amount = amount;
product.setAmount(product.getAmount() - amount);
this.price = product.getPrice() * amount;
}
// 还需要默认的构造函数来保证Hibernate工作
/**
* 空构造函数遵循JavaBeans约定
*
*/
public OrderItem() {
// 空的默认构造函数
}
// 字段
private String id;
private Product product;
private Order order;
private String productId;
private String orderId;
private double price;
private int amount;
public String getId() {
return id;
}
public String getProductId() {
return product.getId();
}
public String getOrderId() {
return order.getId();
}
// 其他getter/setter方法没有显示
// ...
file://显示该订单项的方便方式
public String toString() {
return
"[OrderItem] id=" + id + " amount=" +
amount + " price=" + price + "(" +
product + ")";
}
}
现在我们有了反映数据库结构的所有类。余下的唯一一件没有解释的事情就是如何把产品放到一个订单中。只需把下面的方法添加到Order类中:
/**
* 添加一项产品到订单中。产品自动成为一个订单项。
* priceTotal被自动更新。
*
* @param p 添加到该订单的产品
* @param amount 添加的产品量
*/
public void addProduct(Product p,
int amount) {
OrderItem orderItem = new OrderItem(this,
p, amount);
this.priceTotal = this.priceTotal
+ p.getPrice() * amount;
this.orderItems.add(orderItem);
}
启动Hibernate
在我们假想的应用程序中,基本的使用模式非常简单:我们将创建一个Product,然后将其持久化(或者换句话说,保存它);我们将搜索并加载一个已经持久化的Product,并确保其可以使用;我们将会更新和删除Product。
创建和持久化Product
现在我们终于用到Hibernate了。使用的场景非常简单:
创建一个有效的Product。
在应用程序启动时使用net.sf.hibernate.cfg.Configuration获取net.sf.hibernate.SessionFactory。
通过调用SessionFactory#openSession(),打开net.sf.hibernate.Session。
保存Product,关闭Session。
正如我们所看到的,这里没有提到JDBC、SQL或任何类似的东西。非常令人振奋!下面的示例遵循了上面提到的步骤:
package test;
import net.sf.hibernate.Session;
import net.sf.hibernate.SessionFactory;
import net.sf.hibernate.Transaction;
import net.sf.hibernate.cfg.Configuration;
import test.hibernate.Product;
// 用法:
// java test.InsertProduct name amount price
public class InsertProduct {
public static void main(String[] args)
throws Exception {
// 1. 创建Product对象
Product p = new Product();
p.setName(args[0]);
p.setAmount(Integer.parseInt(args[1]));
p.setPrice(Double.parseDouble(args[2]));
// 2. 启动Hibernate
Configuration cfg = new Configuration()
.addClass(Product.class);
SessionFact