Hibernate3的DetachedCriteria支持

Hibernate3支持DetachedCriteria，这是一个非常有意义的特性！我们知道，在常规的Web编程中，有大量的动态条件查询，即用户在网页上面自由选择某些条件，程序根据用户的选择条件，动态生成SQL语句，进行查询。

　　针对这种需求，对于分层应用程序来说，Web层需要传递一个查询的条件列表给业务层对象，业务层对象获得这个条件列表之后，然后依次取出条件，构造查询语句。这里的一个难点是条件列表用什么来构造？传统上使用Map，但是这种方式缺陷很大，Map可以传递的信息非常有限，只能传递name和value，无法传递究竟要做怎样的条件运算，究竟是大于，小于，like，还是其它的什么，业务层对象必须确切掌握每条entry的隐含条件。因此一旦隐含条件改变，业务层对象的查询构造算法必须相应修改，但是这种查询条件的改变是隐式约定的，而不是程序代码约束的，因此非常容易出错。

　　DetachedCriteria可以解决这个问题，即在web层，程序员使用DetachedCriteria来构造查询条件，然后将这个DetachedCriteria作为方法调用参数传递给业务层对象。而业务层对象获得DetachedCriteria之后，可以在session范围内直接构造Criteria，进行查询。就此，查询语句的构造完全被搬离到web层实现，而业务层则只负责完成持久化和查询的封装即可，与查询条件构造完全解耦，非常完美！这恐怕也是以前很多企图在web层代码中构造HQL语句的人想实现的梦想吧！

　　示例代码片段如下：

　　web层程序构造查询条件：

　　java代码:

DetachedCriteria detachedCriteria = DetachedCriteria.forClass(Department.class);
detachedCriteria.add(Restrictions.eq("name", "department")).createAlias("employees", "e").add(Restrictions.gt(("e.age"), new Integer(20)));

　　Department和Employee是一对多关联，查询条件为：

　　名称是“department”开发部门；
　　部门里面的雇员年龄大于20岁；

　　业务层对象使用该条件执行查询：

　　java代码:

detachedCriteria.getExecutableCriteria(session).list();

　　最大的意义在于，业务层代码是固定不变的，所有查询条件的构造都在web层完成，业务层只负责在session内执行之。这样代码就可放之四海而皆准，都无须修改了。

　　然而Spring和Hibernate3的DetachedCriteria有不兼容的问题，因此在Spring环境下面使用Hibernate3需要注意：

　　Spring的HibernateTemplate提供了Hibernate的完美封装，即通过匿名类实现回调，来保证Session的自动资源管理和事务的管理。其中核心方法是：

　　java代码:

HibernateTemplate.execute(new HibernateCallback() {
　public Object doInHibernate(Session session) throws HibernateException {
　　....
　}
}

　　回调方法提供了session作为参数，有了session，就可以自由的使用Hibernate API编程了。使用了spring的之后，代码修改如下：

　　web层代码：

　　java代码:

DetachedCriteria detachedCriteria = DetachedCriteria.forClass(Department.class);
detachedCriteria.createAlias("employees", "e").add(Restrictions.eq("name", "department")).add(Restrictions.gt(("e.age"), new Integer(20)));
departmentManager.findByCriteria(detachedCriteria);

　　构造detachedCriteria，作为参数传递给departmentManager

　　业务层代码使用spring，DepartmentManager的findByCriteria如下：

　　java代码:

public List findByCriteria(final DetachedCriteria detachedCriteria) {
　return (List) getHibernateTemplate().execute(new HibernateCallback() {
　　public Object doInHibernate(Session session) throws HibernateException {
　　　Criteria criteria = detachedCriteria.getExecutableCriteria(session);
　　　return criteria.list();
　　}
　});
}

　　实际上也就是：

　　java代码:

Criteria criteria = detachedCriteria.getExecutableCriteria(session);
return criteria.list();

　　而已

　　但是该程序代码执行，会抛出强制类型转换异常！

　　我跟踪了一下spring和Hibernate源代码，原因如下：

　　spring的HibernateTemplate的execute方法提供的回调接口具有Session作为参数，但是实际上，默认情况下，HibernateTemplate传递给回调接口的session并不是org.hibernate.impl.SessionImpl类，而是SessionImpl类的一个Proxy类。之所以替换成为一个Proxy类，HibernateTemplate的注释说明，Proxy提供了一些额外的功能，包括自动设置Cachable，Transaction的超时时间，Session资源的更积极的关闭等等。

　　java代码:

private boolean exposeNativeSession = false;
...

　　execute方法内部：

Session sessionToExpose = (exposeNativeSession ? session : createSessionProxy(session));

　　但是遗憾的是，Hibernate的DetachedCriteria的setExecutableCriteria方法却要求将session参数强制转为SessionImpl，但是spring传过来的却是一个Proxy类，因此就报错了。

　　java代码:

public Criteria getExecutableCriteria(Session session) {
　impl.setSession( (SessionImpl) session ); // 要求SessionImpl，Spring传递的是Proxy
　return impl;
}

　　解决方法，禁止Spring的HibernateTemplate传递Proxy类，强制要求它传递真实的SessionImpl类，即给exexute方法增加一个参数，提供参数为true，如下：

　　java代码:

public List findByCriteria(final DetachedCriteria detachedCriteria) {
　return (List) getHibernateTemplate().execute(new HibernateCallback() {
　　public Object doInHibernate(Session session) throws HibernateException {
　　　Criteria criteria = detachedCriteria.getExecutableCriteria(session);
　　　return criteria.list();
　　}
　}, true);
}

评论

1 楼 dolphin_ygj 2009-06-20  

Hibernate3的DetachedCriteria使用
Criteria對SQL進行封裝，讓開發人員可以用物件的方式來對資料庫進行操作，例如下面的查詢User表格中的所有資料：

Criteria criteria = session.createCriteria(User.class);
// 查詢user所有欄位
List users = criteria.list();
Iterator iterator =  users.iterator();
System.out.println("id \t name/age");
while(iterator.hasNext()) {
    User user = (User) iterator.next();
    System.out.println(user.getId() +
                               " \t " + user.getName() +
                               "/" + user.getAge());           
}


Hibernate實際上使用以下的SQL來查詢資料庫：

select this_.id as id0_, this_.name as name0_0_, this_.age as age0_0_ from user this_


Criteria實際上只是個容器，如果想要設定查詢條件，則要使用add()方法加入Restrictions的條件限制，例如查詢age大於20且小於40的資料：

Criteria criteria = session.createCriteria(User.class);
criteria.add(Restrictions.gt("age", new Integer(20)));
criteria.add(Restrictions.lt("age", new Integer(40)));
List users = criteria.list();


您也可以使用邏輯組合來進行查詢，例如結合age等於（eq）20或（or）age為空（isNull）的條件：

Criteria criteria = session.createCriteria(User.class);
criteria.add(Restrictions.or(
                   Restrictions.eq("age", new Integer(20)),
                   Restrictions.isNull("age")
               ));
List users = criteria.list();


也可以使用sqlRestriction()方法來提供SQL語法作限定查詢，例如查詢name以cater開頭的資料：

Criteria criteria = session.createCriteria(User.class);
criteria.add(Restrictions.sqlRestriction("{alias}.name LIKE (?)", "cater%", Hibernate.STRING));
List users = criteria.list();


其中alias將被替換為與User類別相關的名稱，而?將被替換為cater%，也就是第二個參數所提供的值，在SQL撰寫時，不必再寫WHERE，如果有多個查詢條件，例如BETWEEN子句的查詢，則可以如下：

Criteria criteria = session.createCriteria(User.class);
Integer[] ages = {new Integer(20), new Integer(40)};
Type[] types = {Hibernate.INTEGER, Hibernate.INTEGER};
criteria.add(Restrictions.sqlRestriction("{alias}.age BETWEEN (?) AND (?)", ages, types));
List users = criteria.list();


Restrictions的幾個常用限定查詢方法如下表所示：
方法 說明
Restrictions.eq             等於
Restrictions.allEq          使用Map，使用key/value進行多個等於的比對
Restrictions.gt             大於 >
Restrictions.ge             大於等於 >=
Restrictions.lt             小於 <
Restrictions.le             小於等於 <=
Restrictions.between        對應SQL的BETWEEN子句
Restrictions.like           對應SQL的LIKE子句
Restrictions.in             對應SQL的in子句
Restrictions.and            and關係
Restrictions.or             or關係
Restrictions.sqlRestriction SQL限定查詢






==============



Hibernate Criteria 关联查询
前面讲了Criteria看起来比HQL顺眼多了，接着继续。

如果每个美女都有自己的客户资源（不要想歪了！），那么需要查询拥有客户Gates的美女怎么办？

使用Criteria可以有两种方法：

1：
DetachedCriteria beautyCriteria = DetachedCriteria.forClass(Beauty.class).createCriteria("customers");
beautyCriteria.add(Restrictions.eq("name", "Gates")):

2：
DetachedCriteria beautyCriteria = DetachedCriteria.forClass(Beauty.class).createAlias("customers", "c");
beautyCriteria.add(Restrictions.eq("c.name", "Gates")):

接着有了新的要求，年纪太大的美女不要，还是查找拥有客户Gates的，条件如下：
DetachedCriteria beautyCriteria = DetachedCriteria.forClass(Beauty.class, "b").;
DetachedCriteria customerCriteria = beautyCriteria.createAlias("customers", c");
beautyCriteria.add(Restrictions.le("b.age", new Long(20))):
customerCriteria.add(Restrictions.eq("c.name", "Gates")):

关于Criteria更详细的资料，Hibernate的源代码和测试是最好的文档。

Criteria的缺点？DBA很生气，后果很严重。