Java项目中使用Hibernate处理数据

80酷酷网    80kuku.com

  数据|项目

  对象-关系映射(O/R映射)是许多软件开发项目的常见需求。数据持久化过程中所涉及到的活动是非常乏味且易于出错的。如果考虑到不可避免的需求变化,我们就面临很大的麻烦:数据存储结构必须与源代码保持同步。再加上移植性问题,事情就变得非常复杂。

  而Hibernate可以帮助我们轻松地在永久性存储介质中保存数据,而不需要在选择存储、安装或配置类型方面浪费太多精力。Hibernate允许我们存储任何类型的对象,因此,应用程序不需要知道其数据将使用Hibernate进行持久化。当然,这里提到的任何事情都可以逆向应用:现在从存储器获取已经准备好的对象是很平常的事情。更新和删除数据也是如此。

  开始之前

  在开始之前,您需要Hibernate的发行版,可以在Hibernate web站点()上找到它。我们将使用2.0.3版本。对于数据库,我们将使用Hypersonic SQL 1.7.1版本,它可以在上找到。 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是一个出色的日志记录库,我们将在这个教程中使用它。如果您还没有这个软件(您真的应该安装这个软件!),可以从下载,并将它添加到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了。使用的场景非常简单:

  1. 创建一个有效的Product。
  2. 在应用程序启动时使用net.sf.hibernate.cfg.Configuration获取net.sf.hibernate.SessionFactory。
  3. 通过调用SessionFactory#openSession(),打开net.sf.hibernate.Session。
  4. 保存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);         SessionFactory sf = cfg.buildSessionFactory();         // 3. 打开Session         Session sess = sf.openSession();         // 4. 保存Product,关闭Session         Transaction t = sess.beginTransaction();         sess.save(p);         t.commit();         sess.close();     } } 

  让我们来运行它!通过运行java test.InsertProduct Milk 100 1.99命令,插入价格为1.99的100瓶牛奶。我们会得到如下的输出日志:

Nov 23, 2003 9:05:50 AM net.sf.hibernate.cfg.Environment <clinit> INFO: Hibernate 2.0.3 Nov 23, 2003 9:05:50 AM net.sf.hibernate.cfg.Environment <clinit> INFO: hibernate.properties not found Nov 23, 2003 9:05:50 AM net.sf.hibernate.cfg.Environment <clinit> INFO: using CGLIB reflection optimizer Nov 23, 2003 9:05:50 AM net.sf.hibernate.cfg.Environment <clinit> INFO: JVM proxy support: true Nov 23, 2003 9:05:50 AM net.sf.hibernate.cfg.Configuration addClass INFO: Mapping resource: test/hibernate/Product.hbm.xml Exception in thread "main" net.sf.hibernate.MappingException:  Resource: test/hibernate/Product.hbm.xml not found     at net.sf.hibernate.cfg.Configuration.addClass(Configuration.java:285)     at test.FindProductByName.main(FindProductByName.java:24) 

  它无法工作。其中有两行尤其让人感兴趣:

INFO: hibernate.properties not found and Resource: test/hibernate/Product.hbm.xml not found.

   当然,INFO行指出我们需要一个hibernate.properties配置文件。在这个文件中,我们配置要使用的数据库、用户名和密码以及其他选项。使用下面提供的这个示例来连接前面提到的Hypersonic数据库:

hibernate.connection.username=sa hibernate.connection.password= hibernate.connection.url=jdbc:hsqldb:/home/davor/hibernate/orders hibernate.connection.driver_class=org.hsqldb.jdbcDriver hibernate.dialect=net.sf.hibernate.dialect.HSQLDialect 

  适当地进行修改(例如,可能需要修改hibernate.connection.url),并保存到classpath中。

  这很容易,但那个test/hibernate/Product.hbm.xml资源是什么呢?它是一个XML文件,定义了Java对象如何被持久化(映射)到一个数据库。在该文件中,我们定义数据存储到哪个数据库表中,哪个字段映射到数据库表的哪个列,不同的对象如何互相关联,等等。让我们来看一下Product.hbm.xml。

<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE hibernate-mapping     PUBLIC "-//Hibernate/Hibernate Mapping DTD//EN"     "http://hibernate.sourceforge.net/hibernate-mapping-2.0.dtd">      <hibernate-mapping>     <class name="test.hibernate.Product"             table="products">                        <id name="id" type="string"              unsaved-value="null">             <column name="id" sql-type="char(32)"                      not-null="true"/>             <generator class="uuid.hex"/>         </id>         <property name="name">             <column name="name" sql-type="char(255)"                      not-null="true"/>         </property>         <property name="price">             <column name="price" sql-type="double"                      not-null="true"/>         </property>         <property name="amount">             <column name="amount" sql-type="integer"                      not-null="true"/>         </property>             </class> </hibernate-mapping> 

  它非常简单且易于理解。几个细节特别令人感兴趣:

  • <class name="test.hibernate.Product" table="products">,指出正在映射一个名为test.hibernate.Product的类到表products。
  • <id>元素及其子元素,定义Java类与数据库之间的连接。
  • <property>元素,定义每个字段存储到哪个列及其类型、名称等。

  <generator class="uuid.hex"/>元素乍一看不太好理解。但是知道了它是<id>的一个子元素后,它的作用就很明显了:由于应用程序不知道它的数据如何被持久化(我们一直这么说),我们需要一个没有任何业务含义的代理键帮助Hibernate操纵对象。新创建的Products没有那个id,Hibernate将为我们创建它们。我们选择使用UUID字符串,但它提供了许多ID生成器(顺序的、限定范围的,甚至是用户指派的,等等),而且还可以编写自己的ID生成器。

   现在,创建(复制、粘贴)Product.hbm.xml的内容,并把文件和test.hibernate.Product类放到同一个包内(例如,放置Product.java文件的目录),重新运行java test.InsertProduct Milk 100 1.99命令。现在我们看到更多的日志以及...没有其他东西了!它运行正常吗?在Session sess = sf.openSession(); 前和sess.close()后添加System.out.println(p),看一看Produc出了什么问题。重新运行程序。您将看到类似于如下内容的日志输出(ID数字肯定会不同的):

[Product] Milk(null) price=1.99 amount=100 [Product] Milk(40288081f907f42900f907f448460001) price=1.99 amount=100 

  Hibernate为我们创建了Product的id!让我们看一下Product是否存储到了数据库中。执行select * from products,数据库返回类似于以下内容的输出:

ID                              |NAME  |PRICE |AMOUNT | 40288081f907f42900f907f448460001|Milk  |1.99  |100    | 

  Product信息被成功地插入到了数据库中,我们甚至都还没有编写一行SQL语句!

  插入一些其他产品,例如面包、咖啡、啤酒等,这样就可以继续学习下面的教程。

  查找和加载产品

  查找和加载已经持久化的对象在Hibernate中非常简单。使用它的查询语言,我们可以很容易地通过ID、名称或其他属性获取一个对象(或对象集)。我们能够获取完整的对象或它的一部分属性。Hibernate将处理余下的工作,最后,我们将拥有相当有用的对象层次体系。我们来看一下test.FindProductByName类。

package test; import java.util.List; import net.sf.hibernate.Hibernate; import net.sf.hibernate.Session; import net.sf.hibernate.SessionFactory; import net.sf.hibernate.cfg.Configuration; import test.hibernate.Product; // 用法: // java test.FindProductByName name public class FindProductByName {     public static void main(String[] args) throws Exception {         // 执行的查询         String query =             "select product from product "             + "in class test.hibernate.Product "             + "where product.name=:name";         // 搜索的内容         String name = args[0];         // 初始化         Configuration cfg = new Configuration()                            .addClass(Product.class);         SessionFactory sf = cfg.buildSessionFactory();         // 打开会话         Session sess = sf.openSession();                  // 搜索并返回         List list = sess.find(query, name,                                Hibernate.STRING);         if (list.size() == 0) {             System.out.println("No products named "                                 + name);             System.exit(0);         }         Product p = (Product) list.get(0);         sess.close();         System.out.println("Found product: " + p);     } }

  在FindProductByName中有几点值得注意:

  • 有一个具有where子句的query字符串,这与标准SQL语句很相似。
  • 初始化Hibernate的方法与第一个示例中一样。这一次,我们有配置文件和映射文件。
  • sess.find()执行查询,并将提供的产品名称设置为类型Hibernate.STRING的搜索参数。
  • 作为结果,我们得到一个包含所找到的Product的java.util.List。
  • 使用Product p = (Product) list.get(0); 我们用通常的类型转换方法获取找到的对象。

  执行java test.FindProductByName Milk,查看显示在控制台中的内容。

  注意:查询是区分大小写的,所以搜索小写的milk将不会返回任何结果。使用lower()或upper()SQL函数来启用不区分大小写的搜索。在这种情况下,我们会在查询字符串中使用where lower(product.name)=lower(:name)。关于查询的详细内容,请参见。此外,如果不希望显示所有的INFO日志信息,可以修改log4j.properties文件,将日志等级设置为warn。

  更新和删除产品

  到现在为止,您应该对Hibernate的工作方式有了一个基本的了解,因此我们将缩短冗长的示例,只显示重要的部分。

  为了在单个事务中将所有产品的价格提高10%,我们可以编写如下的内容:

double percentage = Double.parseDouble(args[0])/100; sess = sf.openSession(); Transaction t = sess.beginTransaction(); // 列表包含产品 Iterator iter = list.iterator(); while (iter.hasNext()) {     Product p = (Product) iter.next();                 p.setPrice(p.getPrice() * (1 + percentage));     sess.saveOrUpdate(p);       } t.commit(); sess.close(); 

  最后,要删除Product,当然要调用sess.delete(product)。如果数据库关闭了autocommit,不要忘记调用commit()提交Transaction。

   现在,我们已经完成了针对单个对象的所有基本操作——创建、读取、更新和删除。看上去相当有趣,但我们可以做得更好。现在我们来学习如何操纵对象集而不需要编写SQL语句。所有的魔法都通过映射文件实现。

  Orders,OrderItems

  有时一个一个地操纵对象确实可行,但是我们希望能够级联加载和更新。现在我们来看如何做到这一点。

   我们需要同时检查Order和OrderItem。就如前面所提到的,我们添加一项Product到一个Order中,它将变成一个OrderItem。Order在内部保存一个OrderItem集。我们希望保存Order,让Hibernate来做其他工作:保存OrderItem和更新所添加的Product的可用库存(数量)。听起来很复杂,但实际上非常简单。Hibernate知道如何处理一对一、一对多、多对一和多对多方式中的相关对象。我们将从映射文件开始。

  Order.hbm.xml

<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE hibernate-mapping     PUBLIC "-//Hibernate/Hibernate Mapping DTD//EN"     "http://hibernate.sourceforge.net/hibernate-mapping-2.0.dtd"> <hibernate-mapping>     <class name="test.hibernate.Order" table="orders">         <id name="id" type="string" unsaved-value="null" >             <column name="id" sql-type="char(32)" not-null="true"/>             <generator class="uuid.hex"/>         </id>         <property name="date">          <column name="order_date"                   sql-type="datetime" not-null="true"/>         </property>         <property name="priceTotal">         <column name="price_total"                  sql-type="double" not-null="true"/>         </property>                  <set name="orderItems" table="order_items" inverse="true"  cascade="all">             <key column="order_id" />             <one-to-many class="test.hibernate.OrderItem" />         </set>              </class> </hibernate-mapping> 

  这个映射文件非常易于理解,除了最后一个元素<set>。它表示了不同类之间的连接,在我们的例子中,这些类是Order和OrderItem。属性和子元素很容易理解:一个Set类型的字段,名为orderItems(参见上面的Order源代码),它包含类型为test.hibernate.OrderItem的对象,正如<one-to-many>子元素所解释的那样。这些对象被持久化在表order_items中,order_id列包含OrderItem类型的对象的键。

   cascade="all"是一个非常重要的属性。它解释了在操纵连接到的对象时,Hibernate如何动作。在我们的例子中,当创建一个Order时,我们无疑希望它所有的OrderItem也被创建;当然,当一个Order被删除时,我们也希望它所有的OrderItem也被删除。Cascade属性还有另外三个选项(none、save-update和delete),我们将在下面的示例中看一下如何使用它们。

  OrderItem.hbm.xml

  这个对象比较有意思。它的实例自动在Order中创建,基本上不会存在于其外。然而,由于它们在创建Order时代表Product,所以我们需要它们。如果一项产品的价格改变了,我们无疑不希望所有相关的OrderItem以及Order的价格被改变。我们需要的只是在OrderItem创建时更新Product的可用库存。最后,当一项Order被删除时,其OrderItem也被删除,但我们不能改变Product!听上去很复杂,特别是要编写所有这些SQL语句的话。但Hibernate把它们压缩成了映射文件中的两行!

<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE hibernate-mapping     PUBLIC "-//Hibernate/Hibernate Mapping DTD//EN"     "http://hibernate.sourceforge.net/hibernate-mapping-2.0.dtd"> <hibernate-mapping>     <class name="test.hibernate.OrderItem"               table="order_items">         <id name="id" type="string" unsaved-value="null" >             <column name="id" sql-type="char(32)"                         not-null="true"/>             <generator class="uuid.hex"/>         </id>         <property name="orderId" insert="false"                       update="false">             <column name="order_id" sql-type="char(32)"                         not-null="true"/>         </property>         <property name="productId" insert="false"                       update="false">             <column name="product_id" sql-type="char(32)"                         not-null="true"/>         </property>         <property name="amount">             <column name="amount" sql-type="int"                         not-null="true"/>         </property>         <property name="price">             <column name="price" sql-type="double"                         not-null="true"/>         </property>         <many-to-one name="order"                   class="test.hibernate.Order"                   column="order_id" />         <many-to-one name="product"                   class="test.hibernate.Product"                   cascade="save-update"                   column="product_id"/>     </class> </hibernate-mapping> 

  到目前为止,我们了解了关于<id>和<property>元素的一切,但<many-to-one>是一个新元素。这个元素非常简单。第一个<many-to-one>元素指出OrderItem的名为order的字段是test.hibernate.Order类型,并且通过表order_items的order_id列来引用(参见class元素的table属性)。第二个many-to-one元素类似于第一个,除了它具有cascade="save-update"属性。它在定义的内容之前进行解释。在这个例子中,我们假设Hibernate只在保存(创建)或更新(更改)OrderItem时传递Product的更改,而在删除时不传递更改。因此,上述的复杂SQL语句就被压缩为单个属性!现在这个问题解决了!

  用法示例

  创建一个订单。在该示例中,我们创建并持久化一个订单。反复运行这个示例,查看产品数量在每次成功创建订单后如何变化。

// ... Configuration cfg = new Configuration()                     .addClass(Product.class)                     .addClass(Order.class)                     .addClass(OrderItem.class); // ... Order order = new Order(); order.addProduct(milk, 3); order.addProduct(coffee, 5); // ... sess = sf.openSession(); Transaction t = sess.beginTransaction(); sess.save(order); t.commit(); sess.close(); System.out.println(order); // ... 

  按照价格范围查找订单。在该示例中,我们将展示如何使用一个带有两个参数的查询。Hibernate正确地加载具有适当订单项和产品的订单。

// ... String query = "select o from o "     + "in class test.hibernate.Order "     + "where o.priceTotal > :priceTotalLower "     + "and o.priceTotal < :priceTotalUpper"; // ...                 Query q = sess.createQuery(query); q.setDouble("priceTotalLower",               Double.parseDouble(args[0])); q.setDouble("priceTotalUpper",               Double.parseDouble(args[1])); List list = q.list(); // ... sess.close(); // ... 

  删除一定价格范围内的订单。这是一个重要的示例。这里我们会看到Hibernate是一个多么智能的工具。正如前面所提到的,当删除一个订单时,其订单项也需要被删除,但不能改变产品。在运行该示例后,检查数据库,确认产品没有变化。

// ... String query = "select o from o "     + "in class test.hibernate.Order "     + "where o.priceTotal > :priceTotalLower "     + "and o.priceTotal < :priceTotalUpper"; Transaction tx = sess.beginTransaction(); sess.delete(query,      new Object[]{new Double(args[0]),                   new Double(args[1])},      new Type[]{Hibernate.DOUBLE,                 Hibernate.DOUBLE}            );        tx.commit(); sess.close(); 

  结束语

  本文展示了Hibernate有多么强大。您已经了解到可以多么轻松地持久化任何类型的Java对象、操纵对象层次结构、处理集合、使用事务。但Hibernate的功能不止于此。它可以处理使用提交和回滚的完整事务、继承、几种类型的集合,并提供非常强大的面向对象查询语言HQL,HQL支持关联和联结、多态、子查询等。接下来您可以阅读Hibernate参考文档,并着手在日常工作中使用Hibernate。

分享到
  • 微信分享
  • 新浪微博
  • QQ好友
  • QQ空间
点击: