Protocol Buffer 사용2

required :

 반드시 값이 입력 되어야 하는 필드. 입력되지 않을 경우 객체는uninitialized 로 판단되며

build 하려 할 경우RuntimeException 을 던지며, Parsing 하려 할 경우IOException 을 던진다. 

이것을 제외하면 optional과 동일하다.

Required 키워드는 “매우” 조심스럽게 사용해야 한다.

 

어떤 시점에서 Required 키워드로 정의된 필드를optional 로 변경해야 할 경우가 생기는데, 이 경우 상당한 문제를 야기 할 수 있다.

 

바로, 해당message 의 필드가optional 로 변경된 상태에서 값이 정의되지 않고 전송될 경우, 예전 버전의reader 는 이 값이 없기 때문에 message 가 초기화되지 않았다고 판단, message 를drop 시켜버린다.(하위 버전과의 호환성을 유지할 수가 없다.)

 

이런 점에서 실제로Google 의 몇몇 엔지니어들은required 필드를 아예 이용하지 않고 오직optional 과repeated 키워드만을 이용한다. 물론, 이런 방법이 보편적인 방법적인 방법은 아니다.

 

 

optional : 

값이 설정되든 설정되지 않든 상관 없다. 설정되지 않을 경우에는default 값이 사용 된다.

default 값은proto 파일에서 명시할 수 있지만 명시하지 않을 경우numeric 타입은0, string 타입은 빈 값,

boolean 은false, message 는default 객체, 혹은 메시지의 prototype이 설정 된다.

 [default = HOME];와 같은 형태로default 값을 설정 할 수 있다.

 

repeated : 

repeated 로 선언된 필드는list 로 생성된다.(실제로 리스트와 동일하게 생각하면 된다.)

 

---

 

변형 형식을 위한 Protobuf Any 및 OneOf 필드

Protobuf(프로토콜 버퍼)는 둘 이상의 형식일 수 있는 값을 처리하기 위한 두 가지 간단한 옵션을 제공합니다.

 Any 형식은 알려진 모든 Protobuf 메시지 형식을 나타낼 수 있습니다.

또한 oneof 키워드를 사용하여 모든 메시지에서 필드 범위 중 하나만 설정할 수 있도록 지정할 수 있습니다.

 

 

Any 

Any 메시지 유형을 사용하면 .proto 정의 없이 메시지를 삽입된 유형으로 사용할 수 있습니다. 

 

Any는 임의의 직렬화된 메시지를 bytes로 포함하며 메시지 유형과 관련해

전역적으로 고유한 식별자 역할을 하는 URL을 포함합니다.

 

 Any 유형을 사용하려면 google/protobuf/any.proto를 가져와야 합니다.

syntax = "proto3";

import "google/protobuf/any.proto";

message Stock {
    // Stock-specific data
}

message Currency {
    // Currency-specific data
}

message ChangeNotification {
    int32 id = 1;
    google.protobuf.Any instrument = 2;
}

public void FormatChangeNotification(ChangeNotification change)
{
    if (change.Instrument.Is(Stock.Descriptor))
    {
        FormatStock(change.Instrument.Unpack<Stock>());
    }
    else if (change.Instrument.Is(Currency.Descriptor))
    {
        FormatCurrency(change.Instrument.Unpack<Currency>());
    }
    else
    {
        throw new ArgumentException("Unknown instrument type");
    }
}

Protobuf의 내부 리플렉션 코드는 생성된 각 형식의 Descriptor 정적 필드를 사용하여

 Any 필드 형식을 확인합니다. 

 

TryUnpack<T> 메서드도 있지만 실패하더라도 초기화되지 않은 T 인스턴스를 만듭니다.

앞에서 설명한 대로 Is 메서드를 사용하는 것이 좋습니다.

 

Oneof   ( 여러개중의 하나 )

여러 필드가 있는 메시지가 있고,  동시에 최대 한 개의 필드가 설정되는 경우

이 중 하나를 사용하여 이 동작을 적용하고 메모리를 절약할 수 있습니다.

선택한 언어에 따라 특수 case() 또는 WhichOneof() 메서드를 사용하여 설정된 값이 있는지 확인할 수 있습니다.

 

oneof 집합 내의 필드는 전체 메시지 선언에서 고유한 필드 번호가 있어야 합니다.

 

message Stock {
    // Stock-specific data
}

message Currency {
    // Currency-specific data
}

message ChangeNotification {
  int32 id = 1;
  oneof instrument {
    Stock stock = 2;
    Currency currency = 3;
  }
}

public void FormatChangeNotification(ChangeNotification change)
{
    switch (change.InstrumentCase)
    {
        case ChangeNotification.InstrumentOneofCase.None:
            return;
        case ChangeNotification.InstrumentOneofCase.Stock:
            FormatStock(change.Stock);
            break;
        case ChangeNotification.InstrumentOneofCase.Currency:
            FormatCurrency(change.Currency);
            break;
        default:
            throw new ArgumentException("Unknown instrument type");
    }
}

oneof 집합의 일부인 필드를 설정하면 집합의 다른 필드가 자동으로 지워집니다. 

repeated는 oneof과 함께 사용할 수 없습니다. 

대신 이 제한을 해결하기 위해 반복 필드 또는 oneof 설정을 사용하여 중첩 메시지를 만들 수 있습니다.