Introducción
gRPC es un framework de procedimiento remoto de alto rendimiento desarrollado por Google. Utiliza el protocolo HTTP/2 para la comunicación entre los servidores y los clientes, y permite la comunicación entre los servicios de diferentes lenguajes de programación.
Configuración del entorno
En el archivo build.gradle se añadieron las dependencias necesarias de gRPC
testImplementation 'io.grpc:grpc-testing:1.41.0'
testImplementation group: 'com.google.protobuf', name: 'protobuf-java', version:'3.23.2'
implementation 'io.grpc:grpc-stub:1.53.0'
implementation 'io.grpc:grpc-api:1.53.0'
implementation 'io.grpc:protoc-gen-grpc-java:1.53.0'
implementation 'io.grpc:grpc-core:1.53.0'
implementation 'io.grpc:grpc-netty-shaded:1.53.0'
implementation 'com.google.api.grpc:proto-google-common-protos:2.14.1'
implementation 'javax.annotation:javax.annotation-api:1.3.2'
implementation 'io.grpc:grpc-protobuf:1.55.1'
Archivos .proto
En gRPC, los servicios y los mensajes que se envían entre el cliente y el servidor se definen en archivos .proto, que utilizan el lenguaje de definición de interfaz (IDL) de Protocol Buffers. Aquí es donde se definen las operaciones que el servicio puede realizar y los tipos de datos que se envían y reciben. Esencialmente, es la especificación de la API de gRPC.
Agregar los archivos .proto necesarios para las pruebas en src/main/proto
Stubs
Un "stub" en gRPC es un término utilizado para referirse al cliente de un servicio gRPC que se conecta a un servidor. Es esencialmente una pieza de código generada a partir del archivo .proto que un cliente puede usar para invocar métodos de un servicio remoto. Toma un mensaje de protocolo, serializa el mensaje en el formato correcto, envía la solicitud a través de la red, y luego espera y deserializa las respuestas para enviarlas de vuelta al código de llamada.
El enfoque más común para realizar pruebas en Java con gRPC es utilizar un stub generado automáticamente. Esto permite enfocarse en probar la lógica específica del cliente sin preocuparse por la complejidad de la comunicación subyacente.
Generar los archivos Java a partir del archivo .proto:
Gradle posee un plugin que permite generar los archivos Java, los cuales incluyen el código para los servicios y mensajes a partir de los archivos .proto, utilizando el compilador de Protocol Buffers (protobuf).
Se cuenta con el plugin de protobuf al archivo build.gradle:
apply plugin 'com.google.protobuf'
También, se incluye la siguiente configuración para el plugin:
protobuf {
protoc {
artifact = 'com.google.protobuf:protoc:3.23.2'
}
plugins{
grpc{
artifact = 'io.grpc:protoc-gen-grpc-java:1.53.0'
}
}
generateProtoTasks {
all()*.plugins {
grpc{
}
}
}
}
Para que el plugin compile los archivos .proto se ejecuta el comando gradle build y se generen los archivos Java necesarios.
Los stubs serán generados en el directorio build/generated/source/proto/main/grpc.
Si se desea no utilizar un stub y probar la comunicación con un servidor gRPC , se tendría que implementar manualmente toda la lógica de comunicación, serialización, deserialización y manejo de la comunicación de red, lo que puede ser bastante complejo y propenso a errores.
Tipos de Stubs en gRPC
Implementación del cliente
Después de generar el código del cliente y del servidor, se implementan los stubs en los script de prueba.
Creación del tipo de Stub
En gRPC en necesario especificar el tipo de stub (cliente) que que se requiere usar para hacer una petición. El tipo de stub que se elija, determina cómo se maneja la petición.
Para seleccionar el tipo de stub, se deben usar los métodos correspondientes de la clase generada automáticamente a partir del .proto.
Por ejemplo, si el servicio se llama AccountAggregationService, gRPC generará una clase AccountAggregationServiceGrpc que contiene métodos: newBlockingStub, newFutureStub, y newStub que se pueden usar para crear los distintos tipos de stubs.
A continuación se especifica como se crea un stub de gRPC bloqueante para la interfaz AccountAggregationService. Esto es esencialmente un cliente que se usará para hacer llamadas al servicio.
AccountAggregationServiceGrpc.AccountAggregationServiceBlockingStub = AccountAggregationServiceGrpc.newBlockingStub();
Definición de los objetos
Las definiciones de objetos para la creación de stubs se han separado en una clase distinta ConstsGRPC.java del proyecto de automatización para simplificar el código y mejorar su comprehensión.
Para el ejemplo anterior se define de la siguiente manera:
public static AccountAggregationServiceGrpc.AccountAggregationServiceBlockingStub AccountAggregationServiceBlockingStub;
Y se tiene una clase llamada TokenDigital.java que extiende de ConstsGRPC.java para manejar los métodos que crean los blocking stubs
@Step("Se obtiene el Blocking Aggregation Service")
public static void accountAggregationServiceBlocking() {
AccountAggregationServiceBlockingStub = AccountAggregationServiceGrpc.newBlockingStub(channel);
}
Add Comment