Hibernate中Criteria的完整用法

hibernate中criteria的完整用法

criteria

英[kraɪˈtɪərɪə]

美[kraɪˈtɪrɪə]

标准

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 （数据库锁模式）。 
下面对 criterion 和 projection 进行详细说明。 

4，criterion 和 projection 
     a,概念
criterion 是 criteria 的查询条件。criteria 提供了 add(criterion criterion) 方法来 
添加查询条件。 
criterion 接口的主要实现包括： example 、 junction 和 simpleexpression 。
junction 的实际使用是它的两个子类 conjunction 和 disjunction ，分别是使用 and 和 or 操 
作符进行来联结查询条件集合。 
     b,创建
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(); 


补充：
criteria.add(expression.eq("status",new integer(status))); 
criteria.add(expression.in("status", optparm.getquerystatus()));