Jaime's 기술 블로그

개발에 앞서 컨벤션충인 저는 .proto 파일 작성에 필요한 컨벤션을 가볍게 알아보겠습니다. 관련 정보는 공식 문서 내 스타일 가이드를 참고하였습니다. 이 문서는 .proto 파일에 대한 스타일 가이드를 제공합니다. 컨벤션을 따르면 프로토콜 버퍼 메시지 정의와 해당 클래스를 일관되고 읽기 쉽게 만들 수 있습니다. 프로토콜 버퍼 스타일은 시간이 지남에 따라 발전했기 때문에 다른 규칙이나 스타일로 작성된 .proto 파일을 볼 수 있습니다. 이러한 레거시 파일을 수정할 때는 기존 스타일을 준수하는 것이 좋습니다. 뭐든 일관성이 있는 게 중요하니까요. 일관성이 핵심입니다. 그러나 새 .proto 파일을 만들 때는 현재 최상의 스타일을 적용하는 것이 가장 좋습니다. 파일 포매팅 줄 길이를 80자로 유지하세요. ..

Option .proto 파일 내에서 여러 가지 옵션을 사용할 수 있습니다. 옵션은 선언의 전체 의미를 변경하지 않지만 특정 컨텍스트에서 처리되는 방식에 영향을 줄 수 있습니다. 사용 가능한 옵션의 전체 목록은 google/protobuf/descriptor.proto에 정의되어 있습니다. 파일 레벨 옵션은 메시지나 열거형, 서비스 정의 안 쪽에 작성해서는 안 되고 반드시 최 상단에 작성해야 합니다. 메시지 레벨 옵션은 메시지 정의 안 쪽에 작성해야 합니다. 필드 레벨 옵션은 필드 정의 안 쪽에 작성해야 합니다. 옵션은 열거형 타입이나 값, oneof 필드, service 타입, service 메서드에 사용할 수 있습니다만 현재는 해당 레벨에 사용했을 때 유용한 옵션은 존재하지 않습니다. 가장 많이 사용..

Service 정의하기 RPC(Remote Procedure Call, 원격 프로시저 호출) 시스템에서 메시지 타입을 사용하려는 경우 .proto 파일에 RPC 서비스 인터페이스를 정의하면 프로토콜 버퍼 컴파일러가 선택한 언어로 서비스 인터페이스 코드와 스텁을 생성합니다. 예를 들어, SearchRequest를 받아 SearchResponse를 반환하는 메서드로 RPC 서비스를 정의하려는 경우 다음과 같이 .proto 파일에 정의할 수 있습니다. service SearchService { rpc Search(SearchRequest) returns (SearchResponse); } 프로토콜 버퍼와 함께 사용할 수 있는 가장 간단한 RPC 시스템이 바로 Google에서 개발한 언어 및 플랫폼에 대해 중립..

Map 메시지를 정의할 때 맵을 사용하기 위해 프로토콜 버퍼는 간편한 방법을 제공합니다. map map_field = N; key_type은 정수나 문자열 타입이 될 수 있습니다. 이는 스칼라 타입 중 부동 소수점이나 바이트를 제외한 모든 타입에 해당합니다. 다만, 열거형은 사용할 수 없습니다. value_type은 다른 map을 제외한 모든 타입이 될 수 있습니다. map projects = 3; 이렇게 문자열에 Project라는 메시지 타입을 매핑하여 사용할 수 있습니다. map은 어떤 언어에서든 사용법이나 선언하는 방법이 비슷하므로 추가적인 설명은 필요하지 않을 거 같습니다. map은 repeated 타입이 될 수 없습니다. map의 item들은 순서를 가지지 않습니다. .proto 타입에 대한 텍..

Any Any 메시지 타입은 .proto로 정의되지 않은 타입을 포함할 수 있게 합니다. Any에는 바이트로 직렬화된 임의의 메시지와 URL을 포함하는데, 해당 URL은 메시지 타입에 대해 고유한 식별자 역할을 합니다. Any 타입을 사용하기 위해선 google/protobuf/any.proto를 import 해야 합니다. import "google/protobuf/any.proto"; message ErrorStatus { string message = 1; repeated google.protobuf.Any details = 2; } 주어진 메시지 타입에 대한 기본 타입 URL은 type.googleapis.com/packagename.messagename 으로 구성됩니다. 다른 언어로 구현될 때는 ..

중첩 타입(Nested Type) 다른 메시지 타입 안에 메시지 타입을 정의하여 사용할 수 있습니다. 아래 예제는 SearchResponse 안에 Result 라는 타입을 정의해서 사용한 것 입니다. 이전 포스팅에서 enum을 안에 정의한 것과 동일하게 사용할 수 있습니다. 사실 이 글을 보시는 분들은 소스 코드가 더 익숙하실 거라 자세한 설명보다는 예제로 접하는 게 더 익숙하실 거 같습니다. message SearchResponse { message Result { string url = 1; string title = 2; repeated string snippets = 3; } repeated Result results = 1; } 만약에 위 처럼 선언한 메시지 타입을 다른 메시지 타입에서 사용해야..

Enumerations 메시지 타입을 정의할 때 해당 필드 중 하나에 미리 정의된 값들의 리스트 중 하나만 포함되도록 할 수 있습니다. 예를 들어, corpus가 UNIVERSAL, WEB, IMAGES, LOCAL, NEWS, PRODUCTS 또는 VIDEO 중 하나일 때 SearchRequest에 대해 corpus 필드를 추가하려고 한다고 가정해 보겠습니다. 메시지를 정의할 때 열거형(enum)을 사용하면 매우 간단히 해결할 수 있습니다. 열거형 타입으로 지정된 필드는 해당 enum 중 하나로만 지정할 수 있습니다. 만약 다른 값으로 지정했을 경우 알 수 없는 필드로 취급하게 됩니다. message SearchRequest { required string query = 1; optional int32..

스칼라 데이터 타입(Scalar Value Type) 스칼라 메시지 필드는 아래 타입 중 하나를 가질 수 있습니다. 아래 테이블은 .proto 파일에 지정된 타입과 자동으로 생성된 클래스의 타입을 보여줍니다. .proty Type Notes C++ Type Java/Kotlin Type Python Type Go Type Ruby Type C# Type PHP Type Dart Type double double double float float64 Float double float double float float float float float32 Float float float double int32 가변 길이 인코딩을 사용, 음수 인코딩에 비효율적, 음수 가능성이 있는 경우 sint32 사용 int..

이제부터 포스팅 할 내용은 .proto 파일 문법을 포함하여 프로토콜 버퍼 데이터를 구조화하기 위해 프로토콜 버퍼 언어를 사용하는 방법과 .proto 파일에서 데이터 액세스 클래스를 생성하는 방법을 다룰 예정입니다. 메시지 타입 정의 먼저 간단한 예제를 살펴보겠습니다. 검색 요청에 쿼리 문자열, 결과 페이지 및 페이지 당 결과 수가 있는 검색 요청 메시지 형식을 정의하려고 한다고 가정해 보겠습니다. 다음은 메시지 유형을 정의하는 데 사용하는 .proto 파일입니다. syntax = "proto3"; // (1) message SearchRequest { // (2) string query = 1; int32 page_number = 2; int32 result_per_page = 3; } (1) 첫 번 ..

gRPC(google Remote Procedure Call)란 구글에서 만든 원격 프로시저 호출 프레임워크 입니다. 꾸준히 업데이트 되고있는 오픈소스로 성능이 매우 좋고 어떠한 환경에서도 실행시킬 수 있다는 장점을 가지고 있어 이미 몇 년 전부터 각광받는 기술입니다. 로드 밸런싱, 추적(trace), 상태 확인 및 인증을 위한 플러그형 지원을 통해 서비스를 효율적으로 연결할 수 있습니다. 또한 디바이스, 모바일 애플리케이션 및 브라우저를 백엔드 서비스에 연결하기 위한 분산 컴퓨팅의 마지막 단계에도 적용할 수 있습니다. 강력한 바이너리 직렬화 도구이자 언어인 프로토콜 버퍼(Protocol Buffer)를 이용하여 서비스를 정의하고, 간결하게 런타임 및 개발 환경을 설치하고 프레임워크를 사용하여 초당 수백..