gRPC 개요

programmer-study/api-practice/lkdcode-grpc at main · lkdcode/programmer-study

🎯 [Growth]. Contribute to lkdcode/programmer-study development by creating an account on GitHub.

https://github.com/lkdcode/programmer-study/tree/main/api-practice/lkdcode-grpc

🔥 gRPC?

🚀 .proto

• example

message Person {
  string name = 1;
  int32 id = 2;
  bool has_ponycopter = 3;
}

// Greeter 서비스 정의
service Greeter {
  // 메서드 정의
  rpc SayHello (HelloRequest) returns (HelloReply) {}
}

// 요청 메시지
message HelloRequest {
  string name = 1;
}

// 응답 메시지
message HelloReply {
  string message = 1;
}

🔥 간단하게 구현해보자

🚀 .proto 작성하기

• fruit contracts 모듈에 명세서를 작성한다.

syntax = "proto3";

package lkdcode.kiwi.v1;

import "google/protobuf/empty.proto";

option java_multiple_files = true;
option java_package = "lkdcode.grpc.kiwi.v1";
option java_outer_classname = "KiwiServiceV1Proto";

service KiwiService {
  rpc action(KiwiRequest) returns (stream google.protobuf.Empty){}
}

message KiwiRequest {
  string name = 1;
}

• option java_multiple_files = true;: 각각의 메시지/서비스를 별도의 .java 클래스로 생성한다. 메시지/enum 이 개별 최상위 클래스로 생성되고 false 로 설정할 경우 static 중첩 클래스로 생성된다. 조직에 알맞게 설정하자.

• option java_package = "lkdcode.grpc.kiwi.v1";: 클래스의 패키지를 지정한다.

• option java_outer_classname = "KiwiServiceV1Proto";: 파일 전체를 대표하는 아우터 클래스를 정의한다. .proto 파일 1개당 생성되는 컨테이너 자바 클래스로 파일 메타데이터, 확장 등록 함수 등이 들어간다.

🚀 server ↔ server 통신을 gRPC로!

• Kiwi application.yml

server:
  port: 18080

grpc:
  server:
    port: 15001
    address: 0.0.0.0

• Tomato application.yml

server:
  port: 28080

grpc:
  server:
    port: 25001
    address: 0.0.0.0
  client:
    kiwi:
      address: static://localhost:15001  # DNS 기반 혹은 정적 주소
      enableKeepAlive: true              # 연결 유지를 위해 주기적으로 ping 전송.
      keepAliveWithoutCalls: true        # 활성 RPC가 없어도 ping 보냄 인프라 정책 확인 필요. 서버/LB 너무 잦으면 연결을 끊을 수 있음
      keepAliveTime: 120s                # ping 주기 (유휴 시간) 마지막 데이터 전송 이후 120초 지나면 ping 전송
      keepAliveTimeout: 30s              # ping 보낸 뒤 응답(ACK)을 기다리는 최대 시간, 초과 시 연결이 비정상이라고 간주
      maxInboundMessageSize: 10485760    # 수신 메시지 최대 크기 (bytes)
      negotiationType: plaintext         # 전송 보안 방식, PLAINTEXT TLS 없이 평문,TLS(인증서 설정 필요)

🚀 의존성

plugins {
		// Gradle 용 Protobuf 플러그인을 추가
    id("com.google.protobuf") version "0.9.4"
}

dependencies {
		// gRPC 클라이언트/서버 스텁 동작 
    implementation("io.grpc:grpc-stub:1.75.0")
		// protobuf 메시지 인코딩/디코딩
    implementation("io.grpc:grpc-protobuf:1.75.0")
    // 전송 구현
    implementation("io.grpc:grpc-netty-shaded:1.75.0")
    // 메시지 런타임 직렬화 로직
    implementation("com.google.protobuf:protobuf-java:4.32.0")
    // gRPC 자동 구성 제공
    implementation("net.devh:grpc-spring-boot-starter:3.1.0.RELEASE")
}

protobuf {
    protoc { // 빌드 시 사용하는 프로토콜 버퍼 컴파일러
        artifact = "com.google.protobuf:protoc:4.32.0"
    }
    plugins {
        grpc { // protoc 가 gRPC 용 자바 스텁 코드 새성
            artifact = "io.grpc:protoc-gen-grpc-java:1.75.0"
        }
    }
    generateProtoTasks {
        all().forEach {
            it.plugins {
                grpc { // 생성되는 gRPC 코드에 @Generated 어노테이션 생략
                    option "@generated=omit"
                }
            }
        }
    }
}

🚀 Tomato Api → Kiwi gRPC

🚀 Kiwi server (server)

@GrpcService
class KiwiService : KiwiServiceGrpc.KiwiServiceImplBase() {

    override fun validate(
        request: KiwiRequest,
        responseObserver: StreamObserver<Empty>
    ) {
        println("V1. KiwiGrpcService 호출")
        println("... 검증")

        responseObserver.onNext(Empty.getDefaultInstance())
        responseObserver.onCompleted()
        println("V1. KiwiGrpcService 종료")
    }
}

🚀 Tomato server (client)

// Tomato module
@Service
class KiwiService(
    @GrpcClient("kiwi")
    private val kiwiServiceGrpc: KiwiServiceGrpc.KiwiServiceBlockingStub,
) {

    fun validate(request: KiwiRequest) {
        println("Tomato.KiwiService 호출")
        kiwiServiceGrpc.validate(request)
        println("Tomato.KiwiService 종료")
    }
}

// Tomato module
@Service
class KiwiRepository(
    @GrpcClient("kiwi")
    private val kiwiRepositoryGrpc: KiwiRepositoryGrpc.KiwiRepositoryBlockingStub,
) {

    fun save(request: KiwiRequest) {
        println("Tomato.KiwiRepository 호출")
        kiwiRepositoryGrpc.save(request)
        println("Tomato.KiwiRepository 종료")
    }
}

🎯 Blocking stub

@GrpcClient("kiwi")
private val kiwiRepositoryGrpc: KiwiRepositoryGrpc.KiwiRepositoryBlockingStub,

🎯 Async stub

@GrpcClient("kiwi")
private val kiwiRepositoryGrpcStub: KiwiRepositoryGrpc.KiwiRepositoryStub,

🎯 Future stub

@GrpcClient("kiwi")
private val kiwiRepositoryGrpcFutureStub: KiwiRepositoryGrpc.KiwiRepositoryFutureStub,

🚀 요청 보내서 확인하기

• 전체 흐름