[python] gRPC 간단하게 구현해보기

 

네트워크 통신 프로토콜 gRPC와 websocket을 비교해보았다

[gRPC] gRPC과 websocket 비교 정리

 

익숙하지 않은 gRPC를 python으로 간단하게 구현해보았다

 

1. Protocol Buffers (Protobuf) 정의

gRPC의 핵심은 API 인터페이스를 정의하는 Protobuf 파일이다!

.proto 파일 작성한다 = 서비스와 메시지의 스키마를 정의한다

 

greeter.proto

syntax = "proto3";

service Greeter {
  rpc SayHello (HelloRequest) returns (HelloResponse);
}

message HelloRequest {
  string name = 1;
}

message HelloResponse {
  string message = 1;
}

 

2. gRPC 컴파일러(protoc)를 사용해 서버와 클라이언트 코드를 생성

2-1. Protocol Buffers 컴파일러가 설치되어 있지 않다면 설치한다.

# Mac
brew install protobuf

 

2-2. 패키지도 설치한다.

pip install --upgrade grpcio grpcio-tools

 

2-3. 서버, 클라이언트 코드 생성한다.

protoc --proto_path=. --python_out=. --grpc_python_out=. greeter.proto

# 직접 grpc_tools.protoc 모듈을 Python 명령어로 실행
python -m grpc_tools.protoc -I=. --python_out=. --grpc_python_out=. greeter.proto

 

명령어가 정상적으로 실행되면 파일이 2개 생성된다.

1. greeter_pb2.py
   1. Protocol Buffers 메시지 클래스 정의
   2. .proto 파일에 정의된 메시지(message)와 관련된 Python 클래스들이 포함한다.
   3. 예: HelloRequest, HelloResponse
2. greeter_pb2_grpc.py
   1. gRPC 서비스 Stub 및 서버 인터페이스 정의
   2. 클라이언트와 서버가 호출할 수 있는 gRPC 메서드 Stub과 서비스 클래스를 포함한다.
   3. 예: GreeterStub (클라이언트용), GreeterServicer (서버용)

3. 생성된 파일을 기준으로 서버, 클라이언트 파일 작성

server.py

from concurrent import futures
import grpc
import greeter_pb2
import greeter_pb2_grpc

class GreeterService(greeter_pb2_grpc.GreeterServicer):
    def SayHello(self, request, context):
        print(f"Received request: {request.name}")
        return greeter_pb2.HelloResponse(message=f"Hello, {request.name}!")

def serve():
    server = grpc.server(futures.ThreadPoolExecutor(max_workers=10))
    greeter_pb2_grpc.add_GreeterServicer_to_server(GreeterService(), server)
    server.add_insecure_port('[::]:50051')
    print("Server started on port 50051")
    server.start()
    server.wait_for_termination()

if __name__ == '__main__':
    serve()

 

client.py

import grpc
import greeter_pb2
import greeter_pb2_grpc

channel = grpc.insecure_channel('localhost:50051')
stub = greeter_pb2_grpc.GreeterStub(channel)
response = stub.SayHello(greeter_pb2.HelloRequest(name="World"))
print(response.message)

 

+ 파일 구성 예시

gRPC_test/
├── greeter.proto        # .proto 파일
├── greeter_pb2.py       # protoc에 의해 생성된 파일 (Protocol Buffers 메시지 클래스)
├── greeter_pb2_grpc.py  # protoc에 의해 생성된 파일 (gRPC Stub 및 서비스 인터페이스)
├── server.py            # 서버 코드
└── client.py            # 클라이언트 코드

 

4. 실행

 

1. 서버 실행

python3 server.py
> Server started on port 50051

 

2. 클라이언트 실행

python3 client.py
> Hello, World!

 

클라이언트 실행했을 때, 서버 쪽에도 아래와 같이 찍히면 완성!

Received request: World

왼: server.py ❘ 오 : client.py

 

---

✅ 클라이언트 PC에 필요한 파일

1. client.py: 클라이언트 코드
2. greeter_pb2.py: protoc에 의해 생성된 Protocol Buffers 메시지 클래스 파일
3. greeter_pb2_grpc.py: protoc에 의해 생성된 gRPC Stub 정의 파일

✅ 서버 PC에 필요한 파일

1. server.py: 서버 코드
2. greeter_pb2.py: protoc에 의해 생성된 Protocol Buffers 메시지 클래스 파일
3. greeter_pb2_grpc.py: protoc에 의해 생성된 gRPC Stub 정의 파일
4. greeter.proto: 필요 시 서버 측에서 .proto 파일을 변경하고 다시 컴파일할 경우

---

서버, 클라이언트 코드 생성하는 부분에서 자꾸 다음과 같은 에러가 있었다 ‼️

/Users/~/protoc-gen-grpc_python: program not found or is not executable
Please specify a program using absolute path or make sure the program is available in your PATH system variable
--grpc_python_out: protoc-gen-grpc_python: Plugin failed with status code 1.

→ protoc가 gRPC Python 플러그인(protoc-gen-grpc_python)을 찾지 못했거나 실행 권한이 없는 경우 발생

→ 실행되어야 할 protoc-gen-grpc_python 이 /Users/~/venv/bin 에 설치가 안되어있었다

그래서 직접 생성해줬다

 

1. /Users/~/venv/bin/protoc-gen-grpc_python 파일을 생성

2. 생성한 파일에 내용 추가

#!/bin/bash
exec /Users/~/venv/bin/python -m grpc_tools.protoc "$@"

 

3. 실행 권한 부여

chmod +x /Users/~/venv/bin/protoc-gen-grpc_python

 

그 다음에 protoc를 통해 서버, 클라이언트 파일을 생성하면 되는데

protoc --proto_path=. --python_out=. --grpc_python_out=. greeter.proto

 

아래와 같은 에러 메세지가 출력되었다

Missing input file.
--grpc_python_out: protoc-gen-grpc_python: Plugin failed with status code 1.

 

직접 grpc_tools.protoc 모듈을 python 명령어로 실행했다

python -m grpc_tools.protoc -I=. --python_out=. --grpc_python_out=. greeter.proto

 

→ 그제서야 서버, 클라이언트 파일이 잘 생성된 걸 확인했다 🥲 👍