Hibernate查询语言——HQL

   HQL: Hibernate查询语言 Hibernate配备了一种非常强大的查询语言，这种语言看上去很像SQL。但是不要被语法结构 上的相似所迷惑，HQL是非常有意识的被设计为完全面向对象的查询，它可以理解如继承、多态 和关联之类的概念。

大小写敏感性问题
    除了Java类与属性的名称外，查询语句对大小写并不敏感。 所以 SeLeCT 与 sELEct 以及 SELECT 是相同的，但是 org.hibernate.eg.FOO 并不等价于 org.hibernate.eg.Foo 并且 foo.barSet 也不等价于 foo.BARSET。 
本手册中的HQL关键字将使用小写字母. 很多用户发现使用完全大写的关键字会使查询语句 的可读性更强, 但我们发现，当把查询语句嵌入到Java语句中的时候使用大写关键字比较难看。 


from子句
Hibernate中最简单的查询语句的形式如下： 
代码内容
from eg.Cat 

该子句简单的返回eg.Cat类的所有实例。 通常我们不需要使用类的全限定名, 因为 auto-import（自动引入） 是缺省的情况。 所以我们几乎只使用如下的简单写法： 
代码内容
from Cat 

大多数情况下, 你需要指定一个别名, 原因是你可能需要 在查询语句的其它部分引用到Cat 
代码内容
from Cat as cat 

这个语句把别名cat指定给类Cat 的实例, 这样我们就可以在随后的查询中使用此别名了。 关键字as 是可选的，我们也可以这样写: 
代码内容
from Cat cat 

子句中可以同时出现多个类, 其查询结果是产生一个笛卡儿积或产生跨表的连接。 
from Formula, Parameter
from Formula as form, Parameter as param
查询语句中别名的开头部分小写被认为是实践中的好习惯， 这样做与Java变量的命名标准保持了一致 (比如，domesticCat)。 


关联(Association)与连接(Join)
   我们也可以为相关联的实体甚至是对一个集合中的全部元素指定一个别名, 这时要使用关键字join。 
代码内容
from Cat as cat  
    inner join cat.mate as mate 
    left outer join cat.kittens as kitten 
from Cat as cat left join cat.mate.kittens as kittens 
from Formula form full join form.parameter param 

受支持的连接类型是从ANSI SQL中借鉴来的。 
inner join（内连接） 
left outer join（左外连接） 
right outer join（右外连接） 
full join (全连接，并不常用) 
语句inner join, left outer join 以及 right outer join 可以简写。 
代码内容
from Cat as cat  
    join cat.mate as mate 
    left join cat.kittens as kitten 

还有，一个"fetch"连接允许仅仅使用一个选择语句就将相关联的对象或一组值的集合随着他们的父对象的初始化而被初始化，这种方法在使用到集合的情况下尤其有用，对于关联和集合来说，它有效的代替了映射文件中的外联接 与延迟声明（lazy declarations）. 查看 第 20.1 节 “ 抓取策略(Fetching strategies) ” 以获得等多的信息。 
代码内容
from Cat as cat  
    inner join fetch cat.mate 
    left join fetch cat.kittens 

一个fetch连接通常不需要被指定别名, 因为相关联的对象不应当被用在 where 子句 (或其它任何子句)中。同时，相关联的对象 并不在查询的结果中直接返回，但可以通过他们的父对象来访问到他们。 
注意fetch构造变量在使用了scroll() 或 iterate()函数 的查询中是不能使用的。最后注意，使用full join fetch 与 right join fetch是没有意义的。 
如果你使用属性级别的延迟获取（lazy fetching）（这是通过重新编写字节码实现的），可以使用 fetch all properties 来强制Hibernate立即取得那些原本需要延迟加载的属性（在第一个查询中）。 
代码内容
from Document fetch all properties order by name 
from Document doc fetch all properties where lower(doc.name) like ’%cats%’

同的语义. 
代码内容
select distinct cat.name from Cat cat
select count(distinct cat.name), count(cat) from Cat cat 


多态查询
一个如下的查询语句: 
代码内容
from Cat as cat 

不仅返回Cat类的实例, 也同时返回子类 DomesticCat的实例. Hibernate 可以在from子句中指定任何 Java 类或接口. 查询会返回继承了该类的所有持久化子类 的实例或返回声明了该接口的所有持久化类的实例。下面的查询语句返回所有的被持久化的对象： 
代码内容
from java.lang.Object o 

接口Named 可能被各种各样的持久化类声明： 
代码内容
from Named n, Named m where n.name = m.name 

注意，最后的两个查询将需要超过一个的SQL SELECT.这表明order by子句 没有对整个结果集进行正确的排序. (这也说明你不能对这样的查询使用Query.scroll()方法.) 

where子句
where子句允许你将返回的实例列表的范围缩小. 如果没有指定别名，你可以使用属性名来直接引用属性: 
代码内容
from Cat where name=’Fritz’ 
如果指派了别名，需要使用完整的属性名: 
代码内容
from Cat as cat where cat.name=’Fritz’ 
返回名为（属性name等于）’Fritz’的Cat类的实例。 
代码内容
select foo  
from Foo foo, Bar bar 
where foo.startDate = bar.date 

将返回所有满足下面条件的Foo类的实例： 存在如下的bar的一个实例，其date属性等于 Foo的startDate属性。 复合路径表达式使得where子句非常的强大，考虑如下情况： 
null
该查询将被翻译成为一个含有表连接（内连接）的SQL查询。如果你打算写像这样的查询语句 
代码内容
from Foo foo   
where foo.bar.baz.customer.address.city is not null 
在SQL中，你为达此目的将需要进行一个四表连接的查询。 
=运算符不仅可以被用来比较属性的值，也可以用来比较实例： 
代码内容
from Cat cat, Cat rival where cat.mate = rival.mate 
select cat, mate  
from Cat cat, Cat mate 
where cat.mate = mate 

特殊属性（小写）id可以用来表示一个对象的唯一的标识符。（你也可以使用该对象的属性名。） 
代码内容
from Cat as cat where cat.id = 123 

from Cat as cat where cat.mate.id = 69 

第二个查询是有效的。此时不需要进行表连接！ 
同样也可以使用复合标识符。比如Person类有一个复合标识符，它由country属性 与medicareNumber属性组成。 
代码内容
from bank.Person person 
where person.id.country = ’AU’  
    and person.id.medicareNumber = 123456 
from bank.Account account 
where account.owner.id.country = ’AU’  
    and account.owner.id.medicareNumber = 123456 

第二个查询也不需要进行表连接。 
同样的，特殊属性class在进行多态持久化的情况下被用来存取一个实例的鉴别值（discriminator value）。 一个嵌入到where子句中的Java类的名字将被转换为该类的鉴别值。 
代码内容
from Cat cat where cat.class = DomesticCat 

你也可以声明一个属性的类型是组件或者复合用户类型（以及由组件构成的组件等等）。永远不要尝试使用以组件类型来结尾的路径表达式（path-expression） （与此相反，你应当使用组件的一个属性来结尾）。 举例来说，如果store.owner含有一个包含了组件的实体address 
代码内容
store.owner.address.city    // 正确 
store.owner.address         // 错误! 

一个“任意”类型有两个特殊的属性id和class, 来允许我们按照下面的方式表达一个连接（AuditLog.item 是一个属性，该属性被映射为<any>）。 
代码内容
from AuditLog log, Payment payment  
where log.item.class = ’Payment’ and log.item.id = payment.id 
注意，在上面的查询与句中，log.item.class 和 payment.class 将涉及到完全不同的数据库中的列。 

表达式
在where子句中允许使用的表达式包括 大多数你可以在SQL使用的表达式种类: 
数学运算符+, -, *, / 
二进制比较运算符=, >=, <=, <>, !=, like 
逻辑运算符and, or, not 
in, not in, between, is null, is not null, is empty, is not empty, member of and not member of 
"简单的" case, case ... when ... then ... else ... end,和 "搜索" case, case when ... then ... else ... end 
字符串连接符...||... or concat(...,...) 
current_date(), current_time(), current_timestamp() 
second(...), minute(...), hour(...), day(...), month(...), year(...), 
EJB-QL 3.0定义的任何函数或操作：substring(), trim(), lower(), upper(), length(), locate(), abs(), sqrt(), bit_length() 
coalesce() 和 nullif() 
cast(... as ...), 其第二个参数是某Hibernate类型的名字，以及extract(... from ...)，只要ANSI cast() 和 extract() 被底层数据库支持 
任何数据库支持的SQL标量函数，比如sign(), trunc(), rtrim(), sin() 
JDBC参数传入 ? 
命名参数:name, :start_date,1 
SQL 直接常量 ’foo’, 69, ’1970-01-01 10:00:01.0’ 
Java public static final 类型的常量 eg.Color.TABBY 
关键字in与between可按如下方法使用: 
代码内容
from DomesticCat cat where cat.name between ’A’ and ’B’ 
from DomesticCat cat where cat.name in ( ’Foo’, ’Bar’, ’Baz’ ) 

而且否定的格式也可以如下书写： 
代码内容
from DomesticCat cat where cat.name not between ’A’ and ’B’ 
from DomesticCat cat where cat.name not in ( ’Foo’, ’Bar’, ’Baz’ ) 

同样, 子句is null与is not null可以被用来测试空值(null). 
在Hibernate配置文件中声明HQL“查询替代（query substitutions）”之后， 布尔表达式（Booleans）可以在其他表达式中轻松的使用: 
代码内容
<property name="hibernate.query.substitutions">true 1, false 0</property> 

系统将该HQL转换为SQL语句时，该设置表明将用字符 1 和 0 来 取代关键字true 和 false: 
代码内容
from Cat cat where cat.alive = true 
你可以用特殊属性size, 或是特殊函数size()测试一个集合的大小。 
代码内容
from Cat cat where cat.kittens.size > 0 
from Cat cat where size(cat.kittens) > 0 

对于索引了（有序）的集合，你可以使用minindex 与 maxindex函数来引用到最小与最大的索引序数。 同理，你可以使用minelement 与 maxelement函数来 引用到一个基本数据类型的集合中最小与最大的元素。 
代码内容
from Calendar cal where maxelement(cal.holidays) > current date 
from Order order where maxindex(order.items) > 100 
from Order order where minelement(order.items) > 10000 

在传递一个集合的索引集或者是元素集(elements与indices 函数) 或者传递一个子查询的结果的时候，可以使用SQL函数any, some, all, exists, in 
代码内容
select mother from Cat as mother, Cat as kit 
where kit in elements(foo.kittens) 
select p from NameList list, Person p 
where p.name = some elements(list.names) 
from Cat cat where exists elements(cat.kittens) 
from Player p where 3 > all elements(p.scores) 
from Show show where ’fizard’ in indices(show.acts) 

注意，在Hibernate3种，这些结构变量- size, elements, indices, minindex, maxindex, minelement, maxelement - 只能在where子句中使用。 
一个被索引过的（有序的）集合的元素(arrays, lists, maps)可以在其他索引中被引用（只能在where子句中）： 
代码内容
from Order order where order.items[0].id = 1234 
select person from Person person, Calendar calendar 
where calendar.holidays[’national day’] = person.birthDay 
    and person.nationality.calendar = calendar 
select item from Item item, Order order 
where order.items[ order.deliveredItemIndices[0] ] = item and order.id = 11 
select item from Item item, Order order 
where order.items[ maxindex(order.items) ] = item and order.id = 11 
在[]中的表达式甚至可以是一个算数表达式。  
select item from Item item, Order order 
where order.items[ size(order.items) - 1 ] = item 

对于一个一对多的关联（one-to-many association）或是值的集合中的元素， HQL也提供内建的index()函数， 
代码内容
select item, index(item) from Order order  
    join order.items item 
where index(item) < 5 

如果底层数据库支持标量的SQL函数，它们也可以被使用 
from DomesticCat cat where upper(cat.name) like ’FRI%’
如果你还不能对所有的这些深信不疑，想想下面的查询。如果使用SQL，语句长度会增长多少，可读性会下降多少： 
代码内容
select cust 
from Product prod, 
    Store store 
    inner join store.customers cust 
where prod.name = ’widget’ 
    and store.location.name in ( ’Melbourne’, ’Sydney’ ) 
    and prod = all elements(cust.currentOrder.lineItems) 
提示: 会像如下的语句  
SELECT cust.name, cust.address, cust.phone, cust.id, cust.current_order 
FROM customers cust, 
    stores store, 
    locations loc, 
    store_customers sc, 
    product prod 
WHERE prod.name = ’widget’ 
    AND store.loc_id = loc.id 
    AND loc.name IN ( ’Melbourne’, ’Sydney’ ) 
    AND sc.store_id = store.id 
    AND sc.cust_id = cust.id 
    AND prod.id = ALL( 
        SELECT item.prod_id 
        FROM line_items item, orders o 
        WHERE item.order_id = o.id 
            AND cust.current_order = o.id 
    )

order by子句
查询返回的列表(list)可以按照一个返回的类或组件（components)中的任何属性（property）进行排序： 
代码内容
from DomesticCat cat 
order by cat.name asc, cat.weight desc, cat.birthdate 

可选的asc或desc关键字指明了按照升序或降序进行排序. 

group by子句
一个返回聚集值(aggregate values)的查询可以按照一个返回的类或组件（components)中的任何属性（property）进行分组： 
代码内容
select cat.color, sum(cat.weight), count(cat)  
from Cat cat 
group by cat.color 
select foo.id, avg(name), max(name)  
from Foo foo join foo.names name 
group by foo.id 
having子句在这里也允许使用.  
select cat.color, sum(cat.weight), count(cat)  
from Cat cat 
group by cat.color  
having cat.color in (eg.Color.TABBY, eg.Color.BLACK) 
如果底层的数据库支持的话(例如不能在MySQL中使用)，SQL的一般函数与聚集函数也可以出现 在having与order by 子句中。 
代码内容
select cat 
from Cat cat 
    join cat.kittens kitten 
group by cat 
having avg(kitten.weight) > 100 
order by count(kitten) asc, sum(kitten.weight) desc 
注意group by子句与 order by子句中都不能包含算术表达式（arithmetic expressions）. 

子查询
对于支持子查询的数据库，Hibernate支持在查询中使用子查询。一个子查询必须被圆括号包围起来（经常是SQL聚集函数的圆括号）。 甚至相互关联的子查询（引用到外部查询中的别名的子查询）也是允许的。 
代码内容
from Cat as fatcat  
where fatcat.weight > (  
    select avg(cat.weight) from DomesticCat cat  
) 
from DomesticCat as cat  
where cat.name = some (  
    select name.nickName from Name as name  
) 
from Cat as cat  
where not exists (  
    from Cat as mate where mate.mate = cat  
) 
from DomesticCat as cat  
where cat.name not in (  
    select name.nickName from Name as name  
) 
在select列表中包含一个表达式以上的子查询，你可以使用一个元组构造符（tuple constructors）： 
代码内容
from Cat as cat  
where not ( cat.name, cat.color ) in (  
    select cat.name, cat.color from DomesticCat cat  
) 
注意在某些数据库中（不包括Oracle与HSQL），你也可以在其他语境中使用元组构造符， 比如查询用户类型的组件与组合： 
代码内容
from Person where name = (’Gavin’, ’A’, ’King’) 

该查询等价于更复杂的： 
代码内容
from Person where name.first = ’Gavin’ and name.initial = ’A’ and name.last = ’King’) 

有两个很好的理由使你不应当作这样的事情：首先，它不完全适用于各个数据库平台；其次，查询现在依赖于映射文件中属性的顺序。

HQL示例
Hibernate查询可以非常的强大与复杂。实际上，Hibernate的一个主要卖点就是查询语句的威力。这里有一些例子，它们与我在最近的 一个项目中使用的查询非常相似。注意你能用到的大多数查询比这些要简单的多！ 
下面的查询对于某个特定的客户的所有未支付的账单，在给定给最小总价值的情况下，返回订单的id，条目的数量和总价值， 返回值按照总价值的结果进行排序。为了决定价格，查询使用了当前目录。作为转换结果的SQL查询，使用了ORDER, ORDER_LINE, PRODUCT, CATALOG 和PRICE 库表。 
代码内容
select order.id, sum(price.amount), count(item) 
from Order as order 
    join order.lineItems as item 
    join item.product as product, 
    Catalog as catalog 
    join catalog.prices as price 
where order.paid = false 
    and order.customer = :customer 
    and price.product = product 
    and catalog.effectiveDate < sysdate 
    and catalog.effectiveDate >= all ( 
        select cat.effectiveDate  
        from Catalog as cat 
        where cat.effectiveDate < sysdate 
    ) 
group by order 
having sum(price.amount) > :minAmount 
order by sum(price.amount) desc 

这简直是一个怪物！实际上，在现实生活中，我并不热衷于子查询，所以我的查询语句看起来更像这个： 
代码内容
select order.id, sum(price.amount), count(item) 
from Order as order 
    join order.lineItems as item 
    join item.product as product, 
    Catalog as catalog 
    join catalog.prices as price 
where order.paid = false 
    and order.customer = :customer 
    and price.product = product 
    and catalog = :currentCatalog 
group by order 
having sum(price.amount) > :minAmount 
order by sum(price.amount) desc 
下面一个查询计算每一种状态下的支付的数目，除去所有处于AWAITING_APPROVAL状态的支付，因为在该状态下 当前的用户作出了状态的最新改变。该查询被转换成含有两个内连接以及一个相关联的子选择的SQL查询，该查询使用了表 PAYMENT, PAYMENT_STATUS 以及 PAYMENT_STATUS_CHANGE。 
代码内容
select count(payment), status.name  
from Payment as payment  
    join payment.currentStatus as status 
    join payment.statusChanges as statusChange 
where payment.status.name <> PaymentStatus.AWAITING_APPROVAL 
    or ( 
        statusChange.timeStamp = (  
            select max(change.timeStamp)  
            from PaymentStatusChange change  
            where change.payment = payment 
        ) 
        and statusChange.user <> :currentUser 
    ) 
group by status.name, status.sortOrder 
order by status.sortOrder 
如果我把statusChanges实例集映射为一个列表（list）而不是一个集合（set）, 书写查询语句将更加简单. 
代码内容
select count(payment), status.name  
from Payment as payment 
    join payment.currentStatus as status 
where payment.status.name <> PaymentStatus.AWAITING_APPROVAL 
    or payment.statusChanges[ maxIndex(payment.statusChanges) ].user <> :currentUser 
group by status.name, status.sortOrder 
order by status.sortOrder 
下面一个查询使用了MS SQL Server的 isNull()函数用以返回当前用户所属组织的组织帐号及组织未支付的账。 它被转换成一个对表ACCOUNT, PAYMENT, PAYMENT_STATUS, ACCOUNT_TYPE, ORGANIZATION 以及 ORG_USER进行的三个内连接， 一个外连接和一个子选择的SQL查询。 
代码内容
select account, payment 
from Account as account 
    left outer join account.payments as payment 
where :currentUser in elements(account.holder.users) 
    and PaymentStatus.UNPAID = isNull(payment.currentStatus.name, PaymentStatus.UNPAID) 
order by account.type.sortOrder, account.accountNumber, payment.dueDate 
对于一些数据库，我们需要弃用（相关的）子选择。 
代码内容
select account, payment 
from Account as account 
    join account.holder.users as user 
    left outer join account.payments as payment 
where :currentUser = user 
    and PaymentStatus.UNPAID = isNull(payment.currentStatus.name, PaymentStatus.UNPAID) 
order by account.type.sortOrder, account.accountNumber, payment.dueDate
 
批量的UPDATE & DELETE语句
HQL现在支持UPDATE与DELETE语句. 查阅 第 14.3 节 “大批量更新/删除（Bulk update/delete）” 以获得更多信息。 
15.14. 小技巧 & 小窍门
你可以统计查询结果的数目而不必实际的返回他们： 
( (Integer) session.iterate("select count(*) from ....").next() ).intValue()
若想根据一个集合的大小来进行排序，可以使用如下的语句： 
代码内容
select usr.id, usr.name 
from User as usr  
    left join usr.messages as msg 
group by usr.id, usr.name 
order by count(msg) 

如果你的数据库支持子选择，你可以在你的查询的where子句中为选择的大小（selection size）指定一个条件: 
代码内容
from User usr where size(usr.messages) >= 1 

如果你的数据库不支持子选择语句，使用下面的查询： 
代码内容
select usr.id, usr.name 
from User usr.name 
    join usr.messages msg 
group by usr.id, usr.name 
having count(msg) >= 1 
因为内连接（inner join）的原因，这个解决方案不能返回含有零个信息的User 类的实例, 所以这种情况下使用下面的格式将是有帮助的: 
代码内容
select usr.id, usr.name 
from User as usr 
    left join usr.messages as msg 
group by usr.id, usr.name 
having count(msg) = 0 

JavaBean的属性可以被绑定到一个命名查询（named query）的参数上： 
代码内容
Query q = s.createQuery("from foo Foo as foo where foo.name=:name and foo.size=:size"); 
q.setProperties(fooBean); // fooBean包含方法getName()与getSize() 
List foos = q.list(); 

通过将接口Query与一个过滤器（filter）一起使用，集合（Collections）是可以分页的： 
代码内容
Query q = s.createFilter( collection, "" ); // 一个简单的过滤器 
q.setMaxResults(PAGE_SIZE); 
q.setFirstResult(PAGE_SIZE * pageNumber); 
List page = q.list(); 

通过使用查询过滤器（query filter）可以将集合（Collection）的原素分组或排序: 
代码内容
Collection orderedCollection = s.filter( collection, "order by this.amount" ); 
Collection counts = s.filter( collection, "select this.type, count(this) group by this.type" ); 
不用通过初始化，你就可以知道一个集合（Collection）的大小： 
代码内容
( (Integer) session.iterate("select count(*) from ....").next() ).intValue();