Hasta ahora nos hemos dedicado a ver las diversas formas de persistencia que soporta hibernate en función de nuestro modelo de objetos de negocio en Java. Pero una característica fundamental de cualquier ORM es la necesidad de leer dichos objetos de la base de datos.
Hibernate tiene el objeto Query que nos da acceso a todas las funcionalidades para poder leer objetos desde la base de datos. Veamos ahora un sencillo ejemplo de cómo funciona y posteriormente explicaremos más funcionalidades de la clase Query.
Query query = session.createQuery("SELECT p FROM Profesor p"); List<Profesor> profesores = query.list(); for (Profesor profesor : profesores) { System.out.println(profesor.toString()); }
Lanzar una consulta con Hibernate es bastante simple. Usando la session llamamos al método createQuery(String queryString) con la consulta en formato HQL y nos retorna un objeto Query (Línea 1). Después, sobre el objeto Query llamamos al método list() que nos retorna una lista de los objetos que ha retornado (Línea 2).
Por último en las líneas de la 4 a la 6 podemos ver cómo usar la lista de objetos Profesor aunque este código ya es simplemente el uso de la clase java.util.List que no tiene nada que ver con Hibernate.
En los ejemplos que vamos a realizar van a usarse las siguientes clases Java y tablas, que solo mostraremos en formato UML. No vamos a poner el código fuente ni los ficheros de hibernate de mapeo ya que no todas la características que usan han sido explicadas en lecciones anteriores.
Pasemos ahora a ver las funcionalidades de la clase Query
Pasemos ahora a ver con más detalle cómo funciona list().
Como ya hemos dicho el método list() nos retorna una lista con todos los objetos que ha retornado la consulta. En caso de que no se encuentre ningún resultado se retornará una lista sin ningún elemento.
Tan y como veremos en la siguiente lección sobre HQL, también se permite que las consultas retornen datos escalares en vez de clases completas.
SELECT p.id,p.nombre FROM Profesor p
En la consulta podemos ver cómo en vez de retornar un objeto Profesor se retorna únicamente el código del profesor y su nombre.
En estos casos el método list() retorna una lista con una Array de objetos con tantos elementos como propiedades hayamos puesto en la SELECT.
Veamos ahora un ejemplo.
Query query = session.createQuery("SELECT p.id,p.nombre FROM Profesor p"); List<Object[]> listDatos = query.list(); for (Object[] datos : listDatos) { System.out.println(datos[0] + "--" + datos[1]); }
datos[0] y datos[1].
Hay otro caso cuando hay una única columna en el SELECT de datos escalares. Es ese caso, como el array a retornar dentro de la lista solo tendría un elemento , no se retorna una lista de arrays List<Object[]> sino únicamente una lista de elementos List<Object>.
Si modificamos la anterior consulta de forma que sólo se retorne el nombre, el código quedará de la siguiente forma:
Query query = session.createQuery("SELECT p.nombre FROM Profesor p"); List<Object> listDatos = query.list(); for (Object datos : listDatos) { System.out.println(datos); }
Object en vez de Object[].En muchas ocasiones una consulta únicamente retornará cero o un resultado. En ese caso es poco práctico que nos retorne una lista con un único elemento. Para facilitarnos dicha tarea Hibernate dispone del método uniqueResult().
Este método retornará directamente el único objeto que ha obtenido la consulta. En caso de que no encuentre ninguno se retornará null.
Profesor profesor = (Profesor) session.createQuery("SELECT p FROM Profesor p WHERE id=1001").uniqueResult(); System.out.println("Profesor con Id 1001=" + profesor.getNombre());
Vemos cómo, gracias al método uniqueResult() , se simplifica el código aunque siempre se debe comprobar si ha retornado o no null.
Object[] o un único objeto escalar Object.
org.hibernate.NonUniqueResultException: query did not return a unique result
La paginación es parte fundamental de cualquier aplicación ya que una consulta puede tener miles de resultados y no queremos mostrarlos todos a la vez.
Para conseguir paginar el resultado de una consulta la clase Query dispone de los siguientes métodos:
Al realizar la paginación son necesarios al menos 2 valores:
Con esos 2 valores hemos creado el siguiente código Java que muestra una única página en función del tamanyoPagina y paginaAMostrar.
int tamanyoPagina = 10; int paginaAMostrar = 7; Query query = session.createQuery("SELECT p FROM Profesor p Order By p.id"); query.setMaxResults(tamanyoPagina); query.setFirstResult(paginaAMostrar * tamanyoPagina); List<Profesor> profesores = query.list(); for (Profesor profesor : profesores) { System.out.println(profesor.toString()); }
El mayor problema que tiene la paginación es determinar el nº de páginas para poder mostrárselo al usuario, para saber el nº de páginas es necesario conocer el nº de objetos que retorna la consulta y la forma mas rápida y sencilla es mediante una consulta que las cuente.
El siguiente código Java calcula el nº de páginas de la consulta.
long numTotalObjetos = (Long) session.createQuery("SELECT count(*) FROM Profesor p").uniqueResult(); int numPaginas =(int) Math.ceil((double)numTotalObjetos / (double)tamanyoPagina);
count(*^) para obtener el nº de objetos que retorna la consultadouble ya que si no Java automáticamente redondea el resultado a un valor entero con lo que el valor que se le pasa a ceil ya no será el correcto.
En cualquier libro sobre arquitectura del software siempre se indica que las consultas a la base de datos no deberían escribirse directamente en el código sino que deberían estar en un fichero externo para que puedan modificarse fácilmente.
Hibernate provee una funcionalidad para hacer ésto mismo de una forma sencilla. En cualquier fichero de mapeo de Hibernate se puede incluir el tag <query> con la consulta HQL que deseamos lanzar.
En el siguiente ejemplo podemos ver cómo se ha definido una query en el fichero Profesor.hbm.xml.
<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE hibernate-mapping PUBLIC "-//Hibernate/Hibernate Mapping DTD 3.0//EN" "http://www.hibernate.org/dtd/hibernate-mapping-3.0.dtd"> <hibernate-mapping> <class name="ejemplo01.Profesor"> <id column="Id" name="id" type="integer"/> <property name="nombre"/> <property name="ape1"/> <property name="ape2"/> </class> <query name="findAllProfesores"><![CDATA[ SELECT p FROM Profesor p ]]></query> </hibernate-mapping>
Vemos cómo en las líneas 12, 13, y 14 se ha definido la consulta llamada findAllMunicipios mediante el tag <query>.
Este tag tiene los siguientes datos:
name:Este atributo define el nombre de la consulta.Es el nombre que posteriormente usaremos desde el código Java para acceder a la consulta.<query> es la consulta en formato HQL que ejecutará Hibernate.CDATA de XML para evitar que algun simbolo de “>” o “<” de la consulta se pueda interpretar como cierre del tag <query>.
CDATA forma parte de la especificación de los ficheros XML no siendo algo que se ha definido en Hibernate.Más información en CDATA.
Para hacer uso de una consulta con nombre usaremos el método getNamedQuery(String queryString) en vez de createQuery(String queryString) para obtener el objeto Query. Por lo tanto sólo se ha modificado la línea 1 y el resto del código queda exactamente igual.
Query query = session.getNamedQuery("findAllProfesores"); List<Profesor> profesores = query.list(); for (Profesor profesor : profesores) { System.out.println(profesor.toString()); }
Como podemos ver el uso de consultas con nombre es muy sencillo al usar Hibernate.