개발 중 리플렉션으로 gRPC API 잠금 해제하기

소개

마이크로서비스 및 분산 시스템의 진화하는 환경에서 gRPC는 서비스 간 통신을 위한 강력한 프레임워크로 부상했으며, 상당한 성능 이점을 제공하고 효율적인 직렬화를 위해 프로토콜 버퍼를 활용합니다.

그러나 gRPC 서비스를 개발하고 디버깅하는 것은 때때로 블랙박스를 탐색하는 것처럼 느껴질 수 있습니다. 서비스 정의를 검사하거나 엔드포인트와 동적으로 상호 작용할 수 있는 즉시 사용 가능한 도구가 없으면 개발자는 수동으로 작성된 클라이언트 코드나 번거로운 모의에 의존하는 경우가 많아 개발 주기가 느려집니다.

이러한 문제는 gRPC 리플렉션, 특히 grpcurl과 같은 도구와 결합될 때 개발 환경에서 없어서는 안 될 자산이 되는 정확한 이유입니다.

이는 불투명한 것을 투명한 것으로 변환하여 궁극적으로 개발을 가속화하고 디버깅을 단순화하면서 서비스에 대한 즉각적인 자체 검사 및 상호 작용을 가능하게 합니다.

gRPC 리플렉션 및 동적 탐색 해독

"방법"을 자세히 살펴보기 전에 이 강력한 개발 워크플로의 기초가 되는 핵심 개념을 명확히 해보겠습니다.

핵심 용어

gRPC 프로토콜: 모든 환경에서 실행할 수 있는 현대적인 오픈 소스 고성능 RPC 프레임워크입니다. 클라이언트와 서버 애플리케이션 간에 투명하게 통신할 수 있도록 하며 연결된 시스템 구축을 더 쉽게 만듭니다.
프로토콜 버퍼(Protobuf): 구조화된 데이터를 직렬화하기 위한 Google의 언어 중립적, 플랫폼 중립적, 확장 가능한 메커니즘입니다. gRPC에서 서비스 인터페이스 및 메시지 구조를 정의하는 데 사용됩니다.
gRPC 리플렉션: 클라이언트가 .proto 파일에 대한 사전 지식 없이 서버가 노출하는 서비스에 대한 정보(메서드 및 메시지 유형 포함)를 쿼리할 수 있도록 하는 gRPC 서비스입니다. 본질적으로 gRPC 서버가 자체를 설명할 수 있도록 합니다.
grpcurl: gRPC용 curl처럼 작동하는 명령줄 도구입니다. 특히 gRPC 리플렉션이 활성화된 경우 .proto 파일에서 코드를 생성할 필요 없이 gRPC 서버와 상호 작용할 수 있습니다.

gRPC 리플렉션 메커니즘

서버에서 gRPC 리플렉션이 활성화되면 reflection.proto 정의를 기반으로 하는 특수 서비스인 grpc.reflection.v1alpha.Reflection이 노출됩니다. 이 서비스는 클라이언트가 서버의 서비스에 대한 메타데이터를 가져오기 위해 호출할 수 있는 FileByFilename, FileContainingSymbol, ListServices와 같은 메서드를 제공합니다.

모든 클라이언트와 .proto 파일을 공유하거나 검색 메커니즘을 수동으로 구현하는 대신 서버는 필요에 따라 정의를 단순히 "반영"할 수 있습니다.

개발에서 리플렉션을 활성화하는 이유는 무엇인가요?

gRPC 리플렉션의 기본 가치 제안은 개발 및 디버깅 단계에 있습니다.

동적 서비스 검색: 리플렉션이 없으면 클라이언트는 어떤 서비스와 메서드를 사용할 수 있는지, 어떤 메시지 형식을 사용해야 하는지 알기 위해 .proto 파일이 필요합니다. 리플렉션을 사용하면 grpcurl과 같은 개발 도구가 서버에 직접 쿼리하여 이 정보를 검색할 수 있습니다.
간소화된 디버깅: 임시 클라이언트 코드를 작성할 필요 없이 다양한 입력으로 개별 gRPC 메서드를 터미널에서 직접 빠르게 테스트합니다. 이는 버그를 격리하거나 API 동작을 확인하는 데 매우 중요합니다.
더 빠른 반복: gRPC 서비스를 변경해도 클라이언트 stub을 다시 컴파일하거나 다시 생성할 필요 없이 즉시 테스트할 수 있습니다.
향상된 도구 통합: 많은 gRPC 인식 도구 및 IDE 플러그인은 리플렉션을 활용하여 자동 완성, API 문서 및 대화형 테스트 인터페이스와 같은 기능을 제공합니다.

중요 주의사항: 개발에 매우 유용하지만 일반적으로 프로덕션 환경에서는 gRPC 리플렉션을 활성화해서는 안 됩니다. 서비스의 내부 구조를 노출하여 보안 위험이 될 수 있으며 약간의 오버헤드가 추가됩니다. 프로덕션 배포는 일반적으로 사전 컴파일된 클라이언트 stub과 잘 정의된 API 계약에 의존합니다.

gRPC 리플렉션 활성화: Go 예제

Go 애플리케이션에서 gRPC 리플렉션을 활성화하는 방법을 설명해 보겠습니다. 먼저 grpc-go/reflection 패키지를 가져왔는지 확인합니다.

helloworld.proto로 정의된 간단한 gRPC 서비스를 가정해 보겠습니다.

syntax = "proto3";

package helloworld;

option go_package = "github.com/example/helloworld";

service Greeter {
  rpc SayHello (HelloRequest) returns (HelloReply) {}
}

message HelloRequest {
  string name = 1;
}

message HelloReply {
  string message = 1;
}

그리고 기본적인 Go 서버 구현은 다음과 같습니다.

package main

import (
	"context"
	"log"
	"net"

	"google.golang.org/grpc"
	"google.golang.org/grpc/reflection"

	// 생성된 proto 파일이 여기에 있다고 가정
	pb "github.com/example/helloworld"
)

type server struct {
	pb.UnimplementedGreeterServer
}

func (s *server) SayHello(ctx context.Context, in *pb.HelloRequest) (*pb.HelloReply, error) {
	log.Printf("Received: %v", in.GetName())
	return &pb.HelloReply{Message: "Hello " + in.GetName()},
}

func main() {
	lis, err := net.Listen("tcp", ":50051")
	if err != nil {
		log.Fatalf("failed to listen: %v", err)
	}
	ss := grpc.NewServer()
	pb.RegisterGreeterServer(s, &server{})

	// gRPC 서버에 리플렉션 서비스 등록.
	reflection.Register(s)

	log.Printf("server listening at %v", lis.Addr())
	if err := s.Serve(lis); err != nil {
		log.Fatalf("failed to serve: %v", err)
	}
}

gRPC 서버 인스턴스인 s를 제공하는 reflection.Register(s)만 추가하면 리플렉션이 활성화됩니다!

`grpcurl`로 동적으로 탐색하기

이제 gRPC 서버에 리플렉션이 활성화되었으므로 grpcurl의 힘을 발휘해 봅시다.

먼저 grpcurl이 설치되었는지 확인합니다. 일반적으로 go install github.com/fullstorydev/grpcurl/cmd/grpcurl@latest를 통해 설치하거나 GitHub 릴리스 페이지에서 미리 컴파일된 바이너리를 다운로드할 수 있습니다.

Go 서버를 시작하고 다른 터미널에서 grpcurl을 사용해 보겠습니다.

서비스 나열: .proto 파일 없이도 grpcurl은 서버가 제공하는 서비스를 검색할 수 있습니다.
```
grpcurl -plaintext localhost:50051 list
```
이와 유사한 출력이 표시되어야 합니다.
```
grpc.reflection.v1alpha.Reflection
helloworld.Greeter
```
이렇게 하면 Greeter 서비스와 Reflection 서비스 자체가 사용 가능함을 확인할 수 있습니다.

서비스 또는 메서드 설명: helloworld.Greeter 내의 메서드나 요청/응답 유형을 이해하려면 describe를 사용합니다.

grpcurl -plaintext localhost:50051 describe helloworld.Greeter

출력:

helloworld.Greeter is a service:
service Greeter {
  rpc SayHello ( .helloworld.HelloRequest ) returns ( .helloworld.HelloReply );
}

또는 특정 메시지 유형을 설명합니다.

grpcurl -plaintext localhost:50051 describe helloworld.HelloRequest

출력:

helloworld.HelloRequest is a message:
message HelloRequest {
  string name = 1;
}

메서드 호출: 직접 메서드를 호출하는 것에서 진정한 힘이 나옵니다.
```
grpcurl -plaintext -d '{"name": "Developer"}' localhost:50051 helloworld.Greeter/SayHello
```
출력:
```
{
  "message": "Hello Developer"
}
```
여기:
- -plaintext: 암호화되지 않은 통신을 지정합니다(개발에서 TLS를 사용하지 않는 경우 필수).
- -d '{"name": "Developer"}': JSON 형식으로 요청 페이로드를 제공합니다. grpcurl은 리플렉션 정보를 사용하여 이를 자동으로 프로토콜 버퍼로 변환합니다.
- localhost:50051: gRPC 서버의 주소입니다.
- helloworld.Greeter/SayHello: 호출할 서비스 및 메서드의 정규화된 이름입니다.