ProtobufHttpMessageConverter (Spring Framework API)

java.lang.ObjectSE
- org.springframework.http.converter.AbstractHttpMessageConverter<com.google.protobuf.Message>
- - org.springframework.http.converter.protobuf.ProtobufHttpMessageConverter

実装されたすべてのインターフェース:
HttpMessageConverter<com.google.protobuf.Message>
既知の直属サブクラス
ProtobufJsonFormatHttpMessageConverter
```
public class ProtobufHttpMessageConverter
extends AbstractHttpMessageConverter<com.google.protobuf.Message>
```
Google プロトコルバッファを使用して com.google.protobuf.Messages を読み書きする HttpMessageConverter。
Message Java クラスを生成するには、protoc バイナリをインストールする必要があります。
このコンバーターは、デフォルトで公式の "com.google.protobuf:protobuf-java" ライブラリで "application/x-protobuf" および "text/plain" をサポートします。クラスパス上の次の追加ライブラリのいずれかを使用して、他の形式をサポートできます。
- "com.googlecode.protobuf-java-format:protobuf-java-format" サードパーティライブラリを使用した "application/json"、"application/xml"、"text/html" （書き込み専用）
- Protobuf 3 の公式 "com.google.protobuf:protobuf-java-util" と "application/json" (構成可能なバリアントについては、ProtobufJsonFormatHttpMessageConverter を参照してください)
Protobuf 2.6 以上（およびフォーマットには Protobuf Java Format 1.4 以上）が必要です。このコンバーターは、Protobuf 2 ベースの protobuf-java-format が存在しない場合、Protobuf 3 およびそのデフォルトの protobuf-java-util JSON 形式に自動適応します。ただし、Protobuf 3 でより明示的な JSON セットアップを行うには、ProtobufJsonFormatHttpMessageConverter を検討してください。
導入:
4.1
作成者:
Alex Antonov, Brian Clozel, Juergen Hoeller, Sebastien Deleuze
関連事項:
FormatFactory, JsonFormat, ProtobufJsonFormatHttpMessageConverter

フィールドサマリー

フィールド
修飾子と型	フィールドと説明
`static CharsetSE`	`DEFAULT_CHARSET` コンバーターが使用するデフォルトの文字セット。
`static MediaType`	`PROTOBUF` protobuf `application/x-protobuf` のメディア型。
`static StringSE`	`X_PROTOBUF_MESSAGE_HEADER` protobuf メッセージを含む HTTP ヘッダー。
`static StringSE`	`X_PROTOBUF_SCHEMA_HEADER` protobuf スキーマを含む HTTP ヘッダー。

クラス org.springframework.http.converter.AbstractHttpMessageConverter から継承されたフィールド
logger

コンストラクターのサマリー

コンストラクター
コンストラクターと説明
`ProtobufHttpMessageConverter()` 新しい `ProtobufHttpMessageConverter` を作成します。
`ProtobufHttpMessageConverter(com.google.protobuf.ExtensionRegistry extensionRegistry)` プロトコルメッセージ拡張を指定するレジストリを使用して、新しい `ProtobufHttpMessageConverter` を構築します。
`ProtobufHttpMessageConverter(ExtensionRegistryInitializer registryInitializer)` 使用すべきではありません。 Spring Framework 5.1 以降、代わりに `ProtobufHttpMessageConverter(ExtensionRegistry)` を使用

メソッドのサマリー

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`protected boolean`	`canWrite(MediaType mediaType)` 指定されたメディア型にサポートされているメディア型のいずれかが含まれている場合、`true` を返します。
`protected MediaType`	`getDefaultContentType(com.google.protobuf.Message message)` 指定された型のデフォルトのコンテンツ型を返します。
`protected com.google.protobuf.Message`	`readInternal(ClassSE<? extends com.google.protobuf.Message> clazz, HttpInputMessage inputMessage)` 実際のオブジェクトを読み取る抽象テンプレートメソッド。
`protected boolean`	`supports(ClassSE<?> clazz)` 指定されたクラスがこのコンバーターでサポートされているかどうかを示します。
`protected void`	`writeInternal(com.google.protobuf.Message message, HttpOutputMessage outputMessage)` 実際の本文を書き込む抽象テンプレートメソッド。

クラス org.springframework.http.converter.AbstractHttpMessageConverter から継承されたメソッド
addDefaultHeaders, canRead, canRead, canWrite, getContentLength, getDefaultCharset, getSupportedMediaTypes, read, setDefaultCharset, setSupportedMediaTypes, write

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

インターフェース org.springframework.http.converter.HttpMessageConverter から継承されたメソッド
getSupportedMediaTypes

- フィールドの詳細
  - DEFAULT_CHARSET
```
public static final CharsetSE DEFAULT_CHARSET
```
    コンバーターが使用するデフォルトの文字セット。
  - PROTOBUF
```
public static final MediaType PROTOBUF
```
    protobuf application/x-protobuf のメディア型。
  - X_PROTOBUF_SCHEMA_HEADER
```
public static final StringSE X_PROTOBUF_SCHEMA_HEADER
```
    protobuf スキーマを含む HTTP ヘッダー。
    関連事項:
    定数フィールド値
  - X_PROTOBUF_MESSAGE_HEADER
```
public static final StringSE X_PROTOBUF_MESSAGE_HEADER
```
    protobuf メッセージを含む HTTP ヘッダー。
    関連事項:
    定数フィールド値
- コンストラクターの詳細
  - ProtobufHttpMessageConverter
```
public ProtobufHttpMessageConverter()
```
    新しい ProtobufHttpMessageConverter を作成します。
  - ProtobufHttpMessageConverter
```
@DeprecatedSE
public ProtobufHttpMessageConverter(@Nullable
                                                ExtensionRegistryInitializer registryInitializer)
```
    非推奨。Spring Framework 5.1 以降、代わりに ProtobufHttpMessageConverter(ExtensionRegistry) を使用
    メッセージ拡張の登録を許可する初期化子を使用して、新しい ProtobufHttpMessageConverter を作成します。
    パラメーター:
    registryInitializer - メッセージ拡張機能の初期化子
  - ProtobufHttpMessageConverter
```
public ProtobufHttpMessageConverter(com.google.protobuf.ExtensionRegistry extensionRegistry)
```
    プロトコルメッセージ拡張を指定するレジストリを使用して、新しい ProtobufHttpMessageConverter を構築します。
    パラメーター:
    extensionRegistry - 移入するレジストリ
- メソッドの詳細
  - supports
```
protected boolean supports(ClassSE<?> clazz)
```
    クラスからコピーされた説明: AbstractHttpMessageConverter
    指定されたクラスがこのコンバーターでサポートされているかどうかを示します。
    次で指定:
    クラス AbstractHttpMessageConverter<com.google.protobuf.Message> の supports
    パラメーター:
    clazz - サポートをテストするクラス
    戻り値:
    サポートされている場合は true。それ以外の場合は false
  - getDefaultContentType
```
protected MediaType getDefaultContentType(com.google.protobuf.Message message)
```
    クラスからコピーされた説明: AbstractHttpMessageConverter
    指定された型のデフォルトのコンテンツ型を返します。指定されたコンテンツ型パラメーターなしで AbstractHttpMessageConverter.write(T, org.springframework.http.MediaType, org.springframework.http.HttpOutputMessage) が呼び出されたときに呼び出されます。
    デフォルトでは、supportedMediaTypes プロパティの最初の要素があれば、それを返します。サブクラスでオーバーライドできます。
    オーバーライド:
    クラス AbstractHttpMessageConverter<com.google.protobuf.Message> の getDefaultContentType
    パラメーター:
    message - コンテンツ型を返す型
    戻り値:
    コンテンツ型、または不明の場合は null
  - readInternal
```
protected com.google.protobuf.Message readInternal(ClassSE<? extends com.google.protobuf.Message> clazz,
                                                   HttpInputMessage inputMessage)
                                            throws IOExceptionSE,
                                                   HttpMessageNotReadableException
```
    クラスからコピーされた説明: AbstractHttpMessageConverter
    実際のオブジェクトを読み取る抽象テンプレートメソッド。AbstractHttpMessageConverter.read(java.lang.Class<? extends T>, org.springframework.http.HttpInputMessage) から呼び出されます。
    次で指定:
    クラス AbstractHttpMessageConverter<com.google.protobuf.Message> の readInternal
    パラメーター:
    clazz - 返すオブジェクトの型
    inputMessage - 読み込む HTTP 入力メッセージ
    戻り値:
    変換されたオブジェクト
    例外:
    IOExceptionSE - I/O エラーの場合
    HttpMessageNotReadableException - 変換エラーの場合
  - canWrite
```
protected boolean canWrite(@Nullable
                           MediaType mediaType)
```
    クラスからコピーされた説明: AbstractHttpMessageConverter
    指定されたメディア型にサポートされているメディア型のいずれかが含まれている場合、true を返します。
    オーバーライド:
    クラス AbstractHttpMessageConverter<com.google.protobuf.Message> の canWrite
    パラメーター:
    mediaType - 書き込むメディア型は、指定しない場合は null にできます。通常、Accept ヘッダーの値。
    戻り値:
    サポートされているメディア型がメディア型と互換性がある場合、またはメディア型が null である場合は、true
  - writeInternal
```
protected void writeInternal(com.google.protobuf.Message message,
                             HttpOutputMessage outputMessage)
                      throws IOExceptionSE,
                             HttpMessageNotWritableException
```
    クラスからコピーされた説明: AbstractHttpMessageConverter
    実際の本文を書き込む抽象テンプレートメソッド。AbstractHttpMessageConverter.write(T, org.springframework.http.MediaType, org.springframework.http.HttpOutputMessage) から呼び出されます。
    次で指定:
    クラス AbstractHttpMessageConverter<com.google.protobuf.Message> の writeInternal
    パラメーター:
    message - 出力メッセージに書き込むオブジェクト
    outputMessage - 書き込む HTTP 出力メッセージ
    例外:
    IOExceptionSE - I/O エラーの場合
    HttpMessageNotWritableException - 変換エラーの場合

クラス ProtobufHttpMessageConverter

フィールドサマリー

クラス org.springframework.http.converter.AbstractHttpMessageConverter から継承されたフィールド

コンストラクターのサマリー

メソッドのサマリー

クラス org.springframework.http.converter.AbstractHttpMessageConverter から継承されたメソッド

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

インターフェース org.springframework.http.converter.HttpMessageConverter から継承されたメソッド

フィールドの詳細

DEFAULT_CHARSET

PROTOBUF

X_PROTOBUF_SCHEMA_HEADER

X_PROTOBUF_MESSAGE_HEADER

コンストラクターの詳細

ProtobufHttpMessageConverter

ProtobufHttpMessageConverter

ProtobufHttpMessageConverter

メソッドの詳細

supports

getDefaultContentType

readInternal

canWrite

writeInternal