org.hibernate.criterion.DetachedCriteria的用法

一 Hibernate 設計了 CriteriaSpecification 作為 Criteria 的父接口，下面提供了 Criteria和DetachedCriteria 。
   1 Criteria 和 DetachedCriteria 的主要區別在于創建的形式不一樣， Criteria 是在線的，所
以它是由 Hibernate Session 進行創建的；而 DetachedCriteria 是離線的，創建時無需Session，DetachedCriteria 提供了 2 個靜態方法 forClass(Class) 或 forEntityName(Name)
進行DetachedCriteria 實例的創建。 Spring 的框架提供了getHibernateTemplate().findByCriteria(detachedCriteria) 方法可以很方便地根據DetachedCriteria 來返回查詢結果。
   2 Criteria 和 DetachedCriteria 均可使用 Criterion 和 Projection 設置查詢條件。可以設
置 FetchMode( 聯合查詢抓取的模式 ) ，設置排序方式。對于 Criteria 還可以設置 FlushModel
（沖刷 Session 的方式）和 LockMode （數據庫鎖模式）。
二 下面對 Criterion 和 Projection 進行詳細說明：
   1 Criterion 是 Criteria 的查詢條件。Criteria 提供了 add(Criterion criterion) 方法來
添加查詢條件。
   2 Criterion 接口的主要實現包括： Example 、 Junction 和 SimpleExpression 。而
Junction 的實際使用是它的兩個子類 conjunction 和 disjunction ，分別是使用 AND 和 OR 操
作符進行來聯結查詢條件集合。
   3 Criterion 的實例可以通過 Restrictions 工具類來創建，Restrictions 提供了大量的靜態
方法，如 eq （等于）、 ge （大于等于）、 between 等來方法的創建 Criterion 查詢條件
（SimpleExpression 實例）。除此之外， Restrictions 還提供了方法來創建 conjunction 和
disjunction 實例，通過往該實例的 add(Criteria) 方法來增加查詢條件形成一個查詢條件集合。
   4 至于 Example 的創建有所不同， Example 本身提供了一個靜態方法 create(Object entity)，
即根據一個對象（實際使用中一般是映射到數據庫的對象）來創建。然后可以設置一些過濾條件：
Example exampleUser =Example.create(u).ignoreCase() // 忽略大小寫
                                      .enableLike(MatchMode.ANYWHERE);
           // 對 String 類型的屬性，無論在那里值在那里都匹配。相當于 %value%
   5 Project 主要是讓 Criteria 能夠進行報表查詢，并可以實現分組。 Project 主要有
SimpleProjection 、 ProjectionList 和 Property 三個實現。其中 SimpleProjection 和
ProjectionList 的實例化是由內建的 Projections 來完成，如提供的 avg 、 count 、 max 、
min 、 sum 可以讓開發者很容易對某個字段進行統計查詢。
   6 Property 是對某個字段進行查詢條件的設置，如通過Porperty.forName(“color”).in
(new String[]{“black”,”red”,”write”}); 則可以創建一個 Project 實例。通過
criteria 的 add(Project) 方法加入到查詢條件中去。
   使用 Criteria 進行查詢，主要要清晰的是 Hibernate 提供了那些類和方法來滿足開發中查
詢條件的創建和組裝，下面介紹幾種用法：
   1. 創建一個Criteria 實例
   org.hibernate.Criteria接口表示特定持久類的一個查詢。Session是 Criteria實例的工廠。
   Criteria crit = sess.createCriteria(Cat.class);
   crit.setMaxResults(50);
   List cats = crit.list();
 
   2. 限制結果集內容
   一個單獨的查詢條件是org.hibernate.criterion.Criterion 接口的一個實例。
   org.hibernate.criterion.Restrictions類 定義了獲得某些內置Criterion類型的工廠方法。

   List cats = sess.createCriteria(Cat.class)
                   .add( Restrictions.like("name", "Fritz%") )
                   .add( Restrictions.between("weight", minWeight, maxWeight) )
                   .list();

   約束可以按邏輯分組。

 

List cats = sess.createCriteria(Cat.class)

    .add( Restrictions.like("name", "Fritz%") )

    .add( Restrictions.or(

        Restrictions.eq( "age", new Integer(0) ),

        Restrictions.isNull("age")

    ) )

    .list();

 

List cats = sess.createCriteria(Cat.class)

    .add( Restrictions.in( "name", new String[] { "Fritz", "Izi", "Pk" } ) )

    .add( Restrictions.disjunction()

        .add( Restrictions.isNull("age") )

        .add( Restrictions.eq("age", new Integer(0) ) )

        .add( Restrictions.eq("age", new Integer(1) ) )

        .add( Restrictions.eq("age", new Integer(2) ) )

    ) )

    .list();

 

Hibernate提供了相當多的內置criterion類型(Restrictions 子類), 但是尤其有用的是可以允許

你直接使用SQL。

 

List cats = sess.createCriteria(Cat.class)

    .add( Restrictions.sql("lower({alias}.name) like lower(?)", "Fritz%",

Hibernate.STRING) )

    .list();

 

{alias}占位符應當被替換為被查詢實體的列別名。

Property實例是獲得一個條件的另外一種途徑。你可以通過調用Property.forName() 創建一個

Property。

 

  Property age = Property.forName("age");

List cats = sess.createCriteria(Cat.class)

    .add( Restrictions.disjunction()

        .add( age.isNull() )

        .add( age.eq( new Integer(0) ) )

        .add( age.eq( new Integer(1) ) )

        .add( age.eq( new Integer(2) ) )

    ) )

    .add( Property.forName("name").in( new String[] { "Fritz", "Izi", "Pk" } ) )

    .list();

 

3. 結果集排序

你可以使用org.hibernate.criterion.Order來為查詢結果排序。

 

List cats = sess.createCriteria(Cat.class)

    .add( Restrictions.like("name", "F%")

    .addOrder( Order.asc("name") )

    .addOrder( Order.desc("age") )

    .setMaxResults(50)

    .list();

 

List cats = sess.createCriteria(Cat.class)

    .add( Property.forName("name").like("F%") )

    .addOrder( Property.forName("name").asc() )

    .addOrder( Property.forName("age").desc() )

    .setMaxResults(50)

    .list();

 

4. 關聯

你可以使用createCriteria()非常容易的在互相關聯的實體間建立 約束。

 

List cats = sess.createCriteria(Cat.class)

    .add( Restrictions.like("name", "F%")

    .createCriteria("kittens")

        .add( Restrictions.like("name", "F%")

    .list();

 

注意第二個 createCriteria()返回一個新的 Criteria實例，該實例引用kittens 集合中的元素。

接下來，替換形態在某些情況下也是很有用的。

 

List cats = sess.createCriteria(Cat.class)

    .createAlias("kittens", "kt")

    .createAlias("mate", "mt")

    .add( Restrictions.eqProperty("kt.name", "mt.name") )

    .list();

 

(createAlias()并不創建一個新的 Criteria實例。)

Cat實例所保存的之前兩次查詢所返回的kittens集合是 沒有被條件預過濾的。如果你希望只獲得

符合條件的kittens， 你必須使用returnMaps()。

 

List cats = sess.createCriteria(Cat.class)

    .createCriteria("kittens", "kt")

    .add( Restrictions.eq("name", "F%") )

    .returnMaps()

    .list();

Iterator iter = cats.iterator();

while ( iter.hasNext() ) {

    Map map = (Map) iter.next();

    Cat cat = (Cat) map.get(Criteria.ROOT_ALIAS);

    Cat kitten = (Cat) map.get("kt");

}

5. 動態關聯抓取

你可以使用setFetchMode()在運行時定義動態關聯抓取的語義。

 

List cats = sess.createCriteria(Cat.class)

    .add( Restrictions.like("name", "Fritz%") )

    .setFetchMode("mate", FetchMode.EAGER)

    .setFetchMode("kittens", FetchMode.EAGER)

    .list();

 

這個查詢可以通過外連接抓取mate和kittens。

 

6. 查詢示例

org.hibernate.criterion.Example類允許你通過一個給定實例 構建一個條件查詢。

 

Cat cat = new Cat();

cat.setSex('F');

cat.setColor(Color.BLACK);

List results = session.createCriteria(Cat.class)

    .add( Example.create(cat) )

    .list();

 

版本屬性、標識符和關聯被忽略。默認情況下值為null的屬性將被排除。

可以自行調整Example使之更實用。

 

Example example = Example.create(cat)

    .excludeZeroes()           //exclude zero valued properties

    .excludeProperty("color")  //exclude the property named "color"

    .ignoreCase()              //perform case insensitive string comparisons

    .enableLike();             //use like for string comparisons

List results = session.createCriteria(Cat.class)

    .add(example)

    .list();

 

甚至可以使用examples在關聯對象上放置條件。

 

List results = session.createCriteria(Cat.class)

    .add( Example.create(cat) )

    .createCriteria("mate")

        .add( Example.create( cat.getMate() ) )

    .list();

 

7. 投影(Projections)、聚合（aggregation）和分組（grouping）

org.hibernate.criterion.Projections是 Projection 的實例工廠。我們通過調用

setProjection()應用投影到一個查詢。

 

List results = session.createCriteria(Cat.class)

    .setProjection( Projections.rowCount() )

    .add( Restrictions.eq("color", Color.BLACK) )

    .list();

 

List results = session.createCriteria(Cat.class)

    .setProjection( Projections.projectionList()

        .add( Projections.rowCount() )

        .add( Projections.avg("weight") )

        .add( Projections.max("weight") )

        .add( Projections.groupProperty("color") )

    )

    .list();



在一個條件查詢中沒有必要顯式的使用 "group by" 。某些投影類型就是被定義為 分組投影，他

們也出現在SQL的group by子句中。

可以選擇把一個別名指派給一個投影，這樣可以使投影值被約束或排序所引用。下面是兩種不同的

實現方式：

 

List results = session.createCriteria(Cat.class)

    .setProjection( Projections.alias( Projections.groupProperty("color"), "colr" ) )

    .addOrder( Order.asc("colr") )

    .list();

 



List results = session.createCriteria(Cat.class)

    .setProjection( Projections.groupProperty("color").as("colr") )

    .addOrder( Order.asc("colr") )

    .list();

 

alias()和as()方法簡便的將一個投影實例包裝到另外一個 別名的Projection實例中。簡而言之，

當你添加一個投影到一個投影列表中時 你可以為它指定一個別名：

 

List results = session.createCriteria(Cat.class)

    .setProjection( Projections.projectionList()

        .add( Projections.rowCount(), "catCountByColor" )

        .add( Projections.avg("weight"), "avgWeight" )

        .add( Projections.max("weight"), "maxWeight" )

        .add( Projections.groupProperty("color"), "color" )

    )

    .addOrder( Order.desc("catCountByColor") )

    .addOrder( Order.desc("avgWeight") )

    .list();

 

List results = session.createCriteria(Domestic.class, "cat")

    .createAlias("kittens", "kit")

    .setProjection( Projections.projectionList()

        .add( Projections.property("cat.name"), "catName" )

        .add( Projections.property("kit.name"), "kitName" )

    )

    .addOrder( Order.asc("catName") )

    .addOrder( Order.asc("kitName") )

    .list();

 

也可以使用Property.forName()來表示投影：

 

List results = session.createCriteria(Cat.class)

    .setProjection( Property.forName("name") )

    .add( Property.forName("color").eq(Color.BLACK) )

    .list();

List results = session.createCriteria(Cat.class)

    .setProjection( Projections.projectionList()

        .add( Projections.rowCount().as("catCountByColor") )

        .add( Property.forName("weight").avg().as("avgWeight") )

        .add( Property.forName("weight").max().as("maxWeight") )

        .add( Property.forName("color").group().as("color" )

    )

    .addOrder( Order.desc("catCountByColor") )

    .addOrder( Order.desc("avgWeight") )

    .list();

 

8. 離線(detached)查詢和子查詢

   在web層，程序員使用DetachedCriteria來構造查詢條件，然后將這個DetachedCriteria作為方法調用參數傳遞給業務層對象。而業務層對象獲得DetachedCriteria之后，可以在session范圍內直接構造Criteria，進行查詢。就此，查詢語句的構造完全被搬離到web層實現，而業務層則只負責完成持久化和查詢的封裝即可，與查詢條件構造完全解耦，非常完美！這恐怕也是以前很多企圖在web層代碼中構造HQL語句的人想實現的夢想吧！

DetachedCriteria類使你在一個session范圍之外創建一個查詢，并且可以使用任意的 Session來

執行它。

 

DetachedCriteria query = DetachedCriteria.forClass(Cat.class)

    .add( Property.forName("sex").eq('F') );

//創建一個Session

Session session = .;

Transaction txn = session.beginTransaction();

List results = query.getExecutableCriteria(session).setMaxResults(100).list();

txn.commit();

session.close();

 

DetachedCriteria也可以用以表示子查詢。條件實例包含子查詢可以通過 Subqueries或者

Property獲得。

 

DetachedCriteria avgWeight = DetachedCriteria.forClass(Cat.class)

    .setProjection( Property.forName("weight").avg() );

session.createCriteria(Cat.class)

    .add( Property.forName("weight).gt(avgWeight) )

    .list();

DetachedCriteria weights = DetachedCriteria.forClass(Cat.class)

    .setProjection( Property.forName("weight") );

session.createCriteria(Cat.class)

    .add( Subqueries.geAll("weight", weights) )

    .list();

相互關聯的子查詢也是有可能的：

DetachedCriteria avgWeightForSex = DetachedCriteria.forClass(Cat.class, "cat2")

    .setProjection( Property.forName("weight").avg() )

    .add( Property.forName("cat2.sex").eqProperty("cat.sex") );

session.createCriteria(Cat.class, "cat")

    .add( Property.forName("weight).gt(avgWeightForSex) )

    .list();

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

 

本文來自CSDN博客，轉載請標明出處：http://blog.csdn.net/kjfcpua/archive/2009/06/21/4287248.aspx
-----------------------------------------------------------------------------------------
Hibernate一直都認為比較簡單 就那么影射一下：）但最近項目當中遇見很多問題，今天看見別人在項目當中使用了　Hibernate3的DetachedCriteria，感覺真的是太好了，于是就花了點時間研究了一下，希望和大家分享一下吧
　　針對這種需求，對于分層應用程序來說，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);
}