Skip to content

Interoperabilidade de API's escritas em linguagens diferentes com gRPC

License

Notifications You must be signed in to change notification settings

earmarques/tcc_grpc

Repository files navigation

Estudo da Interoperabilidade de APIs com gRPC

Nós construímos um sistema distribuído de microsserviços fazendo a interoperabilidade de APIs implementadas em quatro linguagens de programação diferentes (Golang, Dart, Java e Javacript), utilizando o gRPC para a comunicação entre os sistemas de APIs.


O que é gRPC?

É um framework desenvolvido pela Google para tratar de chamadas de procedimento remotas (Remote Procedure Call - RPC).

Atualmente esta tecnologia é usada por grandes empresas líderes no ramo da tecnologia da informação como Google, Netflix, Docker, Kubernetes, Cisco, Dropbox, IBM, etc. O gRPC faz parte da Cloud Native Computing Foundation – CNCF e está integrado às tecnologias desse ecossistema. A documentação oficial pode ser encontrada em grpc.io.

Benefícios

O gRPC usa HTTP/2 como protocolo de transporte, com uma série de recursos avançados:

  • Mensagens leves. As mensagens codificadas com gRPC podem ser até 60–80% menores que as mensagens JSON.

  • Geração de códico. O gRPC automatizou a geração de código que tratam dos detalhes da comunicação, como conexão, controle do fluxo de dados e serialização. O suporte do gRPC abrange linguagens como C#, C++, Java, Go, Kotlin, Node, PHP, Python, Ruby e várias outras.

  • Suporta streaming. O gRPC também fornece streaming de dados: streaming do lado do servidor, streaming do lado do cliente e streaming bidirecional.

  • Super rápido. gRPC é cerca de 7 a 8 vezes mais rápido que a comunicação REST+JSON sobre HTML/1.1.


Apresentação

Este foi o nosso Trabalho de Conclusão do Curso Análise e Desenvolvimento de Sistema apresentado à Fatec de São José de Rio Preto/SP em junho de 2022. Nós estávamos interessados em compreender a tecnologia do gRPC, um novo estilo arquitetural, mais rápido e eficiente, com menores payload, tráfego e latência, bidirecional e nativamente poliglota.

Para "sentirmos" como se dá a comunicação de sistemas distribuídos no gRPC, nós fizemos quatro API's escritas em linguagens de programação diferentes conversarem entre si. Duas delas são mais recentes, Golang e Dart, e duas já a bastante tempo no mercado, JavaScript e Java. O que a aplicação faz em si é bem simples, no entanto, o nosso foco está na comunicação, na interoperabilidade poliglota de API's oferecida pelo gRPC.

Na Figura 1 vemos a essência da arquitetura implementada. A fábula é a seguinte: a aplicação Java é um head hunter, um caça-talentos que precisa fornecer uma lista de 10 programadores a uma empresa que irá desenvolver um novo projeto. O Java possui internamente uma lista de 51 contatos para selecionar os 10 necessários ao projeto. A seleção está automatizada para selecionar os 10 amostrados aleatoriamente da lista interna de 51. Nada usual na vida real, mas foi a estória que criamos para contextualizar nossos testes.

Arquitetura implementada
Figura 1: Arquitetura implementada

Para saber qual programador selecionar, o cliente Java consome uma API que oferece o serviço de sortear números inteiros dentro dos limites de um intervalo. Para tanto, a aplicação Java fornece um intervalo de 0 a 50 à API JavaScript e fica fazendo chamadas remotas ao servidor NodeJS até preencher a quantidade desejada.

Depois, o Java precisa persistir os programadores selecionados em um banco de dados para que a empresa possa consultar o seu time de desenvolvedores. Uma API implementada em Dart fará a emulação de um banco de dados (mock). Dart oferece um serviço de API contendo todos os métodos das operações elementares de um banco de dados: criar, atualizar, buscar por id, listar todos e apagar. O serviço Dart salva os dados apenas em memória.

Quando inserimos dados em um banco relacional, usualmente criamos um número sequencial para o id. Dart é o servidor de banco de dados do Java, entretanto, a fim de testarmos a comunicação entre APIs, fizemos a API Dart por sua vez ser cliente de outra API, escrita em Golang. A API Golang faz o papel de gerador de chave primária, fornecendo números sequências a cada chamada remota para que o Dart possa usá-los como identificador único da entidade Programador, cuja aplicação Java lhe solicitou para salvar no banco.
Dessa forma, temos quatro sistemas implementados em linguagens distintas se comunicando, fornecendo e consumindo serviços de API com o gRPC.


Execução

O cliente principal, o maior consumidor de microserviços é o Java, mas é totalmente dependente dos outros serviços. E cada API tem seu próprio ambiente de excecução, seu próprio servidor. Sendo assim, nós vamos criar um diretório para cada linguagem de programação. É preciso ter em mente que cada diretório é como se fosse um repositório, logo, cada um deles terá o seu README.md com as instruções e comandos de execução no terminal. JavaScript e Golang não possuem dependência, mas Dart depende que o serviço Go esteja no ar, e o Java depende de todos eles, sendo assim, nós faremos os "sub-repositórios" na seguinte sequência:

1. JavaScript
2. Golang
3. Dart
4. Java

Interoperabilidade de APIs com gRPC - Simulação
Figura 2: Interoperabilidade de APIs com gRPC - Simulação

Nos README.md's dos sub-repositórios haverá apenas as instruções para subir o servidor e alguns testes. Explicações mais detalhes do que cada trecho do código faz, o leitor pode consultar a Wiki do projeto, onde temos uma explicação mais abrangente e integrada. Se o leitor estiver interessado no gRPC rodando em apenas uma das linguagens de programação, pode ir até o sub-repositório da linguagem de interesse, que as instruções ali presentes bastam para fazer o gRPC funcionar.

Nós estamos utilizando no momento o Pop!_OS 22.04 LTS, uma ditribuição linux baseada no Debian. Nela estamos utilizando uma ferramenta CLI de gerenciamento de ambiente de execução chamado asdf. Com ela podemos controlar o versionamente global (qualquer diretório) ou local (apenas um diretório) de praticamente todas as linguagens de programação existentes. Depois de instalado o core do asdf é só instalar o plugin específico da linguagem que quer versionar e pronto; qualquer linguagem de programação em um único gerenciador. A documentação é tranquila, confira em asdf - Getting Started para instalação do core e dos plugins, e para ver como é simples fazer o controle de versionamento, confira asdf - Versions.

Peço desculpas aos usuários Windows por não oferecer orientações em seu sistema operacional. As instalações do Windows geralmente são até mais simples, aquela conhecida sequência Next, Next, ..., Done. Acredito que apenas o início será diferente, depois os comandos CLI específicos de cada linguagem serão os mesmos.


Gerenciador asdf

O essêncial para instalação em distros baseado em Debian como o Ubuntu, está a seguir; para mais detalhes e outras distros consulte a documentação.

1. Instalar as dependência
sudo apt install curl git
2. Baixar o asdf

´ Melhor forma é clonar o repositório usando o git instalado no passo 1.

git clone https://github.com/asdf-vm/asdf.git ~/.asdf --branch v0.10.2https://github.com/earmarques/tcc_grpc/blob/main/README.md#estudo-da-interoperabilidade-de-apis-com-grpc
3. Instalar o asdf

Edite o arquivo ~/.bashrc e adicione as duas linhas abaixo ao final do arquivo:

. $HOME/.asdf/asdf.sh
. $HOME/.asdf/completions/asdf.bash

Deve ficar assim:

Instalação do asdf - adcionar duas linhas ao ~/.bashrc
Figura 3: Instalação do asdf - adcionar duas linhas ao ~/.bashrc

É só isso, o core do asdf já está pronto, a seguir viria 4.Instalar plugin e 5. Instalar a versão da ferramenta desejada, mas isso faremos dentro do diretório raiz de cada linguagem. Para que as alterações se efetivem, devemos abrir um novo terminal para que as novas configurações do .bashrc sejam carregadas ou então recarregá-lo no mesmo terminal com o comando:

source ~/.bashrc

Começaremos criando a pasta geral tcc_grpc e dentro dela a pasta que abrigará a API Javascript.

mkdir -p tcc_grpc/js_grpc; cd tcc_grpc/js_grpc;

Agora convidamos o leitor para ir até o sub-repositório do 1. JavaScript para ver como é simples configurar o gRPC no NodeJS.



⬆️ Topo