Hibernate中的命名查询

xing00

2012-05-05

什么是命名查询？

Hibernate允许在映射文件中定义字符串形式的查询语句，这种查询方式成为命名查询

使用命名查询有什么好处？

由于使用Hibernate的HQL常常需要在Java代码中写字符串查询语句，HQL混杂在代码之间，破坏代码可读性，通过使用命名查询，可以使业务逻辑和查询语句分离，使您专注于查询，而避免了 SQL 或者 HQL 代码分散于整个应用程序中的情况。

可以应用命名查询做复杂查询的处理

命名查询如何实现？

介绍下面几种方式：

方法一：在配置文件中<class/>标记的下面，声明查询语句

<hibernate-mapping>
    <class name="com.test.bean.Student" table="student" catalog="users">
        <id name="id" type="integer">
            <column name="id" />
            <generator class="identity" />
        </id>
        <property name="name" type="string">
            <column name="name" length="11" />
        </property>
        <property name="age" type="integer">
            <column name="age" />
        </property>
        <property name="sex" type="string">
            <column name="sex" length="2" />
        </property>  
    </class>

    <!-- 定义查询语句 -->
    <query name="findStudentByName">
    <![CDATA[from Student where name = :name]]>
    </query> 
</hibernate-mapping>

备注：<![CDATA[ ]]>是什么意思?

标明是纯文本的，没有这个的话 < > & 字符是不能直接存入XML的，需要转义，而用这个标记则不需要转义而将这些符号存入XML文档。可以避免未预料的特殊符号导致XML解析出错。

public List<Student> query(){
		Session session = HibernateSessionFactory.getSession();
		Query q = session.getNamedQuery("findStudentByName");
		q.setString("name", "zhangsan");
		List<Student> list = q.list();	        
		return list;
}

方法二：也可以在配置文件中<class/>标记的里面，声明查询语句, 但是java代码调用时需要指定(包+类+配置名)

<hibernate-mapping>
    <class name="com.test.bean.Student" table="student" catalog="users">
        <id name="id" type="integer">
            <column name="id" />
            <generator class="identity" />
        </id>
        <property name="name" type="string">
            <column name="name" length="11" />
        </property>
        <property name="age" type="integer">
            <column name="age" />
        </property>
        <property name="sex" type="string">
            <column name="sex" length="2" />
        </property>

        <!-- 定义查询语句 -->
        <query name="findStudentByName">
		<![CDATA[from Student where name = :name]]>
	</query>
    </class>
 </hibernate-mapping>

public List<Student> query(){
	Session session = HibernateSessionFactory.getSession();
	Query q = session.getNamedQuery("com.test.bean.Student.findStudentByName");
	q.setString("name", "zhangsan");
	List<Student> list = q.list();
	return list;
}

方法三：使用原生sql查询<sql-query>，使用此种方式必须把表所有的列写全才可以，否则会出现‘列名无效’的错误，除非你使用return-scalar来设置字段类型。

<hibernate-mapping>
    <class name="com.test.bean.Student" table="student" catalog="users">
        <id name="id" type="integer">
            <column name="id" />
            <generator class="identity" />
        </id>
        <property name="name" type="string">
            <column name="name" length="11" />
        </property>
        <property name="age" type="integer">
            <column name="age" />
        </property>
        <property name="sex" type="string">
            <column name="sex" length="2" />
        </property>  
    </class>   
    <!-- 定义查询语句 -->
   <sql-query name="findStudentByName">
	    <return alias="s" class="com.test.bean.Student">   
	    </return>
	    <![CDATA[select {s.*} from student s where s.name = :name]]>
   </sql-query>
</hibernate-mapping>

备注：也可以在<return/>标记里面应用<return-property/>标记将表的所有字段列出来，与上面描述的方法一样，都是查询出来所有列。

public List<Student> query(){
	Session session = HibernateSessionFactory.getSession();
	Query q = session.getNamedQuery("findStudentByName");
	q.setString("name", "zhangsan");
	List<Student> list = q.list();
	return list;
}

方法四：使用原生sql查询<sql-query>, 如果应用return-scalar来设置字段类型, 就可以实现查询部分字段。

<hibernate-mapping>
    <class name="com.test.bean.Student" table="student" catalog="users">
        <id name="id" type="integer">
            <column name="id" />
            <generator class="identity" />
        </id>
        <property name="name" type="string">
            <column name="name" length="11" />
        </property>
        <property name="age" type="integer">
            <column name="age" />
        </property>
        <property name="sex" type="string">
            <column name="sex" length="2" />
        </property>   
    </class>
    <!-- 定义查询语句 -->    
    <sql-query name="findStudentByName">
	    <return-scalar column="name" type="string"/>
	    <return-scalar column="age" type="integer"/>    
	    <![CDATA[select s.name , s.age from student s where s.name = :name]]>
    </sql-query>    
</hibernate-mapping>

public List<Object[]> query(){
	Session session = HibernateSessionFactory.getSession();		
	Query query = session.getNamedQuery("findStudentByName");  
	query.setString("name", "zhangsan");  
	List<Object[]> list = query.list();  	        
	return list;
}
或者：
public List<Student> query(){
	Session session = HibernateSessionFactory.getSession();
	Query q = session.getNamedQuery("findStudentByName").
setResultTransformer(Transformers.aliasToBean(Student.class));
	q.setString("name", "zhangsan");
	List<Student> list = q.list();	        
	return list;
}

hibernate