gRPC para TypeScript: bibliotecas, configuração e exemplos de código

gRPC para TypeScript: bibliotecas e exemplos

gRPC é um framework moderno e de alto desempenho para chamada remota de procedimentos (RPC), desenvolvido pelo Google. Ele usa Protocol Buffers (protobuf) como linguagem de definição de interface e formato de serialização de dados. Em TypeScript, o gRPC é implementado através dos pacotes @grpc/grpc-js (para lógica de servidor e cliente) e protobufjs (para trabalhar com arquivos .proto). Neste artigo, abordaremos as principais bibliotecas, a configuração do ambiente e escreveremos um exemplo funcional em TypeScript.

Principais bibliotecas para gRPC em TypeScript

• @grpc/grpc-js — implementação pura em JavaScript do gRPC (sem addons C++). Suporta todas as funcionalidades principais: chamadas unárias, streaming do servidor e do cliente, streaming bidirecional.
• protobufjs — biblioteca para carregar, analisar e gerar classes a partir de arquivos .proto. Permite criar dinamicamente mensagens e serviços.
• @grpc/proto-loader — pacote auxiliar que simplifica o carregamento de arquivos proto e gera automaticamente tipos TypeScript com base nas definições.
• ts-protoc-gen — gerador de código para o compilador protoc. Permite gerar classes e interfaces estritamente tipadas a partir de arquivos .proto.

Para a maioria dos projetos, a combinação @grpc/grpc-js + @grpc/proto-loader é suficiente. Se for necessária segurança máxima de tipos, use ts-protoc-gen ou protobufjs com geração de tipos estáticos.

Instalação das dependências

Crie um novo projeto e instale os pacotes necessários:

mkdir grpc-typescript-examplecd grpc-typescript-examplenpm init -ynpm install @grpc/grpc-js @grpc/proto-loadernpm install -D typescript @types/nodenpx tsc --init

Criação do arquivo proto

Vamos definir um serviço simples para trabalhar com usuários. Crie o arquivo user.proto:

syntax = "proto3";

package user;

service UserService {  rpc GetUser (GetUserRequest) returns (User);  rpc ListUsers (ListUsersRequest) returns (stream User);}

message GetUserRequest {  int32 id = 1;}

message ListUsersRequest {  int32 page = 1;  int32 limit = 2;}

message User {  int32 id = 1;  string name = 2;  string email = 3;}

Implementação do servidor gRPC em TypeScript

Crie o arquivo server.ts:

import * as grpc from '@grpc/grpc-js';import * as protoLoader from '@grpc/proto-loader';import path from 'path';

const PROTO_PATH = path.join(__dirname, 'user.proto');

const packageDefinition = protoLoader.loadSync(PROTO_PATH, {  keepCase: true,  longs: String,  enums: String,  defaults: true,  oneofs: true,});

const userProto = grpc.loadPackageDefinition(packageDefinition) as any;

// Simulação de banco de dadosconst users = [  { id: 1, name: 'Alice', email: 'alice@example.com' },  { id: 2, name: 'Bob', email: 'bob@example.com' },];

function getUser(  call: grpc.ServerUnaryCall<{ id: number }, any>,  callback: grpc.sendUnaryData<any>) {  const user = users.find(u => u.id === call.request.id);  if (!user) {    return callback({      code: grpc.status.NOT_FOUND,      message: 'User not found',    });  }  callback(null, user);}

function listUsers(call: grpc.ServerWritableStream<{ page: number; limit: number }, any>) {  const page = call.request.page || 1;  const limit = call.request.limit || 10;  const start = (page - 1) * limit;  const end = start + limit;  const paginatedUsers = users.slice(start, end);  paginatedUsers.forEach(user => call.write(user));  call.end();}

function main() {  const server = new grpc.Server();