FE 관점에서 grpc 찍먹하기 (feat. REST api 와의 비교)

By 희은w

2023. 5. 12. 15:35

💡 gRPC와 Rest api의 차이점을 정리하고 장단점을 파악하여 상황에 맞게 적용합니다.

스트레스 테스트 라이브러리를 조사하다가 특정 툴들만 gRPC를 지원하고, gRPC를 사용 중인 코드를 찾아보니 거의 Go, Kotiin 기반 코드들 밖에 없길래 gRPC와 Rest api의 차이점이 무엇이고 언제 무얼 사용해야 하는지 / JS를 통해 자주 사용하지 않는 이유가 있을 지 궁금해서 조사해 봅니다.

Rest api는 기존에 많이 사용해보셨을 것이기 때문에 별도 설명 없이 넘어가겠습니다.

gRPC란?

grpc란 구글에서 개발한 오픈소스 원격 프로시저 호출(RPC) 시스템이며, 전송을 위해 HTTP/2 를 사용하고 인터페이스 정의 언어로 프로토콜 버퍼를 사용하고 있습니다.

client - server side로 구성되며, server side에서는 인터페이스를 정의하고 서버를 구동하여 client의 요청을 받고 client side에서는 stub가 제공하는 메소드를 이용하여 서버와 통신합니다.

출처 : https://grpc.io/docs/what-is-grpc/introduction/

gRPC 사용

gRPC를 사용하기 위해 JS 기반 웹 클라이언트에서 어떤 과정을 거쳐야 하는지 살펴보겠습니다.

1. gRPC 관련 라이브러리 설치

protobuf: binary serialization format
grpc : gRPC communication
grpc-tools : .proto 파일로부터 client, server stub를 생성하기 위해 필요한 서브 툴

❓ stub란 protobuf로 정의된 요청 / 응답 메시지들로부터 자동으로 생성되는 client 측 인스턴스 입니다. 이를 이용하여 우리는 low-level의 원리를 알 필요 없이 보다 높은 레벨의 인터페이스를 이용해 통신을 수행할 수 있습니다.

2. proto 파일 작성

.proto 파일에 IDL(Interface Definition Language)를 이용하여 데이터 구조를 정의해 줍니다. 쉽게 말해 해당 파일이 api 정의서 역할을 합니다.

syntax = "proto3";

service MyService {
  rpc MyMethod(MyRequest) returns (MyResponse) {}
}

message MyRequest {
  string message = 1;
}

message MyResponse {
  string message = 1;
}

3. (선택) gRPC Client 코드 생성

protoc cli 를 이용하여 js로 된 gRPC 코드를 생성합니다. 이 파일은 우리가 JS 코드 상에서 사용할 수 있는 stub를 만들어주는 역할을 합니다.

4. JS 통신 코드 작성

const grpc = require('grpc');
const myService = require('./my_service_pb'); // 3번에서 만든 파일

/* 이렇게 직접 코드 상에서 stub를 생성해도 됨
const packageDefinition = protoLoader.loadSync('path/to/your.proto');
const myService = grpc.loadPackageDefinition(packageDefinition).myService;
*/

// Create a client stub
const myServiceClient = new myService.MyServiceClient('localhost:50051', grpc.credentials.createInsecure());

// Invoke a remote method on the server
const request = new myService.MyRequest();
request.setMessage('Hello from gRPC client!');

myServiceClient.myMethod(request, (error, response) => {
  if (error) {
    console.error('Error:', error);
  } else {
    console.log('Response:', response.getMessage());
  }
});

gRPC vs REST API

	gRPC	REST API
performance	binary serialization을 사용하므로 작은 payload를 생성하여 빠른 데이터 전송을 할 수 있다.
+) HTTP/2를 사용하여 더 좋은 성능을 낸다.	text serialization (e.g. JSON) 를 사용하므로 비교적 느리다.
interface	stub를 생성하면 편리하게 이용 가능하다.	fetch, axios 와 같은 web api로 편리하게 이용 가능하다.
simplicity	HTTP/2 를 사용하고 protobuf 를 사용해야 하므로 러닝 커브가 좀 있다.	HTTP의 표준 메소드를 그대로 사용하므로 쉽다.
debugging	grpc-web-devtools 같은 익스텐션을 사용해야 개발자 도구에서 네트워크 상의 정보를 확인할 수 있다.	웹 브라우저에서 개발자도구로 별도 처리 없이 요청, 응답을 확인할 수 있다.
interoperability	특정 언어들을 여러 라이브러리나 설정을 추가함으로써 지원한다.	플랫폼이나 언어에 기반하지 않는다.
streaming	양방향 streaming을 기본적으로 지원하지만 gRPC-web에서는 지원하지 않는다.	기본적으로는 지원하지 않고 별도의 툴을 이용해야 한다.
generate code	o	with tools

gRPC는 높은 퍼포먼스를 내며 코드를 생성해준다는 점에서 의미가 있지만, 사용하기 쉬우며 기존 시스템과 상호운용적이고 이미 REST API에 익숙한 팀이라면 REST API를 사용하는 것이 낫습니다. 개인적으로 gRPC를 사용할 때 디버깅 및 개발 시 너무 많은 라이브러리 + 툴에 의존해야 하는 것도 단점인 것 같습니다.