2005 年 1 月

Hibernate 是一个流行的开源对象关系映射工具，单元测试和持续集成的重要性也得到了广泛的推广和认同，在采用了Hibernate的项目中如何保证测试的自动化和持续性呢？本文讨论了Hibernate加载其配置文件hibernate.properties和hibernate.cfg.xml的过程，以及怎么样将hibernate提供的配置文件的访问方法灵活运用到单元测试中。

1 介绍
Hibernate 是一个流行的开源对象关系映射工具，单元测试和持续集成的重要性也得到了广泛的推广和认同，在采用了Hibernate的项目中如何保证测试的自动化和持续性呢？本文讨论了Hibernate加载其配置文件hibernate.properties和hibernate.cfg.xml的过程，以及怎么样将hibernate提供的配置文件的访问方法灵活运用到单元测试中。注意：本文以hibernate2.1作为讨论的基础，不保证本文的观点适合于其他版本。

2 读者
Java开发人员，要求熟悉JUnit和掌握Hibernate的基础知识

3 内容

3.1.准备
对于hibernate的初学者来说，第一次使用hibernate的经验通常是：

1， 安装配置好Hibernate，我们后面将%HIBERNATE_HOME%作为对Hibernate安装目录的引用，

2， 开始创建好自己的第一个例子，例如hibernate手册里面的类Cat，

3， 配置好hbm映射文件（例如Cat.hbm.xml，本文不讨论这个文件内配置项的含义）和数据库（如hsqldb），

4， 在项目的classpath路径下添加一个hibernate.cfg.xml文件，如下(第一次使用hibernate最常见的配置内容)：

<?xml version="1.0" encoding="utf-8"?>
<!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.url">jdbc:hsqldb:hsql://localhost</property>
<property name="connection.driver_class">org.hsqldb.jdbcDriver</property>
<property name="connection.username">sa</property>
<property name="connection.password"></property>
<property name="dialect">net.sf.hibernate.dialect.HSQLDialect</property>

        <property name="hibernate.show_sql">false</property>

        <mapping resource="Cat.hbm.xml"/>

</session-factory>
</hibernate-configuration>

5， 然后还需要提供一个类来测试一下创建，更新，删除和查询Cat，对于熟悉JUnit的开发人员，可以创建一个单元测试类来进行测试，如下：

import junit.framework.TestCase;
import net.sf.hibernate.HibernateException;
import net.sf.hibernate.Session;
import net.sf.hibernate.Transaction;
import net.sf.hibernate.cfg.Configuration;


public class CatTest extends TestCase {

    private Session session;
    private Transaction tx;

    protected void setUp() throws Exception {
        Configuration cfg = new Configuration().configure();////注意这一行，这是本文重点讨论研究的地方。
        session = cfg.buildSessionFactory().openSession();
        tx = session.beginTransaction();
    }

    protected void tearDown() throws Exception {
  tx.commit();
  session.close();
    }
    
    public void testCreate()  {
     //请在此方法内添加相关的代码，本文不讨论怎么样使用Hibernate API。
    }
    public void testUpdate()  {
     //请在此方法内添加相关的代码，本文不讨论怎么样使用Hibernate API。
    }
    public void testDelete()  {
     //请在此方法内添加相关的代码，本文不讨论怎么样使用Hibernate API。
    }
    public void testQuery()  {
     //请在此方法内添加相关的代码，本文不讨论怎么样使用Hibernate API。
    }

}

3.2 new Configuration()都做了什么？
对于第一次使用hibernate的新手来说，下面的这段代码可以说是最常见的使用Configuration方式。

Configuration cfg = new Configuration().configure();

Configuration是hibernate的入口，在新建一个Configuration的实例的时候，hibernate会在classpath里面查找hibernate.properties文件，如果该文件存在，则将该文件的内容加载到一个Properties的实例GLOBAL_PROPERTIES里面，如果不存在，将打印信息

hibernate.properties not found

然后是将所有系统环境变量（System.getProperties()）也添加到GLOBAL_PROPERTIES里面（注1）。如果hibernate.properties文件存在，系统还会验证一下这个文件配置的有效性，对于一些已经不支持的配置参数，系统将打印警告信息。

3.3. configure()在做什么？
new Configuration()讨论至此，下面讨论configure()方法。

configure()方法默认会在classpath下面寻找hibernate.cfg.xml文件，如果没有找到该文件，系统会打印如下信息并抛出HibernateException异常。

hibernate.cfg.xml not found

如果找到该文件，configure()方法会首先访问< session-factory >，并获取该元素的name属性，如果非空，将用这个配置的值来覆盖hibernate.properties的hibernate.session_factory_name的配置的值，从这里我们可以看出，hibernate.cfg.xml里面的配置信息可以覆盖hibernate.properties的配置信息。

接着configure()方法访问<session-factory>的子元素，首先将使用所有的<property>元素配置的信息（注2），如前面我们使用的配置文件

    <property name="connection.url">jdbc:hsqldb:hsql://localhost</property>
  <property name="connection.driver_class">org.hsqldb.jdbcDriver</property>
  <property name="connection.username">sa</property>
  <property name="connection.password"></property>
  <property name="dialect">net.sf.hibernate.dialect.HSQLDialect</property>
  

会覆盖hibernate.properties里面对应的配置，hibernate2.1发布包里面自带的hibernate.properties文件（位于%HIBERNATE_HOME%/etc下面）里面的值，如下：

hibernate.dialect net.sf.hibernate.dialect.HSQLDialect
hibernate.connection.driver_class org.hsqldb.jdbcDriver
hibernate.connection.username sa
hibernate.connection.password
hibernate.connection.url jdbc:hsqldb:hsql://localhost

然后configure()会顺序访问以下几个元素的内容

<mapping>
<jcs-class-cache>
<jcs-collection-cache>
<collection-cache>

其中<mapping>是必不可少的，必须通过配置<mapping>，configure()才能访问到我们定义的java对象和关系数据库表的映射文件（hbm.xml），例如：

<mapping resource="Cat.hbm.xml"/>

通过以上的分析，我们对hibernate配置文件hibernate.properties和hibernate.cfg.xml的默认的加载过程就比较清楚了。

3.4 Configuration的其他用法
Configuration的configure ()方法还支持带参数的访问方式，你可以指定hbm.xml文件的位置，而不是使用默认的classpath下面的hibernate.cfg.xml这种方式，例如：

Configuration cfg = new Configuration().configure("myexample.xml");

同时Configuration还提供了一系列方法用来定制hibernate的加载配置文件的过程，让你的应用更加灵活，常用的是以下几种：

addProperties(Element)
addProperties(Properties)
setProperties(Properties)
setProperty(String, String)

通过以上几个方法，除了使用默认的hibernate.properties文件，你还可以提供多个.properties配置文件，使用Hibernate的时候根据不同的情况使用不同的配置文件，例如：

Properties properties = Properties.load("my.properties");
Configuration config = new Configuration().setProperties(properties).configure();

除了指定.properties文件之外，还可以指定.hbm.xml文件，下面列出几个常用的方法：

addClass(Class)
addFile(File)
addFile(String)
addURL(URL)

前面我们已经讲了，configure()方法默认是通过访问hibernate.cfg.xml的<mapping>元素来加载我们提供的.hbm.xml文件，上面列出的方法可以直接指定hbm.xml文件，例如addClass()方法可以直接通过指定class来加载对应的映射文件，hibernate会将提供的class的全名（包括package）自动转化为文件路径，如net.sf.hibernate.examples.quickstart.Cat.class对应了net/sf/hibernate/examples/quickstart/Cat.hbm.xml，还可以用addFile方法直接指定映射文件。

例一：

Configuration config = new Configuration().addClass(Cat.class);

例二：

Configuration config = new Configuration().addURL(Configuration.class.getResource ("Cat.hbm.xml"));

例三：

Configuration config = new Configuration().addFile("Cat.hbm.xml");

3.5 总结
Configuration提供的这些方法的好处如下：

1． 一个应用中往往有很多.hbm.xml映射文件，开发的过程中如果只是为了测试某个或几个Java PO(Persistence Object)，我们没有必要把所有的.hbm.xml都加载到内存，这样可以通过addClass或者addFile直接，显得非常灵活。

2． 学习Hibernate的过程中，往往需要通过练习来体会Hibernate提供的各种特征，而很多特征是需要修改配置文件的，如果要观察相同的代码在不同的特征下的表现，就需要手工改配置文件，这样太麻烦了，而且容易出错，我们可以提供多个配置文件，每个配置文件针对需要的特征而配置，这样我们在调用程序的时候，把不同的配置文件作为参数传递进去，而程序代码里面使用setProperties和addFile指定传入的配置文件参数就可以了。

3． 在单元测试中，特别是在集成测试里面，整个过程是自动化的，我们不能手工干预测试过程，往往需要准备多个配置文件针对不同的测试案例，这个时候setProperties和addFile方法就显得特别有用了，在不同的测试案例中用这些方法来指定相应的配置文件，这样就可以做到自动化测试，保证了持续性。

3.6 应用举例
在刚开始学习hibernate的时候，对于hibernate的hbm映射文件里的各种配置参数没有一个感性的认识，例如inverse="true",lazy="true"这样的配置参数，不通过实践是无法体会到其作用的，传统的方法就是每需要测试一种参数的效果就更改相应的配置文件，然后运行测试来观察结果，如果能够灵活的运用Configuration提供的定制配置的方法，我们可以提供多个配置文件，每个配置文件里面有不同的配置参数，配合相应的测试案例就方便多了。

例如针对ono-to-many和many-to-one的双向关联的映射关系，我们想测试在one-to-many一方使用inverse="false"和inverse="true"的不同效果，假设已经正确的配置好了hibernate.properties，那么还需要提供两个不同的hbm.xml文件，假设分别名为bidirect.inverse.false.hbm.xml和bidirect.inverse.true.hbm.xml。

然后需要写两个不同的测试案例，分别针对两个不同的配置文件进行测试就可以了，这样的好处是，不用针对不同的测试案例修改配置文件，特别是在集成测试的时候，一切都是自动化的，如果每测试一个案例就需要手工去更改配置文件，这肯定是一个失败的测试。

代码模板如下：

FalseInverseTest.java文件
import junit.framework.TestCase;
import net.sf.hibernate.HibernateException;
import net.sf.hibernate.Session;
import net.sf.hibernate.Transaction;
import net.sf.hibernate.cfg.Configuration;

/**
 * test false inverse
 */
public class FalseInverseTest extends TestCase {

    private Session session;
    private Transaction tx;

    protected void setUp() throws Exception {
        Configuration cfg = new Configuration().addFile("bidirect.inverse.false.hbm.xml");
        session = cfg.buildSessionFactory().openSession();
        tx = session.beginTransaction();
    }

    protected void tearDown() throws Exception {
tx.commit();
      session.close();
    }
    
    public void testLogic()  {
     //在此编写测试代码
    }

}

TrueInverseTest.java文件

import junit.framework.TestCase;
import net.sf.hibernate.HibernateException;
import net.sf.hibernate.Session;
import net.sf.hibernate.Transaction;
import net.sf.hibernate.cfg.Configuration;

/**
 * test true inverse
 */
public class TrueInverseTest extends TestCase {

    private Session session;
    private Transaction tx;

    protected void setUp() throws Exception {
        Configuration cfg = new Configuration().addFile("bidirect.inverse.true.hbm.xml");
        session = cfg.buildSessionFactory().openSession();
        tx = session.beginTransaction();
    }

    protected void tearDown() throws Exception {
      tx.commit();
      session.close();
    }
    
    public void testLogic()  {
     //在此编写测试代码
    }

}

结束语
通过对Hibernate默认的配置文件的加载顺序和Hibernate提供的加载配置文件的方法的讨论，我们对在使用到Hibernate的项目的单元测试中使用多个Hibernate配置文件有了比较清楚的认识。

持续集成中的测试的特征是自动化和持续性，不能手工干预其过程，在使用到Hibernate的项目如果要实现持续集成，就要为不同的测试案例提供不同的配置文件，而不是针对不同的测试案例进行手工调整，因此，在使用到Hibernate的项目中灵活的运用多配置文件，可以提高测试的效率，保证自动化和持续性。

注1：有关的代码请参考Environment类的static{}。

注2：如果在hibernate.cfg.xml的<property/>配置的name没有以hibernate开头，那么configure()内部会自动在前面添加hibernate，例如connection.url，hibernate会自动将其转化为hibernate.connection.url。

参考资料

• 官方hibernate reference 地址：http://hibernate.org
  

1.cascade="..."？

cascade属性并不是多对多关系一定要用的，有了它只是让我们在插入或删除对像时更方便一些，只要在cascade的源头上插入或是删除，所有cascade的关系就会被自己动的插入或是删除。便是为了能正确的cascade，unsaved-value是个很重要的属性。

Hibernate通过这个属性来判断一个对象应该save还是update，如果这龆韵蟮膇d是unsaved-value的话，那说明这个对象不是persistence object要save（insert)；如果id是非unsaved-value的话，那说明这个对象是persistence object（数据库中已存在），只要update就行了。saveOrUpdate方法用的也是这个机制。

2.inverse="ture"?

inverse属性默认是false的，就是说关系的两端都来维护关系。这个意思就是说，如有一个Student, Teacher和TeacherStudent表，Student和Teacher是多对多对多关系，这个关系由TeacherStudent这个表来表现。那么什么时候插入或删除TeacherStudent表中的记录来维护关系呢？在用hibernate时，我们不会显示的对TeacherStudent表做操作。

对TeacherStudent的操作是hibernate帮我们做的。hibernate就是看hbm文件中指定的是"谁"维护关系，那个在插入或删除"谁"时，就会处发对关系表的操作。前提是"谁"这个对象已经知道这个关系了，就是说关系另一头的对象已经set或是add到"谁"这个对象里来了。前面说过inverse默认是false，就是关系的两端都维护关系，对其中任一个操作都会处发对表系表的操作。当在关系的一头，如Student中的bag或set中用了inverse＝"true"时，那就代表关系是由另一关维护的（Teacher）。就是说当这插入Student时，不会操作TeacherStudent表，即使Student已经知道了关系。只有当Teacher插入或删除时才会处发对关系表的操作。

所以，当关系的两头都用inverse="true"是不对的，就会导致任何操作都不处发对关系表的操作。当两端都是inverse="false"或是default值是，在代码对关系显示的维护也是不对的，会导致在关系表中插入两次关系。在一对多关系中inverse就更有意义了。在多对多中，在哪端inverse="true"效果差不多（在效率上）。但是在一对多中，如果要一方维护关系，就会使在插入或是删除"一"方时去update"多"方的每一个与这个"一"的对象有关系的对象。

而如果让"多"方面维护关系时就不会有update操作，因为关系就是在多方的对象中的，直指插入或是删除多方对象就行了。当然这时也要遍历"多"方的每一个对象显示的操作修关系的变化体现到DB中。不管怎样说，还是让"多"方维护关系更直观一些。

3.cascade和inverse有什么区别？

可以这样理解，cascade定义的是关系两端对象到对象的级联关系；而inverse定义的是关系和对象的级联关系。

4.net.sf.hibernate.ObjectDeletedException: deleted object would be re-saved by cascade (remove deleted object from associations): 2, of class: Xxxxx

这个问题出现在要删除关系的一头时。如，要删除一个已经和Student有关系的Teacher。当tx.commit();时才会抛出这个异常。这时一个在关系另一头的Student对象中的Set或是List中把这个Teacher对象显示的remove掉，再session.delete(这个teacher);。这是为了防止在Student端有cascade时把这个Teacher对象再存回DB。

所以，这个异常的只有在Student的关系定义中有cascade="..."，而且没有像上面说的显示的解除关系时才会出现。所以防止出现这个异常的方法就是：1，在Student端不用cascade；2，或是用cascade的话，就显示的删除对像中的关系。 3，在Teacher端要用cascade。

5.net.sf.hibernate.HibernateException: identifier of an instance of my.MyObject altered from N to N

这个异常其实不是多对多中常遇到的，但是这个异常的提示不make sense，所以提一下，是因为id的java对象中的type和hbm文件中定义的不一样，如：java中用long，而hbm中用type="integer"，并且generator用的是identity时就会出现。

下面把Customer.hbm.xml文件的<class>元素的lazy属性设为true，表示使用延迟检索策略：

<class name="mypack.Customer" table="CUSTOMERS" lazy="true">

当执行Session的load()方法时，Hibernate不会立即执行查询CUSTOMERS表的select语句，仅仅返回Customer类的代理类的实例，这个代理类具由以下特征：

（1） 由Hibernate在运行时动态生成，它扩展了Customer类，因此它继承了Customer类的所有属性和方法，但它的实现对于应用程序是透明的。
（2） 当Hibernate创建Customer代理类实例时，仅仅初始化了它的OID属性，其他属性都为null，因此这个代理类实例占用的内存很少。
（3） 当应用程序第一次访问Customer代理类实例时（例如调用customer.getXXX()或customer.setXXX()方法），Hibernate会初始化代理类实例，在初始化过程中执行select语句，真正从数据库中加载Customer对象的所有数据。但有个例外，那就是当应用程序访问Customer代理类实例的getId()方法时，Hibernate不会初始化代理类实例，因为在创建代理类实例时OID就存在了，不必到数据库中去查询。

提示：Hibernate采用CGLIB工具来生成持久化类的代理类。CGLIB是一个功能强大的Java字节码生成工具，它能够在程序运行时动态生成扩展Java类或者实现Java接口的代理类。关于CGLIB的更多知识，请参考：http://cglib.sourceforge.net/。

以下代码先通过Session的load()方法加载Customer对象，然后访问它的name属性：

tx = session.beginTransaction();
Customer customer=(Customer)session.load(Customer.class,new Long(1));
customer.getName();
tx.commit();

在运行session.load()方法时Hibernate不执行任何select语句，仅仅返回Customer类的代理类的实例，它的OID为1，这是由load()方法的第二个参数指定的。当应用程序调用customer.getName()方法时，Hibernate会初始化Customer代理类实例，从数据库中加载Customer对象的数据，执行以下select语句：

select * from CUSTOMERS where ID=1;
select * from ORDERS where CUSTOMER_ID=1;

当<class>元素的lazy属性为true，会影响Session的load()方法的各种运行时行为，下面举例说明。

1．如果加载的Customer对象在数据库中不存在，Session的load()方法不会抛出异常，只有当运行customer.getName()方法时才会抛出以下异常：

ERROR LazyInitializer:63 - Exception initializing proxy
net.sf.hibernate.ObjectNotFoundException: No row with the given identifier exists: 1, of class:
mypack.Customer

2．如果在整个Session范围内，应用程序没有访问过Customer对象，那么Customer代理类的实例一直不会被初始化，Hibernate不会执行任何select语句。以下代码试图在关闭Session后访问Customer游离对象：

tx = session.beginTransaction();
Customer customer=(Customer)session.load(Customer.class,new Long(1));
tx.commit();
session.close();
customer.getName();

由于引用变量customer引用的Customer代理类的实例在Session范围内始终没有被初始化，因此在执行customer.getName()方法时，Hibernate会抛出以下异常：

ERROR LazyInitializer:63 - Exception initializing proxy
net.sf.hibernate.HibernateException: Could not initialize proxy - the owning Session was closed

由此可见，Customer代理类的实例只有在当前Session范围内才能被初始化。

3．net.sf.hibernate.Hibernate类的initialize()静态方法用于在Session范围内显式初始化代理类实例，isInitialized()方法用于判断代理类实例是否已经被初始化。例如：

tx = session.beginTransaction();
Customer customer=(Customer)session.load(Customer.class,new Long(1));
if(!Hibernate.isInitialized(customer))
Hibernate.initialize(customer);
tx.commit();
session.close();
customer.getName();

以上代码在Session范围内通过Hibernate类的initialize()方法显式初始化了Customer代理类实例，因此当Session关闭后，可以正常访问Customer游离对象。

4．当应用程序访问代理类实例的getId()方法时，不会触发Hibernate初始化代理类实例的行为，例如：

tx = session.beginTransaction();
Customer customer=(Customer)session.load(Customer.class,new Long(1));
customer.getId();
tx.commit();
session.close();
customer.getName();

当应用程序访问customer.getId()方法时，该方法直接返回Customer代理类实例的OID值，无需查询数据库。由于引用变量customer始终引用的是没有被初始化的Customer代理类实例，因此当Session关闭后再执行customer.getName()方法，Hibernate会抛出以下异常：

ERROR LazyInitializer:63 - Exception initializing proxy
net.sf.hibernate.HibernateException: Could not initialize proxy - the owning Session was closed