...
Para poder utilizar JpaRepository, en principio no es necesario realizar ninguna configuración de librerías.
Si fuera necesario, incluir la es necesario incluir las siguientes dependencias en el pom.xml:
| Bloque de código | ||
|---|---|---|
| ||
<dependency> <!-- JPA --> <dependency> <groupId>org.springframework.boot<<groupId>mysql</groupId> <artifactId>spring<artifactId>mysql-boot-starter-data-jpa<connector-java</artifactId> <scope>runtime</scope> </dependency> <!-- Base de datos --> <dependency> <groupId>com.oracle</groupId> <artifactId>jdbc.driver</artifactId> <version>11.2.0.3.0</version> </dependency> <dependency> <groupId>mysql</groupId> <artifactId>mysql-connector-java</artifactId> <scope>runtime</scope> </dependency> |
Además, debemos completar las credenciales de la fuente de datos, y esto Además, debemos proporcionar las credenciales de la fuente de datos, y esto lo haremos en nuestro src/main/resources/application.properties, por ejemplo:
...
Completados los pasos previos podemos definirnos nuestro repositorio. Se ha de crear una interfaz que extienda a JpaRepository parametrizado con el tipo correspondiente , y utilizando (al extender de JpaRepository no hace falta añadir la anotación @Repository). Siguiendo con nuestro ejemplo, tendríamos:
| Bloque de código | ||
|---|---|---|
| ||
package es.um.atica.------; import java.util.List; import org.springframework.data.jpa.repository.JpaRepository; import org.springframework.stereotype.Repository; import es.um.atica.------.Usuario; @Repository public interface UsuarioRepository extends JpaRepository<Usuario,String> { public Usuario findByLogin(String login); public List<Usuario> findAllByOrderByLogin(); } |
...
Se pueden hacer múltiples operaciones filtrando, ordenando, etc., sobre base de datos. Las operaciones que implementa por defecto JpaRepository las podemos ver en su documentación, pero las que más usaremos serán findAll, findAllById y getById para obtener todos los registros, obtener los que tengan una lista de IDs que se le pase, o un único registro, pasando el ID. También están save y delete para guardar en base de datos, o para borrar.
| Bloque de código | ||
|---|---|---|
| ||
// Para guardar un nuevo elemento Customer en un jparepository de ese tipo
customerRepository.save(new Customer("Jack", "Bauer")); |
Además, podemos declarar métodos para otras consultas sin necesidad de implementarlos. Esto lo hace JpaRepository a través del nombre que le pongamos al método, que tendrá que seguir una notación concreta, utilizando una serie de operadores que trae predefinido y utilizando los nombres de los campos de la entidad con la que trata. Podemos ver todas las opciones en la documentación oficial. Algunos ejemplos podrían ser estos:
...
Por defecto, los métodos CRUD de los repositorios son transaccionales, es decir, incluyen la anotación @Transactional por defecto. Sí que tendremos que incluirla en los métodos query que definamos, es decir, en los métodos del repositorio que utilicen la anotación @Query, o en métodos externos que encapsulen varias llamadas a métodos de repositorios. También podríamos incluirla en los métodos CRUD normales de los repositorios para modificar su comportamiento por defecto. Esto podemos leerlo con más detalle en la documentación de Spring Data JPA.
Filtrar utilizando Specification
Otra opción para hacer queries propias es programarlas a través de Criteria y Specification. Specification es una interfaz para definir predicados reutilizables, teniendo métodos que podemos pasar directamente a llamadas a un JpaRepository. La parte negativa es que no se pueden combinar los filtros que aplican los métodos del repositorio con las Specification, pues sólo se pueden utilizar con el método findAll. La interfaz Specification es así:
| Bloque de código | ||
|---|---|---|
| ||
public interface Specification<T> {
Predicate toPredicate(Root<T> root, CriteriaQuery query, CriteriaBuilder cb);
} |
Por tener nuestro proyecto organizado, podemos hacernos una clase Java para implementar nuestros métodos que devuelvan objetos Specificacion. Estos métodos tendrán que implementar toPredicate, la forma más sencilla sería la siguiente:
| Bloque de código | ||
|---|---|---|
| ||
public static Specification<Comunicacion> metodo(String autor, String titulo, List<Long> ids) {
return (root, query, cb) -> {
// Predicado que iremos formando con ANDs, para tener múltiples condiciones
Predicate predicado = null;
if (autor != null)
predicado = cb.like(root.get(Comunicacion_.AUTOR), "%" + autor + "%");
if (titulo != null) {
if (predicado == null)
predicado = cb.like(root.get(Comunicacion_.TITULO), "%" + titulo + "%");
else
predicado = cb.and(predicado, cb.like(root.get(Comunicacion_.TITULO), "%" + titulo + "%"));
}
// Subquery que puede acceder a cada elemento seleccionado por la query padre y
// añadir condiciones. La query externa quedaría así:
if (ids != null) {
Subquery<Long> subquery = query.subquery(Long.class);
Root<ComunicacionComponente> subRoot = subquery.from(ComunicacionComponente.class);
// Contamos para comparar más tarde con la longitud de la lista, pues tendrán
// que ser igual
subquery.select(cb.count(subRoot));
// Cogemos todos los ComunicacionComponente cuya comunicación tenga el mismo ID
// que el seleccionado por la query exterior
Predicate mismaComunicacion = cb.equal(root.get(Comunicacion_.ID),
subRoot.get(ComunicacionComponente_.COMUNICACION));
Predicate componenteEnLista = subRoot.get(ComunicacionComponente_.COMPONENTE).in(ids);
subquery.where(cb.and(mismaComunicacion, componenteEnLista));
if (predicado == null)
predicado = cb.equal(subquery, ids.size());
else
predicado = cb.and(predicado, cb.equal(subquery, ids.size()));
}
return predicado;
};
} |
En este ejemplo, se devuelve un Predicate en el que se devuelven Comunicaciones filtrando por título, autor y/o componentes. Se va elaborando el predicado, con sus condiciones, utilizando la instancia de CriteriaBuilder. Query hace referencia a la query actual, y se pueden sacar subqueries, por ejemplo, para añadir condiciones a los elementos obtenidos por la query padre. Con root estamos accediendo a los datos, a los objetos Comunicación. Para información más detallada, podemos consultar la documentación oficial de Spring. Métodos como este los podemos indicar como parámetro de findAll en el JpaRepository correspondiente:
| Bloque de código | ||
|---|---|---|
| ||
comunicacionRepository.findAll(metodo()); |
En la implementación del método podemos ver referencias a clases seguidas de un guión bajo, estas son las clases del metamodelo, vamos a ver cómo generarlas.
Generar clases del metamodelo
Podemos generar automáticamente estas clases, incluyendo esta dependencia en nuestro pom.xml:
| Bloque de código | ||
|---|---|---|
| ||
<dependency>
<groupId>org.hibernate</groupId>
<artifactId>hibernate-jpamodelgen</artifactId>
<scope>provided</scope>
</dependency> |
...
Imprimir por consola las queries SQL que se ejecutan
Podemos hacer que se impriman en la consola las queries que ejecuta Hibernate para depurar las llamadas a base de datos que se hacen añadiendo las siguientes dos propiedades al application.properties:
| Bloque de código |
|---|
spring.jpa.show-sql=true
spring.jpa.properties.hibernate.format_sql=true |
Llamadas a métodos de base de datos
...