Hibernate中Criteria的用法

作者：佚名 2009-06-26 16:15:04

本文講述Hibernate中Criteria的完整用法。作者最近在項(xiàng)目中使用 Spring 和 Hibernate 進(jìn)行開發(fā)，有感于 Criteria 比較好用，對 Hibernate的Criteria 的用法進(jìn)行了總結(jié)。

最近在項(xiàng)目中使用 Spring 和 Hibernate 進(jìn)行開發(fā)，有感于 Criteria 比較好用，在查詢方法設(shè)計(jì)上可以靈活的根據(jù) Criteria 的特點(diǎn)來方便地進(jìn)行查詢條件的組裝。現(xiàn)在對 Hibernate的Criteria的用法進(jìn)行總結(jié)：

Hibernate 設(shè)計(jì)了 CriteriaSpecification 作為 Criteria 的父接口，下面提供了 Criteria和DetachedCriteria 。

Criteria 和 DetachedCriteria 的主要區(qū)別在于創(chuàng)建的形式不一樣， Criteria 是在線的，所以它是由 Hibernate Session 進(jìn)行創(chuàng)建的；而 DetachedCriteria 是離線的，創(chuàng)建時(shí)無需Session，DetachedCriteria 提供了 2 個(gè)靜態(tài)方法 forClass(Class) 或 forEntityName(Name)進(jìn)行DetachedCriteria 實(shí)例的創(chuàng)建。 Spring 的框架提供了getHibernateTemplate().findByCriteria(detachedCriteria) 方法可以很方便地根據(jù)DetachedCriteria 來返回查詢結(jié)果。

Criteria 和 DetachedCriteria 均可使用 Criterion 和 Projection 設(shè)置查詢條件。可以設(shè)置 FetchMode( 聯(lián)合查詢抓取的模式 ) ，設(shè)置排序方式。對于 Criteria 還可以設(shè)置 FlushModel（沖刷 Session 的方式）和 LockMode （數(shù)據(jù)庫鎖模式）。

下面對 Criterion 和 Projection 進(jìn)行詳細(xì)說明。

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

Criterion 接口的主要實(shí)現(xiàn)包括： Example 、 Junction 和 Simpl********** 。而Junction 的實(shí)際使用是它的兩個(gè)子類 conjunction 和 disjunction ，分別是使用 AND 和 OR 操作符進(jìn)行來聯(lián)結(jié)查詢條件集合。

Criterion 的實(shí)例可以通過 Restrictions 工具類來創(chuàng)建，Restrictions 提供了大量的靜態(tài)方法，如 eq （等于）、 ge （大于等于）、 between 等來方法的創(chuàng)建 Criterion 查詢條件（Simpl********** 實(shí)例）。除此之外， Restrictions 還提供了方法來創(chuàng)建 conjunction 和disjunction 實(shí)例，通過往該實(shí)例的 add(Criteria) 方法來增加查詢條件形成一個(gè)查詢條件集合。

至于 Example 的創(chuàng)建有所不同， Example 本身提供了一個(gè)靜態(tài)方法 create(Objectentity) ，即根據(jù)一個(gè)對象（實(shí)際使用中一般是映射到數(shù)據(jù)庫的對象）來創(chuàng)建。然后可以設(shè)置一些過濾條件：

Example exampleUser =Example.create(u)  
.ignoreCase() // 忽略大小寫  
.enableLike(MatchMode.ANYWHERE);  
// 對 String 類型的屬性，無論在那里值在那里都匹配。相當(dāng)于 %value%

Project 主要是讓 Criteria 能夠進(jìn)行報(bào)表查詢，并可以實(shí)現(xiàn)分組。 Project 主要有SimpleProjection 、 ProjectionList 和 Property 三個(gè)實(shí)現(xiàn)。其中SimpleProjection 和ProjectionList 的實(shí)例化是由內(nèi)建的 Projections 來完成，如提供的 avg 、 count 、 max 、min 、 sum 可以讓開發(fā)者很容易對某個(gè)字段進(jìn)行統(tǒng)計(jì)查詢。

Property 是對某個(gè)字段進(jìn)行查詢條件的設(shè)置，如通過Porperty.forName(“color”).in(new String[]{“black”,”red”,”write”}); 則可以創(chuàng)建一個(gè) Project 實(shí)例。通過criteria 的 add(Project) 方法加入到查詢條件中去。

使用 Criteria 進(jìn)行查詢，主要要清晰的是 Hibernate 提供了那些類和方法來滿足開發(fā)中查詢條件的創(chuàng)建和組裝，下面介紹幾種用法：

1. 創(chuàng)建一個(gè)Criteria 實(shí)例

org.hibernate.Criteria接口表示特定持久類的一個(gè)查詢。Session是 Criteria實(shí)例的工廠。

Criteria crit = sess.createCriteria(Cat.class);  
crit.setMaxResults(50);  
List cats = crit.list();

2. 限制結(jié)果集內(nèi)容

一個(gè)單獨(dú)的查詢條件是org.hibernate.criterion.Criterion 接口的一個(gè)實(shí)例。

org.hibernate.criterion.Restrictions類 定義了獲得某些內(nèi)置Criterion類型的工廠方法。  
List cats = sess.createCriteria(Cat.class)  
.add( Restrictions.like("name", "Fritz%") )  
.add( Restrictions.between("weight", minWeight, maxWeight) )  
.list();

約束可以按邏輯分組。

org.hibernate.criterion.Restrictions類 定義了獲得某些內(nèi)置Criterion類型的工廠方法。  
List cats = sess.createCriteria(Cat.class)  
.add( Restrictions.like("name", "Fritz%") )  
.add( Restrictions.between("weight", minWeight, maxWeight) )  
.list();

Hibernate提供了相當(dāng)多的內(nèi)置criterion類型(Restrictions 子類), 但是尤其有用的是可以允許你直接使用SQL。

List cats = sess.createCriteria(Cat.class)  
.add( Restrictions.sql("lower({alias}.name) like lower(?)", "Fritz%",  
 
Hibernate.STRING) )  
.list();

{alias}占位符應(yīng)當(dāng)被替換為被查詢實(shí)體的列別名。

Property實(shí)例是獲得一個(gè)條件的另外一種途徑。你可以通過調(diào)用Property.forName() 創(chuàng)建一個(gè)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. 結(jié)果集排序

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

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. 關(guān)聯(lián)

你可以使用createCriteria()非常容易的在互相關(guān)聯(lián)的實(shí)體間建立約束。

List cats = sess.createCriteria(Cat.class)  
.add( Restrictions.like("name", "F%")  
.createCriteria("kittens")  
.add( Restrictions.like("name", "F%")  
.list();

注意第二個(gè) createCriteria()返回一個(gè)新的 Criteria實(shí)例，該實(shí)例引用kittens 集合中的元素。接下來，替換形態(tài)在某些情況下也是很有用的。

List cats = sess.createCriteria(Cat.class)  
.createAlias("kittens", "kt")  
.createAlias("mate", "mt")  
.add( Restrictions.eqProperty("kt.name", "mt.name") )  
.list();

(createAlias()并不創(chuàng)建一個(gè)新的 Criteria實(shí)例。)

Cat實(shí)例所保存的之前兩次查詢所返回的kittens集合是沒有被條件預(yù)過濾的。如果你希望只獲得符合條件的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. 動(dòng)態(tài)關(guān)聯(lián)抓取

你可以使用setFetchMode()在運(yùn)行時(shí)定義動(dòng)態(tài)關(guān)聯(lián)抓取的語義。

List cats = sess.createCriteria(Cat.class)  
.add( Restrictions.like("name", "Fritz%") )  
.setFetchMode("mate", FetchMode.EAGER)  
.setFetchMode("kittens", FetchMode.EAGER)  
.list();

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

6. 查詢示例

org.hibernate.criterion.Example類允許你通過一個(gè)給定實(shí)例構(gòu)建一個(gè)條件查詢。

Cat cat = new Cat();  
cat.setSex('F');  
cat.setColor(Color.BLACK);  
List results = session.createCriteria(Cat.class)  
.add( Example.create(cat) )  
.list();

版本屬性、標(biāo)識符和關(guān)聯(lián)被忽略。默認(rèn)情況下值為null的屬性將被排除。可以自行調(diào)整Example使之更實(shí)用。

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在關(guān)聯(lián)對象上放置條件。

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 的實(shí)例工廠。我們通過調(diào)用setProjection()應(yīng)用投影到一個(gè)查詢。

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

在一個(gè)條件查詢中沒有必要顯式的使用 "group by" 。某些投影類型就是被定義為分組投影，他們也出現(xiàn)在SQL的group by子句中。

可以選擇把一個(gè)別名指派給一個(gè)投影，這樣可以使投影值被約束或排序所引用。下面是兩種不同的實(shí)現(xiàn)方式：

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()方法簡便的將一個(gè)投影實(shí)例包裝到另外一個(gè) 別名的Projection實(shí)例中。簡而言之，當(dāng)你添加一個(gè)投影到一個(gè)投影列表中時(shí) 你可以為它指定一個(gè)別名：

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類使你在一個(gè)session范圍之外創(chuàng)建一個(gè)查詢，并且可以使用任意的 Session來執(zhí)行它。

DetachedCriteria query = DetachedCriteria.forClass(Cat.class)  
.add( Property.forName("sex").eq('F') );  
//創(chuàng)建一個(gè)Session  
Session session = .;  
Transaction txn = session.beginTransaction();  
List results = query.getExecutableCriteria(session).setMaxResults(100).list();  
txn.commit();  
session.close();

DetachedCriteria也可以用以表示子查詢。條件實(shí)例包含子查詢可以通過 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();

相互關(guān)聯(lián)的子查詢也是有可能的：

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

責(zé)任編輯：book05 來源：百度博客

Criteria的用法 Hibernate