パッケージ org.springframework.messaging.converter

インターフェース MessageConverter

すべての既知のサブインターフェース:
SmartMessageConverter
すべての既知の実装クラス:
AbstractJsonMessageConverter、AbstractMessageConverter、ByteArrayMessageConverter、CompositeMessageConverter、GenericMessageConverter、GsonMessageConverter、JsonbMessageConverter、KotlinSerializationJsonMessageConverter、MappingJackson2MessageConverter、MarshallingMessageConverter、ProtobufJsonFormatMessageConverter、ProtobufMessageConverter、SimpleMessageConverter、StringMessageConverter
public interface MessageConverter
Message のペイロードを直列化された形式から型付きオブジェクトに、またはその逆に変換するコンバーター。MessageHeaders.CONTENT_TYPE メッセージヘッダーを使用して、メッセージコンテンツのメディア型を指定できます。
導入:
4.0
作成者:
Mark Fisher, Rossen Stoyanchev

  • メソッドのサマリー

    修飾子と型
    メソッド
    説明
    ObjectSE
    fromMessage(Message<?> message, ClassSE<?> targetClass)
    Message のペイロードを、直列化された形式から、指定されたターゲットクラスの型付きオブジェクトに変換します。
    Message<?>
    toMessage(ObjectSE payload, MessageHeaders headers)
    ペイロードが特定のペイロードオブジェクトを直列化された形式に変換した結果である Message を作成します。

  • メソッドの詳細

    • fromMessage

      @Nullable ObjectSE fromMessage(Message<?> message, ClassSE<?> targetClass)
      Message のペイロードを、直列化された形式から、指定されたターゲットクラスの型指定されたオブジェクトに変換します。MessageHeaders.CONTENT_TYPE ヘッダーは、変換元の MIME 型を示す必要があります。

      コンバーターが指定されたメディア型をサポートしていないか、変換を実行できない場合は、null を返します。

      パラメーター:
      message - 入力メッセージ
      targetClass - 変換のターゲットクラス
      戻り値:
      変換の結果、またはコンバーターが変換を実行できない場合は null 

    • toMessage

      @Nullable Message<?> toMessage(ObjectSE payload, @Nullable MessageHeaders headers)
      ペイロードが指定されたペイロードオブジェクトを直列化された形式に変換した結果である Message を作成します。オプションの MessageHeaders パラメーターには、変換のターゲットメディア型を指定する MessageHeaders.CONTENT_TYPE ヘッダーを含めることができ、メッセージに追加する追加のヘッダーを含めることができます。

      コンバーターが指定されたメディア型をサポートしていないか、変換を実行できない場合は、null を返します。

      パラメーター:
      payload - 変換するオブジェクト
      headers - メッセージのオプションのヘッダー (null の場合があります)
      戻り値:
      新しいメッセージ、またはコンバーターがオブジェクト型またはターゲットメディア型をサポートしていない場合は null