Hibernate中Criteria攻略详解

 Hibernate Criterion是Criteria的查询条件。Criteria 提供了add(Criterion criterion)方法来添加查询条件。Hibernate Criterion接口的主要实现包括:Example、Junction和SimpleExpression 。

 最近在项目中使用 Spring 和 Hibernate 进行开发,有感于Hibernate Criteria 比较好用,在查询方法设计上可以灵活的根据 Criteria 的特点来方便地进行查询条件的组装。本人对此进行了整理,希望读者能够借鉴。

现在对Hibernate Criteria 的用法进行总结:

  Hibernate 设计了 CriteriaSpecification 作为 Criteria 的父接口,下面提供了 Criteria和DetachedCriteria 。Criteria 和 DetachedCriteria 的主要区别在于创建的形式不一样, Criteria 是在线的,所以它是由 Hibernate Session 进行创建的;而 DetachedCriteria 是离线的,创建时无需 Session,DetachedCriteria 提供了 2 个静态方法 forClass(Class) 或 forEntityName(Name) 进行DetachedCriteria 实例的创建。 Spring 的框架提供了getHibernateTemplate().findByCriteria(detachedCriteria) 方法可以很方便地根据DetachedCriteria 来返回查询结果。

  Criteria 和 DetachedCriteria 均可使用 Criterion 和 Projection 设置查询条件。可以设置 FetchMode( 联合查询抓取的模式 ) ,设置排序方式。对于 Criteria 还可以设置 FlushModel (冲刷 Session 的方式)和 LockMode (数据库锁模式)。

下面对 Hibernate Criterion 和 Projection 进行详细说明。

  Hibernate Criterion 是 Criteria 的查询条件。Criteria 提供了 add(Criterion criterion) 方法来添加查询条件。
Hibernate Criterion 接口的主要实现包括: Example 、 Junction 和 SimpleExpression 。而 Junction 的实际使用是它的两个子类 conjunction 和 disjunction ,分别是使用 AND 和 OR 操作符进行来联结查询条件集合。Criterion 的实例可以通过 Restrictions 工具类来创建,Restrictions 提供了大量的静态方法,如 eq (等于)、 ge (大于等于)、 between 等来方法的创建 Criterion 查询条件(SimpleExpression 实例)。

 除此之外, Restrictions 还提供了方法来创建 conjunction 和disjunction 实例,通过往该实例的 add(Criteria) 方法来增加查询条件形成一个查询条件集合。至于 Example 的创建有所不同, Example 本身提供了一个静态方法 create(Object entity) ,即根据一个对象(实际使用中一般是映射到数据库的对象)来创建。然后可以设置一些过滤条件:

 
  1. Example exampleUser =Example.create(u)
  2. .ignoreCase() // 忽略大小写
  3. .enableLike(MatchMode.ANYWHERE);
  4. // 对 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) 方法加入到查询条件中去。使用 Criteria 进行查询,主要要清晰的是 Hibernate 提供了那些类和方法来满足开发中查询条件的创建和组装,下面介绍几种用法:

1. 创建一个Criteria 实例
org.hibernate.Criteria接口表示特定持久类的一个查询。Session是 Criteria实例的工厂。

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

2. 限制结果集内容
一个单独的查询条件是org.hibernate.criterion.Criterion 接口的一个实例。

org.hibernate.criterion.Restrictions类 定义了获得某些内置Criterion类型的工厂方法。

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

约束可以按逻辑分组。

 
  1. List cats = sess.createCriteria(Cat.class)
  2. .add( Restrictions.like("name", "Fritz%") )
  3. .add( Restrictions.or(
  4. Restrictions.eq( "age", new Integer(0) ),
  5. Restrictions.isNull("age")
  6. ) )
  7. .list();
  8. List cats = sess.createCriteria(Cat.class)
  9. .add( Restrictions.in( "name", new String[] { "Fritz", "Izi", "Pk" } ) )
  10. .add( Restrictions.disjunction()
  11. .add( Restrictions.isNull("age") )
  12. .add( Restrictions.eq("age", new Integer(0) ) )
  13. .add( Restrictions.eq("age", new Integer(1) ) )
  14. .add( Restrictions.eq("age", new Integer(2) ) )
  15. ) )
  16. .list();

Hibernate提供了相当多的内置criterion类型(Restrictions 子类), 但是尤其有用的是可以允许你直接使用SQL。

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

{alias}占位符应当被替换为被查询实体的列别名。
Property实例是获得一个条件的另外一种途径。你可以通过调用Property.forName() 创建一个Property。

 
  1. Property age = Property.forName("age");
  2. List cats = sess.createCriteria(Cat.class)
  3. .add( Restrictions.disjunction()
  4. .add( age.isNull() )
  5. .add( age.eq( new Integer(0) ) )
  6. .add( age.eq( new Integer(1) ) )
  7. .add( age.eq( new Integer(2) ) )
  8. ) )
  9. .add( Property.forName("name").in( new String[] { "Fritz", "Izi", "Pk" } ) )
  10. .list();

3. 结果集排序
你可以使用org.hibernate.criterion.Order来为查询结果排序。

 
  1. List cats = sess.createCriteria(Cat.class)
  2. .add( Restrictions.like("name", "F%")
  3. .addOrder( Order.asc("name") )
  4. .addOrder( Order.desc("age") )
  5. .setMaxResults(50)
  6. .list();
  7. List cats = sess.createCriteria(Cat.class)
  8. .add( Property.forName("name").like("F%") )
  9. .addOrder( Property.forName("name").asc() )
  10. .addOrder( Property.forName("age").desc() )
  11. .setMaxResults(50)
  12. .list();

4. 关联
你可以使用createCriteria()非常容易的在互相关联的实体间建立约束。

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

注意第二个 createCriteria()返回一个新的 Criteria实例,该实例引用kittens 集合中的元素。
接下来,替换形态在某些情况下也是很有用的。

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

(createAlias()并不创建一个新的 Criteria实例。)
Cat实例所保存的之前两次查询所返回的kittens集合是 没有被条件预过滤的。如果你希望只获得符合条件的kittens, 你必须使用returnMaps()。

 
  1. List cats = sess.createCriteria(Cat.class)
  2. .createCriteria("kittens", "kt")
  3. .add( Restrictions.eq("name", "F%") )
  4. .returnMaps()
  5. .list();
  6. Iterator iter = cats.iterator();
  7. while ( iter.hasNext() ) {
  8. Map map = (Map) iter.next();
  9. Cat cat = (Cat) map.get(Criteria.ROOT_ALIAS);
  10. Cat kitten = (Cat) map.get("kt");
  11. }

5. 动态关联抓取
你可以使用setFetchMode()在运行时定义动态关联抓取的语义。

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

这个查询可以通过外连接抓取mate和kittens。

6. 查询示例
org.hibernate.criterion.Example类允许你通过一个给定实例 构建一个条件查询。

 
  1. org.hibernate.criterion.Example类允许你通过一个给定实例 构建一个条件查询。
  2. Cat cat = new Cat();
  3. cat.setSex('F');
  4. cat.setColor(Color.BLACK);
  5. List results = session.createCriteria(Cat.class)
  6. .add( Example.create(cat) )
  7. .list();

版本属性、标识符和关联被忽略。默认情况下值为null的属性将被排除。
可以自行调整Example使之更实用。

 
  1. Example example = Example.create(cat)
  2. .excludeZeroes() //exclude zero valued properties
  3. .excludeProperty("color") //exclude the property named "color"
  4. .ignoreCase() //perform case insensitive string comparisons
  5. .enableLike(); //use like for string comparisons
  6. List results = session.createCriteria(Cat.class)
  7. .add(example)
  8. .list();

甚至可以使用examples在关联对象上放置条件。

 
  1. List results = session.createCriteria(Cat.class)
  2. .add( Example.create(cat) )
  3. .createCriteria("mate")
  4. .add( Example.create( cat.getMate() ) )
  5. .list();

7. 投影(Projections)、聚合(aggregation)和分组(grouping)
org.hibernate.criterion.Projections是 Projection 的实例工厂。我们通过调用setProjection()应用投影到一个查询。

 
  1. List results = session.createCriteria(Cat.class)
  2. .setProjection( Projections.rowCount() )
  3. .add( Restrictions.eq("color", Color.BLACK) )
  4. .list();
  5. List results = session.createCriteria(Cat.class)
  6. .setProjection( Projections.projectionList()
  7. .add( Projections.rowCount() )
  8. .add( Projections.avg("weight") )
  9. .add( Projections.max("weight") )
  10. .add( Projections.groupProperty("color") )
  11. )
  12. .list();