(3) Hibernate的查询 标准(Criteria)查询

Hibernate的查询 标准(Criteria)查询

1 一个简单例子：

Java代码  

 @SuppressWarnings("unchecked")

public void searchByPropertys() {

Session session = this.getSession();

Criteria crit = session.createCriteria(Conft.class);

List<Conft> list = crit.list();

for(Conft c : list){

System.out.println(c.getId());

}

}

标准查询API最终仍然翻译为SQL交由数据库处理，返回java.util.List对象

 

怎么增加条件呢？请看如下代码：

Java代码  

public void searchByPropertys() {

Session session = this.getSession();

Criteria crit = session.createCriteria(Conft.class);

crit.add(Restrictions.eq("id", 2)); // =

crit.add(Restrictions.ne("id", 2)); // !=

crit.add(Restrictions.lt("id", 2)); // <

crit.add(Restrictions.gt("id", 2)); // >

crit.add(Restrictions.le("id", 2)); // <=

crit.add(Restrictions.ge("id", 2)); // >=

crit.add(Restrictions.in("id", new String[]{"2"})); // in

crit.add(Restrictions.like("id", "%2%")); // like

crit.add(Restrictions.like("id", "2",MatchMode.ANYWHERE)); // %x%

crit.add(Restrictions.like("id", "2",MatchMode.START)); // x%

crit.add(Restrictions.like("id", "2",MatchMode.END)); // %x

crit.add(Restrictions.like("id", "2",MatchMode.EXACT)); // x

List<Conft> list = crit.list();

for(Conft c : list){

System.out.println(c.getId());

}

} 

代码后面写出了增加条件的方式和意思。

 

如果有and或者是or的关系的话，可以使用Conjunction(AND)和Disjunction(OR)！

下面是一个使用示例：

Java代码  

public void searchByPropertys() {

Session session = this.getSession();

Criteria crit = session.createCriteria(Conft.class);

// 创建条件

Criterion a = Restrictions.gt("id", 2); // >

Criterion b = Restrictions.lt("id", 2); // <

Criterion c = Restrictions.like("id", "2",MatchMode.ANYWHERE);

// and 关系

Conjunction conjunction = Restrictions.conjunction();

conjunction.add(a);

conjunction.add(b);

// or 关系

Disjunction disjunction = Restrictions.disjunction();

disjunction.add(conjunction);

disjunction.add(c);

// 增加查询条件

crit.add(disjunction);

List<Conft> list = crit.list();

for(Conft conft : list){

System.out.println(conft.getId());

}

} 

a和b是AND关系，而a和b合起来作为条件后和c是OR关系！

如果看他的SQL的话，是这样的，有助于理解：

Java代码  

(where (a>? and b<?) or c like ?)

除此之外还可以使用sqlRestriction方法直接拼接SQL

Java代码  

 public User getUserById(int pk){

Session session = this.getSession();

Criteria crit = session.createCriteria(User.class);

crit.add(Restrictions.sqlRestriction(" {alias}.id=2 "));

List<User> list = crit.list();

return (User)list.get(0);

}

 

注意{alias}是表的名称，这个不用修改，Hibernate在生成SQL时会自动替换！

在源码中可以看到：

Java代码  

public static Criterion sqlRestriction(String sql, Object values[], Type types[])

{

    return new SQLCriterion(sql, values, types);

}

public static Criterion sqlRestriction(String sql, Object value, Type type)

{

    return new SQLCriterion(sql, new Object[] {

        value

    }, new Type[] {

        type

    });

}

public static Criterion sqlRestriction(String sql)

{

    return new SQLCriterion(sql, ArrayHelper.EMPTY_OBJECT_ARRAY, ArrayHelper.EMPTY_TYPE_ARRAY);

} 

也就是说这个方法有三个调用方式，直接写SQL，如果你的SQL中有 ？ 作为占位符，那么可设置后面两个参数，第二个参数对应 ？ ，第三个是参数字段的类型！

如果有多个
？　，那么第二和第三个参数就要用数组的形式来传递！

 

 

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.sqlRestriction("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， 你必须使用ResultTransformer。 

List cats = sess.createCriteria(Cat.class)

   .createCriteria("kittens", "kt")

       .add( Restrictions.eq("name", "F%") )

   .setResultTransformer(Criteria.ALIAS_TO_ENTITY_MAP)

   .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。 查看第 19.1 节 “ 抓取策略(Fetching strategies) ”可以获得更多信息。 

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 = ....;

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

9 根据自然标识查询(Queries by natural identifier)
对大多数查询，包括条件查询而言，因为查询缓存的失效(invalidation)发生得太频繁，查询缓存不是非常高效。然而，有一种特别的查询，可以通过不变的自然键优化缓存的失效算法。在某些应用中，这种类型的查询比较常见。条件查询API对这种用例提供了特别规约。 

首先，你应该对你的entity使用<natural-id>来映射自然键，然后打开第二级缓存。 

<class name="User">

   <cache usage="read-write"/>

   <id name="id">

       <generator class="increment"/>

   </id>

   <natural-id>

       <property name="name"/>

       <property name="org"/>

   </natural-id>

   <property name="password"/>

</class>
注意,此功能对具有mutable自然键的entity并不适用。 

然后，打开Hibernate 查询缓存。 

现在，我们可以用Restrictions.naturalId()来使用更加高效的缓存算法。 

session.createCriteria(User.class)

   .add( Restrictions.naturalId()

       .set("name", "gavin")

       .set("org", "hb") 

   ).setCacheable(true)

   .uniqueResult();