ProtobufDecoder (Spring Framework 5.2.8.RELEASE API)

java.lang.ObjectSE
- org.springframework.http.codec.protobuf.ProtobufCodecSupport
- - org.springframework.http.codec.protobuf.ProtobufDecoder

実装されているすべてのインターフェース:
Decoder<com.google.protobuf.Message>
```
public class ProtobufDecoder
extends ProtobufCodecSupport
implements Decoder<com.google.protobuf.Message>
```
Google プロトコルバッファを使用して Message を読み取る Decoder。
decode(Publisher, ResolvableType, MimeType, Map) を介してデシリアライズされた Flux は、各メッセージのサイズがメッセージ自体の前に指定された、区切られたProtobuf メッセージを使用することが想定されています。decodeToMono(Publisher, ResolvableType, MimeType, Map) を介してデシリアライズされた単一の値は、通常の Protobuf メッセージ形式 (メッセージの前にサイズが付加されない) を使用することが想定されています。
Protobuf メッセージのデフォルトインスタンスは空のバイト配列を生成するため、ネットワーク経由で送信される Mono.just(Msg.getDefaultInstance()) は空の Mono としてデシリアライズされます。
Message Java クラスを生成するには、protoc バイナリをインストールする必要があります。
このデコーダーは Protobuf 3 以降を必要とし、公式 "com.google.protobuf:protobuf-java" ライブラリで "application/x-protobuf" および "application/octet-stream" をサポートします。
導入:
5.1
作成者:
S é bastien Deleuze
関連事項:
ProtobufEncoder

フィールドのサマリー
フィールド
修飾子と型フィールドと説明
protected static int DEFAULT_MESSAGE_MAX_SIZE
メッセージを集約するためのデフォルトの最大サイズ。

フィールド
修飾子と型	フィールドと説明
`protected static int`	`DEFAULT_MESSAGE_MAX_SIZE` メッセージを集約するためのデフォルトの最大サイズ。

コンストラクターの概要

コンストラクター
コンストラクターと説明
`ProtobufDecoder()` 新しい `ProtobufDecoder` を作成します。
`ProtobufDecoder(com.google.protobuf.ExtensionRegistry extensionRegistry)` メッセージ拡張の登録を許可する初期化子を使用して、新しい `ProtobufDecoder` を作成します。

メソッドのサマリー

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`boolean`	`canDecode(ResolvableType elementType, MimeType mimeType)` デコーダーが特定のターゲット要素型とソースストリームの MIME 型をサポートするかどうか。
`com.google.protobuf.Message`	`decode(DataBuffer dataBuffer, ResolvableType targetType, MimeType mimeType, MapSE<StringSE, ObjectSE> hints)` データバッファを型 T のオブジェクトにデコードします。
`reactor.core.publisher.Flux<com.google.protobuf.Message>`	`decode(org.reactivestreams.Publisher<DataBuffer> inputStream, ResolvableType elementType, MimeType mimeType, MapSE<StringSE, ObjectSE> hints)` `DataBuffer` 入力ストリームを `T` の Flux にデコードします。
`reactor.core.publisher.Mono<com.google.protobuf.Message>`	`decodeToMono(org.reactivestreams.Publisher<DataBuffer> inputStream, ResolvableType elementType, MimeType mimeType, MapSE<StringSE, ObjectSE> hints)` `DataBuffer` 入力ストリームを `T` の Mono にデコードします。
`ListSE<MimeType>`	`getDecodableMimeTypes()` このデコーダーがサポートする MIME 型のリストを返します。
`int`	`getMaxMessageSize()` `configured` メッセージのサイズ制限を返します。
`void`	`setMaxMessageSize(int maxMessageSize)` メッセージごとに許可される最大サイズ。

クラス org.springframework.http.codec.protobuf.ProtobufCodecSupport から継承されたメソッド
getMimeTypes, supportsMimeType

クラス java.lang.ObjectSE から継承されたメソッド
cloneSE, equalsSE, finalizeSE, getClassSE, hashCodeSE, notifySE, notifyAllSE, toStringSE, waitSE, waitSE, waitSE

- フィールドの詳細
  - DEFAULT_MESSAGE_MAX_SIZE
```
protected static final int DEFAULT_MESSAGE_MAX_SIZE
```
    メッセージを集約するためのデフォルトの最大サイズ。
    関連事項:
    定数フィールド値
- コンストラクターの詳細
  - ProtobufDecoder
```
public ProtobufDecoder()
```
    新しい ProtobufDecoder を作成します。
  - ProtobufDecoder
```
public ProtobufDecoder(com.google.protobuf.ExtensionRegistry extensionRegistry)
```
    メッセージ拡張の登録を許可する初期化子を使用して、新しい ProtobufDecoder を作成します。
    パラメーター:
    extensionRegistry - メッセージ拡張レジストリ
- メソッドの詳細
  - setMaxMessageSize
```
public void setMaxMessageSize(int maxMessageSize)
```
    メッセージごとに許可される最大サイズ。
    デフォルトでは、これは 256K に設定されています。
    パラメーター:
    maxMessageSize - メッセージごとの最大サイズ、または無制限の場合は -1
  - getMaxMessageSize
```
public int getMaxMessageSize()
```
    configured メッセージのサイズ制限を返します。
    導入:
    5.1.11
  - canDecode
```
public boolean canDecode(ResolvableType elementType,
                         @Nullable
                         MimeType mimeType)
```
    インターフェースからコピーされた説明: Decoder
    デコーダーが特定のターゲット要素型とソースストリームの MIME 型をサポートするかどうか。
    次で指定:
    インターフェース Decoder<com.google.protobuf.Message> の canDecode
    パラメーター:
    elementType - 出力ストリームのターゲット要素型
    mimeType - デコードするストリームに関連付けられた MIME 型 (指定しない場合は null にすることができます)
    戻り値:
    サポートされている場合は true、サポートされていない場合は false
  - decode
```
public reactor.core.publisher.Flux<com.google.protobuf.Message> decode(org.reactivestreams.Publisher<DataBuffer> inputStream,
                                                                       ResolvableType elementType,
                                                                       @Nullable
                                                                       MimeType mimeType,
                                                                       @Nullable
                                                                       MapSE<StringSE,ObjectSE> hints)
```
    インターフェースからコピーされた説明: Decoder
    DataBuffer 入力ストリームを T の Flux にデコードします。
    次で指定:
    インターフェース Decoder<com.google.protobuf.Message> の decode
    パラメーター:
    inputStream - デコードする DataBuffer 入力ストリーム
    elementType - 出力ストリーム内の要素の予想される型。この型は、事前に Decoder.canDecode(org.springframework.core.ResolvableType, org.springframework.util.MimeType) メソッドに渡されている必要があり、true を返している必要があります。
    mimeType - 入力ストリームに関連付けられた MIME 型 (オプション)
    hints - エンコード方法に関する追加情報
    戻り値:
    デコードされた要素を含む出力ストリーム
  - decodeToMono
```
public reactor.core.publisher.Mono<com.google.protobuf.Message> decodeToMono(org.reactivestreams.Publisher<DataBuffer> inputStream,
                                                                             ResolvableType elementType,
                                                                             @Nullable
                                                                             MimeType mimeType,
                                                                             @Nullable
                                                                             MapSE<StringSE,ObjectSE> hints)
```
    インターフェースからコピーされた説明: Decoder
    DataBuffer 入力ストリームを T の Mono にデコードします。
    次で指定:
    インターフェース Decoder<com.google.protobuf.Message> の decodeToMono
    パラメーター:
    inputStream - デコードする DataBuffer 入力ストリーム
    elementType - 出力ストリーム内の要素の予想される型。この型は、事前に Decoder.canDecode(org.springframework.core.ResolvableType, org.springframework.util.MimeType) メソッドに渡されている必要があり、true を返している必要があります。
    mimeType - 入力ストリームに関連付けられた MIME 型 (オプション)
    hints - エンコード方法に関する追加情報
    戻り値:
    デコードされた要素を持つ出力ストリーム
  - decode
```
public com.google.protobuf.Message decode(DataBuffer dataBuffer,
                                          ResolvableType targetType,
                                          @Nullable
                                          MimeType mimeType,
                                          @Nullable
                                          MapSE<StringSE,ObjectSE> hints)
                                   throws DecodingException
```
    インターフェースからコピーされた説明: Decoder
    データバッファーを型 T のオブジェクトにデコードします。これは、個別のメッセージ（またはイベント）が完全に集約された形式で個別にデコードおよび処理されるシナリオで役立ちます。
    次で指定:
    インターフェース Decoder<com.google.protobuf.Message> の decode
    パラメーター:
    dataBuffer - デコードする DataBuffer
    targetType - 予想される出力型
    mimeType - データに関連付けられた MIME 型
    hints - エンコード方法に関する追加情報
    戻り値:
    デコードされた値、おそらく null
    例外:
    DecodingException
  - getDecodableMimeTypes
```
public ListSE<MimeType> getDecodableMimeTypes()
```
    インターフェースからコピーされた説明: Decoder
    このデコーダーがサポートする MIME 型のリストを返します。
    次で指定:
    インターフェース Decoder<com.google.protobuf.Message> の getDecodableMimeTypes

クラス ProtobufDecoder

フィールドのサマリー

コンストラクターの概要

メソッドのサマリー

クラス org.springframework.http.codec.protobuf.ProtobufCodecSupport から継承されたメソッド

クラス java.lang.ObjectSE から継承されたメソッド

フィールドの詳細

DEFAULT_MESSAGE_MAX_SIZE

コンストラクターの詳細

ProtobufDecoder

ProtobufDecoder

メソッドの詳細

setMaxMessageSize

getMaxMessageSize

canDecode

decode

decodeToMono

decode

getDecodableMimeTypes