クラス ProtobufHttpMessageConverter

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"、"application/*+x-protobuf"、"text/plain" をサポートします。"application/json" 形式も "com.google.protobuf:protobuf-java-util" 依存関係でサポートされています。設定可能なバリアントについては、ProtobufJsonFormatHttpMessageConverter を参照してください。

このコンバーターには Protobuf 3 以上が必要です。

導入:
4.1
作成者:
Alex Antonov, Brian Clozel, Juergen Hoeller, Sebastien Deleuze, Kamil Doroszkiewicz
関連事項:
  • フィールドの詳細

    • DEFAULT_CHARSET

      public static final CharsetSE DEFAULT_CHARSET
      コンバーターが使用するデフォルトの文字セット。
    • PROTOBUF

      public static final MediaType PROTOBUF
      protobuf application/x-protobuf のメディア型。
    • PLUS_PROTOBUF

      public static final MediaType PLUS_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

      public ProtobufHttpMessageConverter(com.google.protobuf.ExtensionRegistry extensionRegistry)
      プロトコルメッセージ拡張を指定するレジストリを使用して、新しい ProtobufHttpMessageConverter を構築します。
      パラメーター:
      extensionRegistry - 移入するレジストリ
    • ProtobufHttpMessageConverter

      protected ProtobufHttpMessageConverter(@Nullable ProtobufHttpMessageConverter.ProtobufFormatDelegate formatDelegate, @Nullable com.google.protobuf.ExtensionRegistry extensionRegistry)
      追加の形式をサポートするサブクラスのコンストラクター。
      パラメーター:
      formatDelegate - 追加の形式の読み取りと書き込みを委譲する
      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, MediaType, 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(Class, 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, MediaType, HttpOutputMessage) から呼び出されます。
      次で指定:
      クラス AbstractHttpMessageConverter<com.google.protobuf.Message> の writeInternal 
      パラメーター:
      message - 出力メッセージに書き込むオブジェクト
      outputMessage - 書き込む HTTP 出力メッセージ
      例外:
      IOExceptionSE - I/O エラーの場合
      HttpMessageNotWritableException - 変換エラーの場合
    • canWriteRepeatedly

      public boolean canWriteRepeatedly(com.google.protobuf.Message message, @Nullable MediaType contentType)
      インターフェースからコピーされた説明: HttpMessageConverter
      このメッセージコンバーターが、指定されたペイロードを複数回書き込むことができるかどうかを示します。

      これは、HTTP クライアントライブラリが、たとえば HTTP リダイレクト後にメッセージを再度送信できるかどうかを判断するために使用できます。デフォルトの実装では false が返されます。これは通常、ペイロードを一度しか読み取れない場合は false を返します。

      パラメーター:
      message - オブジェクト t
      contentType - 執筆時に使用するコンテンツ型。
      戻り値:
       t を繰り返し書き込める場合は true。それ以外の場合は false 
    • supportsRepeatableWrites

      protected boolean supportsRepeatableWrites(com.google.protobuf.Message message)
      クラスからコピーされた説明: AbstractHttpMessageConverter
      このメッセージコンバーターが指定されたオブジェクトを複数回書き込むことができるかどうかを示します。

      デフォルトの実装は false を返します。

      オーバーライド:
      クラス AbstractHttpMessageConverter<com.google.protobuf.Message> の supportsRepeatableWrites 
      パラメーター:
      message - オブジェクト t
      戻り値:
       t を繰り返し書き込める場合は true。それ以外の場合は false