Hibernate 中 Criteria 的完整用法

1， Criteria

Hibernate 設計了 CriteriaSpecification 作為 Criteria 的父接口，下面提供了 Criteria和DetachedCriteria 。

2， DetachedCriteria

Spring 的架構提供了getHibernateTemplate().findByCriteria(detachedCriteria) 方法可以很友善地根據DetachedCriteria 來傳回查詢結果。

DetachedCriteria 提供了 2 個靜态方法 forClass(Class) 或 forEntityName(Name)進行DetachedCriteria 執行個體的建立。

3， Criteria 和 DetachedCriteria

Criteria 和 DetachedCriteria 的主要差別在于建立的形式不一樣， Criteria 是線上的，是由 Hibernate Session 進行建立的；

而 DetachedCriteria 是離線的，建立時無需Session。

Criteria 和 DetachedCriteria 均可使用 Criterion 和 Projection 設定查詢條件。可以設定 FetchMode( 聯合查詢抓取的模式 ) ，設定排序方式。對于 Criteria 還可以設定 FlushModel（沖刷 Session 的方式）和 LockMode （資料庫鎖模式）。

4， Criterion 和 Projection

   1>概念

Criterion 是 Criteria 的查詢條件。Criteria 提供了 add(Criterion criterion) 方法來 添加查詢條件。

Criterion 接口的主要實作包括： Example 、 Junction 和 SimpleExpression 。

Junction 的實際使用是它的兩個子類 conjunction 和 disjunction ，分别是使用 AND 和 OR 操 作符進行來聯結查詢條件集合。

     2>建立

Criterion 的執行個體可以通過 Restrictions 工具類來建立，Restrictions 提供了大量的靜态 方法，如 eq （等于）、 ge （大于等于）、 between 等來方法的建立 Criterion 查詢條件

（SimpleExpression 執行個體）。除此之外， Restrictions 還提供了方法來建立 conjunction 和 disjunction 執行個體，通過往該執行個體的 add(Criteria) 方法來增加查詢條件形成一個查詢條件集合 。

至于 Example 的建立有所不同， Example 本身提供了一個靜态方法 create(Object entity) ，即根據一個對象（實際使用中一般是映射到資料庫的對象）來建立。然後可以設定一些 過濾條件：

Example exampleUser =Example.create(u)

.ignoreCase() // 忽略大小寫

.enableLike(MatchMode.ANYWHERE); // 對 String 類型的屬性，無論在那裡值在那裡都比對。相當于 %value%

Project 主要是讓 Criteria 能夠進行報表查詢，并可以實作分組。 Project 主要有 SimpleProjection 、 ProjectionList 和 Property 三個實作。其中 SimpleProjection 和

ProjectionList 的執行個體化是由内建的 Projections 來完成，如提供的 avg 、 count 、 max 、 min 、 sum 可以讓開發者很容易對某個字段進行統計查詢。

  Property 是對某個字段進行查詢條件的設定，如通過Porperty.forName(“color”).in (new String[]{“black”,”red”,”write”}); 則可以建立一個 Project 執行個體。通過 criteria 的 add(Project) 方法加入到查詢條件中去。

5，應用

使用 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)查詢和子查詢

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();