在迁移原先用JDBC/SQL实现的系统，难免需要采用hibernat native sql支持。
1.使用SQLQuery
hibernate对原生SQL查询执行的控制是通过SQLQuery接口进行的.
1
Session.createSQLQuery();
1.1标量查询
最基本的SQL查询就是获得一个标量（数值）的列表。
1sess.createSQLQuery("SELECT * FROM CATS").list();
2sess.createSQLQuery("SELECT ID, NAME, BIRTHDATE FROM CATS").list();
将
返回一个Object数组(Object[])组成的List，数组每个元素都是CATS表的一个字段值。Hibernate会使用ResultSetMetadata来判定返回的标量值的实际顺序和类型。
如果要避免过多的使用ResultSetMetadata,或者只是为了更加明确的指名返回值，可以使用addScalar()。
1sess.createSQLQuery("SELECT * FROM CATS")
2 .addScalar("ID", Hibernate.LONG)
3 .addScalar("NAME", Hibernate.STRING)
4 .addScalar("BIRTHDATE", Hibernate.DATE)
这个查询指定了:SQL查询字符串,要返回的字段和类型.它仍然会返回Object数组,但是此时不再使用ResultSetMetdata,而是明确的将ID,NAME和BIRTHDATE按照Long,String和Short类型从resultset中取出。同时，也指明了就算query是使用*来查询的，可能获得超过列出的这三个字段，也仅仅会返回这三个字段。
对全部或者部分的标量值不设置类型信息也是可以的。
1sess.createSQLQuery("SELECT * FROM CATS")
2 .addScalar("ID", Hibernate.LONG)
3 .addScalar("NAME")
4 .addScalar("BIRTHDATE")
基本上这和前面一个查询相同,只是此时使用ResultSetMetaData来决定NAME和BIRTHDATE的类型，而ID的类型是明确指出的。
关于从ResultSetMetaData返回的java.sql.Types是如何映射到Hibernate类型，是由方言(Dialect)控制的。假若某个指定的类型没有被映射，或者不是你所预期的类型，你可以通过Dialet的registerHibernateType调用自行定义.
1.2 实体查询
上面的查询都是返回标量值的，也就是从resultset中返回的“裸”数据。下面展示如何通过addEntity()让原生查询返回实体对象。
1sess.createSQLQuery("SELECT * FROM CATS").addEntity(Cat.class);
2sess.createSQLQuery("SELECT ID, NAME, BIRTHDATE FROM CATS").addEntity(Cat.class);
这个查询指定：SQL查询字符串,要返回的实体.假设Cat被映射为拥有ID,NAME和BIRTHDATE三个字段的类，以上的两个查询都返回一个List，每个元素都是一个Cat实体。 假若实体在映射时有一个many-to-one的关联指向另外一个实体，在查询时必须也返回那个实体，否则会导致发生一个"column not found"的数据库错误。这些附加的字段可以使用*标注来自动返回，但我们希望还是明确指明，看下面这个具有指向Dog的many-to-one的例子：
1sess.createSQLQuery("SELECT ID, NAME, BIRTHDATE, DOG_ID FROM CATS").addEntity(Cat.class);
这样cat.getDog()就能正常运行。
1.3 处理关联和集合类
通过
提前抓取将
Dog连接获得，而避免初始化proxy带来的额外开销也是可能的。这是通过
addJoin()方法进行的，这个方法可以让你将关联或集合连接进来。
1sess.createSQLQuery("SELECT c.ID, NAME, BIRTHDATE, DOG_ID, D_ID, D_NAME FROM CATS c, DOGS d WHERE c.DOG_ID = d.D_ID")
2 .addEntity("cat", Cat.class)
3 .addJoin("cat.dog");
上面这个例子中，返回的
Cat对象，其
dog属性被完全初始化了，不再需要数据库的额外操作。注意，我们加了一个别名("cat")，以便指明join的目标属性路径。通过同样的
提前连接也可以作用于集合类，例如，假若
Cat有一个指向
Dog的一对多关联。
1sess.createSQLQuery("SELECT ID, NAME, BIRTHDATE, D_ID, D_NAME, CAT_ID FROM CATS c, DOGS d WHERE c.ID = d.CAT_ID")
2 .addEntity("cat", Cat.class)
3 .addJoin("cat.dogs");
1.4 返回多个实体
到目前为止,结果集字段名被假定为和映射文件中指定的的字段名是一致的。假若SQL查询连接了多个表，同一个字段名可能在多个表中出现多次，这就会造成问题。
下面的查询中需要使用字段别名注射（这个例子本身会失败）：
1sess.createSQLQuery("SELECT c.*, m.* FROM CATS c, CATS m WHERE c.MOTHER_ID = c.ID")
2 .addEntity("cat", Cat.class)
3 .addEntity("mother", Cat.class)
这个查询的本意是希望每行返回两个Cat实例，一个是cat,另一个是它的妈妈。但是因为它们的字段名被映射为相同的，而且在某些数据库中，返回的字段别名是“c.ID”,"c.NAME"这样的形式，而它们和在映射文件中的名字（"ID"和"NAME"）不匹配，这就会造成失败。
下面的形式可以解决字段名重复：
1sess.createSQLQuery("SELECT {cat.*}, {mother.*} FROM CATS c, CATS m WHERE c.MOTHER_ID = c.ID")
2 .addEntity("cat", Cat.class)
3 .addEntity("mother", Cat.class)
这个查询指明：SQL查询语句，其中包含占位符来让Hibernate注射字段别名,查询返回的实体
上面使用的{cat.*}和{mother.*}标记是作为“所有属性”的简写形式出现的。当然你也可以明确地罗列出字段名，但在这个例子里面我们让Hibernate来为每个属性注射SQL字段别名。字段别名的占位符是属性名加上表别名的前缀。在下面的例子中，我们从另外一个表（cat_log）中通过映射元数据中的指定获取Cat和它的妈妈。注意，要是我们愿意，我们甚至可以在where子句中使用属性别名。
1String sql = "SELECT ID as {c.id}, NAME as {c.name}, " +
2 "BIRTHDATE as {c.birthDate}, MOTHER_ID as {c.mother}, {mother.*} " +
3 "FROM CAT_LOG c, CAT_LOG m WHERE {c.mother} = c.ID";
4
5List loggedCats = sess.createSQLQuery(sql)
6 .addEntity("cat", Cat.class)
7 .addEntity("mother", Cat.class).list();
1.4.1 别名和属性引用
大多数情况下，都需要上面的属性注射，但在使用更加复杂的映射，比如复合属性、通过标识符构造继承树，以及集合类等等情况下，也有一些特别的别名，来允许Hibernate注射合适的别名。
下表列出了使用别名注射参数的不同可能性。注意：下面结果中的别名只是示例，实用时每个别名需要唯一并且不同的名字。
别名注射(alias injection names)
| 描述 |
语法 |
示例 |
| 简单属性 |
{[aliasname].[propertyname] |
A_NAME as {item.name} |
| 复合属性 |
{[aliasname].[componentname].[propertyname]} |
CURRENCY as {item.amount.currency}, VALUE as {item.amount.value} |
| 实体辨别器(Discriminator of an entity) |
{[aliasname].class} |
DISC as {item.class} |
| 实体的所有属性 |
{[aliasname].*} |
{item.*} |
| 集合键(collection key) |
{[aliasname].key} |
ORGID as {coll.key} |
| 集合id |
{[aliasname].id} |
EMPID as {coll.id} |
| 集合元素 |
{[aliasname].element} |
XID as {coll.element} |
|
| 集合元素的属性 |
{[aliasname].element.[propertyname]} |
NAME as {coll.element.name} |
|
| 集合元素的所有属性 |
{[aliasname].element.*} |
{coll.element.*} |
|
| 集合的所有属性 |
{[aliasname].*} |
{coll.*} |
1.5.
返回非受管实体
可以对原生sql 查询使用ResultTransformer。这会返回不受Hibernate管理的实体。
1sess.createSQLQuery("SELECT NAME, BIRTHDATE FROM CATS")
2 .setResultTransformer(Transformers.aliasToBean(CatDTO.class))
这个查询指定：SQL查询字符串,结果转换器(result transformer)
上面的查询将会返回CatDTO的列表,它将被实例化并且将NAME和BIRTHDAY的值注射入对应的属性或者字段。
1.6. 处理继承
原生SQL查询假若其查询结果实体是继承树中的一部分，它必须包含基类和所有子类的所有属性。
1.7. 参数
原生查询支持位置参数和命名参数：
1Query query = sess.createSQLQuery("SELECT * FROM CATS WHERE NAME like ?").addEntity(Cat.class);
2List pusList = query.setString(0, "Pus%").list();
3
4query = sess.createSQLQuery("SELECT * FROM CATS WHERE NAME like :name").addEntity(Cat.class);
5List pusList = query.setString("name", "Pus%").list();
2.使用命名SQL查询
可以在映射文档中定义查询的名字,然后就可以象调用一个命名的HQL查询一样直接调用命名SQL查询.在这种情况下,不需要调用
addEntity()方法.
1 <sql-query name="persons">
2 <return alias="person" class="eg.Person"/>
3 SELECT person.NAME AS {person.name},
4 person.AGE AS {person.age},
5 person.SEX AS {person.sex}
6 FROM PERSON person
7 WHERE person.NAME LIKE :namePattern
8 </sql-query>
1List people = sess.getNamedQuery("persons")
2 .setString("namePattern", namePattern)
3 .setMaxResults(50)
4 .list();
<return-join>和
<load-collection> 元素是用来连接关联以及将查询定义为预先初始化各个集合的。
1 <sql-query name="personsWith">
2 <return alias="person" class="eg.Person"/>
3 <return-join alias="address" property="person.mailingAddress"/>
4 SELECT person.NAME AS {person.name},
5 person.AGE AS {person.age},
6 person.SEX AS {person.sex},
7 adddress.STREET AS {address.street},
8 adddress.CITY AS {address.city},
9 adddress.STATE AS {address.state},
10 adddress.ZIP AS {address.zip}
11 FROM PERSON person
12 JOIN ADDRESS adddress
13 ON person.ID = address.PERSON_ID AND address.TYPE='MAILING'
14 WHERE person.NAME LIKE :namePattern
15 </sql-query>
一个命名查询可能会返回一个标量值.你必须使用
<return-scalar>元素来指定字段的别名和 Hibernate类型
1<sql-query name="mySqlQuery">
2 <return-scalar column="name" type="string"/>
3 <return-scalar column="age" type="long"/>
4 SELECT p.NAME AS name,
5 p.AGE AS age,
6 FROM PERSON p WHERE p.NAME LIKE 'Hiber%'
7</sql-query>
可以把结果集映射的信息放在外部的
<resultset>元素中，这样就可以在多个命名查询间，或者通过
setResultSetMapping()API来访问
1 <resultset name="personAddress">
2 <return alias="person" class="eg.Person"/>
3 <return-join alias="address" property="person.mailingAddress"/>
4 </resultset>
5
6 <sql-query name="personsWith" resultset-ref="personAddress">
7 SELECT person.NAME AS {person.name},
8 person.AGE AS {person.age},
9 person.SEX AS {person.sex},
10 adddress.STREET AS {address.street},
11 adddress.CITY AS {address.city},
12 adddress.STATE AS {address.state},
13 adddress.ZIP AS {address.zip}
14 FROM PERSON person
15 JOIN ADDRESS adddress
16 ON person.ID = address.PERSON_ID AND address.TYPE='MAILING'
17 WHERE person.NAME LIKE :namePattern
18 </sql-query>
另外,你可以在java代码中直接使用hbm文件中的结果集定义信息。
1 List cats = sess.createSQLQuery(
2 "select {cat.*}, {kitten.*} from cats cat, cats kitten where kitten.mother = cat.id"
3 )
4 .setResultSetMapping("catAndKitten")
5 .list();
2.1. 使用return-property来明确地指定字段/别名
使用
<return-property>你可以明确的告诉Hibernate使用哪些字段别名,这取代了使用
{}-语法 来让Hibernate注入它自己的别名.
1<sql-query name="mySqlQuery">
2 <return alias="person" class="eg.Person">
3 <return-property name="name" column="myName"/>
4 <return-property name="age" column="myAge"/>
5 <return-property name="sex" column="mySex"/>
6 </return>
7 SELECT person.NAME AS myName,
8 person.AGE AS myAge,
9 person.SEX AS mySex,
10 FROM PERSON person WHERE person.NAME LIKE :name
11</sql-query>
<return-property>也可用于多个字段,它解决了使用
{}-语法不能细粒度控制多个字段的限制
1 <sql-query name="organizationCurrentEmployments">
2 <return alias="emp" class="Employment">
3 <return-property name="salary">
4 <return-column name="VALUE"/>
5 <return-column name="CURRENCY"/>
6 </return-property>
7 <return-property name="endDate" column="myEndDate"/>
8 </return>
9 SELECT EMPLOYEE AS {emp.employee}, EMPLOYER AS {emp.employer},
10 STARTDATE AS {emp.startDate}, ENDDATE AS {emp.endDate},
11 REGIONCODE as {emp.regionCode}, EID AS {emp.id}, VALUE, CURRENCY
12 FROM EMPLOYMENT
13 WHERE EMPLOYER = :id AND ENDDATE IS NULL
14 ORDER BY STARTDATE ASC
15 </sql-query>
如果你映射一个识别器(discriminator),你必须使用<return-discriminator> 来指定识别器字段
2.2. 使用存储过程来查询
Hibernate 3引入了对存储过程查询(stored procedure)和函数(function)的支持.以下的说明中，这二者一般都适用。 存储过程/函数必须返回一个结果集,作为Hibernate能够使用的第一个外部参数.
1 <sql-query name="selectAllEmployees_SP" callable="true">
2 <return alias="emp" class="Employment">
3 <return-property name="employee" column="EMPLOYEE"/>
4 <return-property name="employer" column="EMPLOYER"/>
5 <return-property name="startDate" column="STARTDATE"/>
6 <return-property name="endDate" column="ENDDATE"/>
7 <return-property name="regionCode" column="REGIONCODE"/>
8 <return-property name="id" column="EID"/>
9 <return-property name="salary">
10 <return-column name="VALUE"/>
11 <return-column name="CURRENCY"/>
12 </return-property>
13 </return>
14 { ? = call selectAllEmployments() }
15 </sql-query>
注意存储过程当前仅仅返回标量和实体.现在不支持<return-join>和<load-collection>
2.2.1. 使用存储过程的规则和限制
为了在Hibernate中使用存储过程,你必须遵循一些规则.不遵循这些规则的存储过程将不可用.如果你仍然想要使用他们, 你必须通过session.connection()来执行他们.这些规则针对于不同的数据库.因为数据库 提供商有各种不同的存储过程语法和语义.
对存储过程进行的查询无法使用setFirstResult()/setMaxResults()进行分页。
建议采用的调用方式是标准SQL92: { ? = call functionName(<parameters>) } 或者 { ? = call procedureName(<parameters>}.原生调用语法不被支持。