Utilización de GraphQL

Introducción

GraphQL es una alternativa a las API REST. Consiste en un lenguaje de consulta y un entorno de ejecución. Fue creado por Facebook en 2012 y luego abrió el código en 2015.

Como recordatorio, aquí están las evoluciones de las formas de llamar a un proceso remoto:

GraphQL se basa en consultas POST, que, por lo tanto, se deben almacenar en caché en el lado del cliente. Estas consultas indican el orden y la selección de los campos que se devolverán desde el servidor. El servidor define el contrato de intercambio a través de un esquema. Este contrato especifica cómo leer y escribir datos. GraphQL intercambia los datos a través de un grafo y se puede utilizar...

El esquema

Antes de ver las consultas, necesitamos estudiar el esquema de GraphQL en el que se basan, que tiene un formato específico.

El esquema permite listar los datos que los clientes solicitan a través de tipos de objeto. El desarrollador de la API asocia cada campo de un esquema con una función llamada resolver, que genera un valor en tiempo de ejecución.

El esquema se divide en secciones que se identifican por su tipo. Existen los tipos específicos de las operaciones y los relativos a la descripción de los datos.

Un esquema es un grafo que normalmente se diseña y describe en cuatro pasos: 

Comencemos con los nodos del grafo que representan los datos:

type Libro { 
} 
 
type Autor { 
} 

A continuación, agreguemos los tipos escalares (Scalar), utilizando los tipos integrados Int, Float, String, Boolean e ID. A nivel de tipo, podemos indicar que la variable es opcional usando «!».

type Libro { 
 titulo: String! 
 Contenido: String! 
} 
 
type Autor { 
 nombre: String! 
} 

A continuación, añadimos las relaciones entre los objetos:

type Libro { 
 titulo: String! 
 Contenido: String! 
 # necesario para los libros que tienen un autor. 
 tienePorAutor: Autor! 
} 
 
type...

La extensión Spring Data Querydsl

Querydsl es una librería que permite simplificar la creación de predicados de consultas, generando un metamodelo con ayuda de un preprocesador de anotaciones. La librería es independiente de Spring y está disponible en: http://querydsl.com/

A continuación, se muestra un ejemplo simple para ilustrar su uso:

List<Person> persons = queryFactory.selectFrom(person) 
 .where( 
   person.firstName.eq("John"), 
   person.lastName.eq("Doe")) 
 .fetch(); 

Usarlo con GraphQL y Spring simplifica el código. Creamos un Bean Repository de tipo QuerydslPredicateExecutor que manipula DataFetcher. Spring Data cubre JPA, MongoDB y LDAP para el uso de QuerydslPredicateExecutor.

Por ejemplo:

Para un resultado único:

// For single result queries 
DataFetcher<Account> dataFetcher = 
       QuerydslDataFetcher.builder(repository).single(); 

Para obtener un resultado en forma de lista:

// For multi-result queries 
DataFetcher<Iterable<Account>> dataFetcher = 
       QuerydslDataFetcher.builder(repository).many(); 

DataFetcher construye un Querydsl Predicate a partir de los argumentos de consulta GraphQL. Posteriormente, lo utiliza para procesar el acceso a los datos. Su uso es hasta cierto punto delicado, porque es necesario...

Controladores GraphQL

Los controladores GraphQL son controladores REST clásicos que se personalizan. AnnotatedControllerConfigurer detecta estos controladores. Especificamos que un método de controlador se corresponde con un campo de consulta usando la anotación @QueryMapping. La consulta se determina a partir del nombre del método si el método no se especifica como argumento de la anotación.

@Controller 
public class HolaController { 
 
       @QueryMapping 
       public String hola() { 
           return "Hola a ti"; 
       } 
} 

RuntimeWiring.Builder se utiliza para registrar la consulta llamada «hola» como graphql.schema.DataFetcher.

@SchemaMapping

Es posible personalizar el nombre del tipo padre y el nombre del campo en la anotación @SchemaMapping:

@Controller 
public class LibroController { 
 
   @SchemaMapping(typeName="Libro", field="autor ") 
   public Autor getAutor(Libro libro) { 
       // ... 
   } 
} 

La anotación se puede declarar a nivel de la clase, para especificar un nombre de tipo predeterminado para todos los métodos...

Autoconfiguración

Solo detallamos la versión HTTP a título ilustrativo. Un ejemplo adicional basado en WebFlux está disponible en los ejemplos descargables. La configuración automática se realiza a través de GraphQlWebMvcAutoConfiguration. Hay un equivalente para WebFlux: GraphQlWebFluxAutoConfiguration.