Hibernate中Criteria攻略詳解
最近在項目中使用 Spring 和 Hibernate 進行開發(fā),有感于Hibernate Criteria 比較好用,在查詢方法設計上可以靈活的根據(jù) Criteria 的特點來方便地進行查詢條件的組裝。本人對此進行了整理,希望讀者能夠借鑒。
現(xiàn)在對Hibernate Criteria 的用法進行總結(jié):
Hibernate 設計了 CriteriaSpecification 作為 Criteria 的父接口,下面提供了 Criteria和DetachedCriteria 。Criteria 和 DetachedCriteria 的主要區(qū)別在于創(chuàng)建的形式不一樣, Criteria 是在線的,所以它是由 Hibernate Session 進行創(chuàng)建的;而 DetachedCriteria 是離線的,創(chuàng)建時無需 Session,DetachedCriteria 提供了 2 個靜態(tài)方法 forClass(Class) 或 forEntityName(Name) 進行DetachedCriteria 實例的創(chuàng)建。 Spring 的框架提供了getHibernateTemplate().findByCriteria(detachedCriteria) 方法可以很方便地根據(jù)DetachedCriteria 來返回查詢結(jié)果。
Criteria 和 DetachedCriteria 均可使用 Criterion 和 Projection 設置查詢條件??梢栽O置 FetchMode( 聯(lián)合查詢抓取的模式 ) ,設置排序方式。對于 Criteria 還可以設置 FlushModel (沖刷 Session 的方式)和 LockMode (數(shù)據(jù)庫鎖模式)。
下面對 Hibernate Criterion 和 Projection 進行詳細說明。
Hibernate Criterion 是 Criteria 的查詢條件。Criteria 提供了 add(Criterion criterion) 方法來添加查詢條件。
Hibernate Criterion 接口的主要實現(xiàn)包括: Example 、 Junction 和 SimpleExpression 。而 Junction 的實際使用是它的兩個子類 conjunction 和 disjunction ,分別是使用 AND 和 OR 操作符進行來聯(lián)結(jié)查詢條件集合。Criterion 的實例可以通過 Restrictions 工具類來創(chuàng)建,Restrictions 提供了大量的靜態(tài)方法,如 eq (等于)、 ge (大于等于)、 between 等來方法的創(chuàng)建 Criterion 查詢條件(SimpleExpression 實例)。
除此之外, Restrictions 還提供了方法來創(chuàng)建 conjunction 和disjunction 實例,通過往該實例的 add(Criteria) 方法來增加查詢條件形成一個查詢條件集合。至于 Example 的創(chuàng)建有所不同, Example 本身提供了一個靜態(tài)方法 create(Object entity) ,即根據(jù)一個對象(實際使用中一般是映射到數(shù)據(jù)庫的對象)來創(chuàng)建。然后可以設置一些過濾條件:
- Example exampleUser =Example.create(u)
- .ignoreCase() // 忽略大小寫
- .enableLike(MatchMode.ANYWHERE);
- // 對 String 類型的屬性,無論在那里值在那里都匹配。相當于 %value%
Project 主要是讓 Criteria 能夠進行報表查詢,并可以實現(xiàn)分組。 Project 主要有SimpleProjection 、 ProjectionList 和 Property 三個實現(xiàn)。其中 SimpleProjection 和ProjectionList 的實例化是由內(nèi)建的 Projections 來完成,如提供的 avg 、 count 、 max 、min 、 sum 可以讓開發(fā)者很容易對某個字段進行統(tǒng)計查詢。Property 是對某個字段進行查詢條件的設置,如通過Porperty.forName(“color”).in(new String[]{“black”,”red”,”write”}); 則可以創(chuàng)建一個 Project 實例。通過
criteria 的 add(Project) 方法加入到查詢條件中去。使用 Criteria 進行查詢,主要要清晰的是 Hibernate 提供了那些類和方法來滿足開發(fā)中查詢條件的創(chuàng)建和組裝,下面介紹幾種用法:
1. 創(chuàng)建一個Criteria 實例
org.hibernate.Criteria接口表示特定持久類的一個查詢。Session是 Criteria實例的工廠。
- Criteria crit = sess.createCriteria(Cat.class);
- crit.setMaxResults(50);
- List cats = crit.list();
2. 限制結(jié)果集內(nèi)容
一個單獨的查詢條件是org.hibernate.criterion.Criterion 接口的一個實例。
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();
約束可以按邏輯分組。
- 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提供了相當多的內(nèi)置criterion類型(Restrictions 子類), 但是尤其有用的是可以允許你直接使用SQL。
- List cats = sess.createCriteria(Cat.class)
- .add( Restrictions.sql("lower({alias}.name) like lower(?)", "Fritz%",
- Hibernate.STRING) )
- .list();
{alias}占位符應當被替換為被查詢實體的列別名。
Property實例是獲得一個條件的另外一種途徑。你可以通過調(diào)用Property.forName() 創(chuàng)建一個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. 關聯(lián)
你可以使用createCriteria()非常容易的在互相關聯(lián)的實體間建立約束。
- List cats = sess.createCriteria(Cat.class)
- .add( Restrictions.like("name", "F%")
- .createCriteria("kittens")
- .add( Restrictions.like("name", "F%")
- .list();
注意第二個 createCriteria()返回一個新的 Criteria實例,該實例引用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)建一個新的 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. 動態(tài)關聯(lián)抓取
你可以使用setFetchMode()在運行時定義動態(tài)關聯(lián)抓取的語義。
- 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類允許你通過一個給定實例 構(gòu)建一個條件查詢。
- org.hibernate.criterion.Example類允許你通過一個給定實例 構(gòu)建一個條件查詢。
- Cat cat = new Cat();
- cat.setSex('F');
- cat.setColor(Color.BLACK);
- List results = session.createCriteria(Cat.class)
- .add( Example.create(cat) )
- .list();
版本屬性、標識符和關聯(lián)被忽略。默認情況下值為null的屬性將被排除。
可以自行調(diào)整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在關聯(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 的實例工廠。我們通過調(diào)用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();
【編輯推薦】