パッケージ org.springframework.http.codec

インターフェース CodecConfigurer

すべての既知のサブインターフェース:
ClientCodecConfigurer, ServerCodecConfigurer
すべての既知の実装クラス:
DefaultClientCodecConfigurer, DefaultServerCodecConfigurer
public interface CodecConfigurer
クライアントまたはサーバーの HTTP メッセージのリーダーとライターを構成するための共通インターフェースを定義します。これは次のように使用されます。

HTTP メッセージのリーダーとライターは、次の順序で 3 つのカテゴリに分類されます。

  1. byte[]、String などの特定の型をサポートする型指定されたリーダーとライター。
  2. オブジェクトリーダーとライター (JSON、XML など)。
  3. キャッチオールリーダーまたはライター (例: あらゆるメディア型の文字列)。

型付きリーダーとオブジェクトリーダーは、さらに細分化され、次のように並べ替えられます。

  1. デフォルトの HTTP リーダーとライターの登録。
  2. カスタムのリーダーとライター。
導入:
5.0
作成者:
Rossen Stoyanchev

  • ネストされたクラスの要約

    ネストされたクラス
    修飾子と型
    インターフェース
    説明
    static interface
    CodecConfigurer.CustomCodecs
    カスタム HTTP メッセージリーダーおよびライター用のレジストリ。
    static interface
    CodecConfigurer.DefaultCodecConfig
    デフォルトのコーデックに適用される defaultCodecs() を介して構成されたプロパティの値を公開します。
    static interface
    CodecConfigurer.DefaultCodecs
    デフォルトで登録されている HTTP メッセージリーダーとライターをカスタマイズまたは置換します。
    static interface
    CodecConfigurer.MultipartCodecs
    マルチパート HTTP メッセージライターのレジストリとコンテナー。

  • メソッドのサマリー

    修飾子と型
    メソッド
    説明
    CodecConfigurer
    clone()
    この CodecConfigurer のコピーを作成します。
    CodecConfigurer.CustomCodecs
    customCodecs()
    デフォルトで登録されているものに加えて、カスタム HTTP メッセージリーダーまたはライターを登録します。
    CodecConfigurer.DefaultCodecs
    defaultCodecs()
    デフォルトで登録された HTTP メッセージリーダーおよびライターをカスタマイズまたは置換する方法を提供します。
    ListSE<HttpMessageReader<?>>
    getReaders()
    設定済みの HTTP メッセージリーダーを取得します。
    ListSE<HttpMessageWriter<?>>
    getWriters()
    設定済みの HTTP メッセージライターを取得します。
    void
    registerDefaults(boolean registerDefaults)
    デフォルトの HTTP メッセージリーダーおよびライターの登録を完全にオフにし、代わりに customCodecs() を介して提供されたもののみに依存する方法を提供します。

  • メソッドの詳細

    • defaultCodecs

      CodecConfigurer.DefaultCodecs defaultCodecs()
      デフォルトで登録された HTTP メッセージリーダーおよびライターをカスタマイズまたは置換する方法を提供します。
      関連事項:

    • customCodecs

      CodecConfigurer.CustomCodecs customCodecs()
      デフォルトで登録されているものに加えて、カスタム HTTP メッセージリーダーまたはライターを登録します。

    • registerDefaults

      void registerDefaults(boolean registerDefaults)
      デフォルトの HTTP メッセージリーダーおよびライターの登録を完全にオフにし、代わりに customCodecs() を介して提供されたもののみに依存する方法を提供します。

      デフォルトでは、これは "true" に設定されています。この場合、デフォルトの登録が行われます。これを false に設定すると、デフォルトの登録が無効になります。

    • getReaders

      ListSE<HttpMessageReader<?>> getReaders()
      設定済みの HTTP メッセージリーダーを取得します。

    • getWriters

      ListSE<HttpMessageWriter<?>> getWriters()
      設定済みの HTTP メッセージライターを取得します。

    • clone

      CodecConfigurer clone()
      この CodecConfigurer のコピーを作成します。返されるクローンには、デフォルトおよびカスタムコーデックの独自のリストがあり、通常は個別に設定できます。ただし、コーデックインスタンス（設定されている場合）自体は複製されないことに注意してください。
      導入:
      5.1.12