grpc 서버 구현 예제

grpc_example/ ├── build.gradle.kts ├── settings.gradle.kts ├── src/ │ ├── main/ │ │ ├── kotlin/ │ │ │ └── com/example/ │ │ │ ├── GrpcExampleApplication.kt │ │ │ └── GreetingServiceImpl.kt │ │ ├── proto/ │ │ │ └── greeting.proto │ │ └── resources/ │ │ └── application.yml

/* --------------------------------------------------------------------------- * build.gradle.kts * └ Kotlin DSL로 작성한 Spring Boot + gRPC 프로젝트 예시 * ------------------------------------------------------------------------- */ import com.google.protobuf.gradle.* // ← protobuf DSL(프로토·gRPC 설정)을 인식시키기 위해 반드시 import plugins { kotlin("jvm") version "1.9.25" kotlin("plugin.spring") version "1.9.25" id("org.springframework.boot") version "3.4.4" id("io.spring.dependency-management") version "1.1.7" id("com.google.protobuf") version "0.9.4" // ← proto 컴파일 태스크를 자동 생성하는 Gradle 플러그인 } group = "com.example" version = "0.0.1-SNAPSHOT" java { toolchain { languageVersion = JavaLanguageVersion.of(17) } } repositories { mavenCentral() } dependencies { /* ──────────────── Spring Boot 기본 의존성 ──────────────── */ implementation("org.springframework.boot:spring-boot-starter") implementation("org.jetbrains.kotlin:kotlin-reflect") /* ──────────────── 테스트 의존성 ──────────────── */ testImplementation("org.springframework.boot:spring-boot-starter-test") testImplementation("org.jetbrains.kotlin:kotlin-test-junit5") testRuntimeOnly("org.junit.platform:junit-platform-launcher") /* ──────────────── gRPC 서버 구동 관련 의존성 ──────────────── */ implementation("net.devh:grpc-server-spring-boot-starter:2.15.0.RELEASE") // ↳ Spring Boot와 gRPC Netty 서버를 손쉽게 통합(@GrpcService 자동 빈 등록·포트 바인딩) implementation("javax.annotation:javax.annotation-api:1.3.2") // ↳ gRPC Stub 코드에서 @Generated 등 자바 표준 어노테이션을 사용하므로 필요 /* ──────────────── gRPC 메시지 직렬화·Stub 라이브러리 ──────────────── */ implementation("com.google.protobuf:protobuf-java:4.28.2") // ↳ proto 메시지를 자바 객체로 (역)직렬화하는 핵심 라이브러리 implementation("io.grpc:grpc-protobuf:1.58.0") // ↳ gRPC Java가 protobuf 메시지를 네트워크 스트림에 인코딩/디코딩할 때 사용 implementation("io.grpc:grpc-stub:1.58.0") // ↳ *Grpc.java / *GrpcKt.kt Stub 클래스에서 공통으로 참조되는 API } /* --------------------------------------------------------------------------- * Protocol Buffers & gRPC 코드 생성 설정 * ------------------------------------------------------------------------- */ protobuf { /* 1) protoc 컴파일러 지정: .proto → Java/Kotlin 소스 변환 */ protoc { artifact = "com.google.protobuf:protoc:3.24.0" // 버전을 고정해 환경 간 재현성 확보 } /* 2) gRPC 코드 생성 플러그인 등록 */ plugins { id("grpc") { // 플러그인 이름은 임의; 여기선 "grpc" artifact = "io.grpc:protoc-gen-grpc-java:1.58.0" // ↳ protoc 실행 시 --grpc_out 옵션에 해당. service 정의 → *Grpc.java 생성 } } /* 3) 프로젝트 내 모든 proto 컴파일 태스크에 gRPC 플러그인 적용 */ generateProtoTasks { all().forEach { task -> task.plugins { id("grpc") // 위에서 정의한 플러그인 활성화 } // 필요 시 task.generateDescriptorSet = true 등 세부 옵션도 추가 가능 } } } /* --------------------------------------------------------------------------- * Kotlin 컴파일러 옵션 및 테스트 설정 * ------------------------------------------------------------------------- */ kotlin { compilerOptions { freeCompilerArgs.addAll("-Xjsr305=strict") // Nullable · JSR‑305 어노테이션을 엄격 모드로 } } tasks.withType<Test> { useJUnitPlatform() // JUnit 5 플랫폼 사용 }

// ─────────────────────────────────────────────────────────────── // greeting.proto // · gRPC 서비스 인터페이스와 메시지 정의 파일 // · proto3 문법을 사용하여 인사(greeting) 관련 API를 기술 // ─────────────────────────────────────────────────────────────── // 1) proto 문법 버전 지정 ------------------------------------------------- // • proto2 / proto3 중 하나를 선택해야 하며 // • 최신 gRPC‑Java, Kotlin 환경에서는 proto3 사용이 일반적 syntax = "proto3"; // 2) 패키지 네임스페이스 -------------------------------------------------- // • gRPC 내부에서 서비스·메시지를 구분할 때 사용 // • Java/Kotlin 패키지와 무관(로직상 구분자 역할) package greeting; // 3) Java 코드 생성 옵션 -------------------------------------------------- // 3‑1) java_package // · protoc가 생성할 *.java 파일의 실제 패키지 경로 지정 // · 관례적으로 도메인 역순(com.example.grpc) 사용 option java_package = "com.example.grpc"; // 3‑2) java_multiple_files // · true : 메시지·서비스마다 개별 .java 파일 생성 // · false : 하나의 외부 클래스 안에 중첩 클래스로 생성 // · true 로 두면 Git 충돌·컴파일 시간 측면에서 유리 option java_multiple_files = true; // 4) 서비스 정의 ---------------------------------------------------------- // • GreetingService는 “인사하기” 기능을 외부에 노출 // • rpc 메서드마다 요청·응답 메시지 타입을 지정 service GreetingService { // 4‑1) sayHello // · 단일 요청(HelloRequest)을 받아 단일 응답(HelloResponse)을 돌려줌 // · 스트리밍이 필요하면 `stream` 키워드를 사용 rpc sayHello(HelloRequest) returns (HelloResponse); } // 5) 메시지 타입 정의 ------------------------------------------------------ // • 각 필드는 “타입 + 이름 = 태그번호” 형식 // • 태그번호는 바이너리 직렬화 시 키 역할(1~2³²‑1) // • 중간에 삭제·변경 시 호환성 문제를 피하려면 번호 재사용 금지 message HelloRequest { string name = 1; // 클라이언트가 전송하는 이름(문자열) } message HelloResponse { string message = 1; // 서버가 반환하는 인사말 }

package com.example.grpc import io.grpc.stub.StreamObserver import net.devh.boot.grpc.server.service.GrpcService /** * gRPC 서버 측 구현체. * * ① @GrpcService * ────────────────────────────────────────────────────────────── * • grpc‑spring‑boot‑starter 가 스프링 빈으로 등록하고 * Netty 서버에 자동 바인딩하도록 하는 어노테이션 * * ② GreetingServiceGrpc.GreetingServiceImplBase * ────────────────────────────────────────────────────────────── * • protoc + protoc‑gen‑grpc‑java 가 생성한 추상 클래스 * • proto 파일에 정의한 GreetingService 의 ‘서버 골격’(skeleton) * • 필요한 rpc 메서드(sayHello 등)를 오버라이드해 로직 작성 */ @GrpcService class GreetingServiceImpl : GreetingServiceGrpc.GreetingServiceImplBase() { /** * 단일 요청‑응답 RPC 메서드 구현. * * @param request 클라이언트가 보낸 HelloRequest(name 필드 포함) * @param responseObserver 서버 → 클라이언트로 응답을 push 하는 스트림 */ override fun sayHello( request: HelloRequest, responseObserver: StreamObserver<HelloResponse> ) { // 1) 비즈니스 로직: 인사말 생성 val greetingMessage = "안녕하세요, ${request.name}님!" // 2) 응답 메시지(HelloResponse) 빌드 val response = HelloResponse.newBuilder() .setMessage(greetingMessage) .build() // 3) 응답 전송 responseObserver.onNext(response) // 실제 데이터 push responseObserver.onCompleted() // 스트림 종료 알림 } }

package com.example.grpc import org.springframework.boot.autoconfigure.SpringBootApplication import org.springframework.boot.runApplication @SpringBootApplication class GrpcExampleApplication fun main(args: Array<String>) { runApplication<GrpcExampleApplication>(*args) }

grpc: server: port: 9090