クラス MappingJackson2MessageConverter
java.lang.ObjectSE
org.springframework.messaging.converter.AbstractMessageConverter
org.springframework.messaging.converter.MappingJackson2MessageConverter
- 実装されたすべてのインターフェース:
MessageConverter
,SmartMessageConverter
Jackson 2 ベースの
MessageConverter
実装。Jackson のデフォルトプロパティを次のようにカスタマイズします。
- 導入:
- 4.0
- 作成者:
- Rossen Stoyanchev, Juergen Hoeller, Sebastien Deleuze
フィールドサマリー
クラス org.springframework.messaging.converter.AbstractMessageConverter から継承されたフィールド
logger
コンストラクターのサマリー
コンストラクターコンストラクター説明UTF-8
文字セットでapplication/json
MIME 型をサポートするMappingJackson2MessageConverter
を構築します。MappingJackson2MessageConverter
(MimeType... supportedMimeTypes) 1 つ以上のカスタム MIME 型をサポートするMappingJackson2MessageConverter
を構築します。メソッドのサマリー
修飾子と型メソッド説明protected boolean
canConvertFrom
(Message<?> message, ClassSE<?> targetClass) protected boolean
canConvertTo
(ObjectSE payload, MessageHeaders headers) protected ObjectSE
convertFromInternal
(Message<?> message, ClassSE<?> targetClass, ObjectSE conversionHint) メッセージペイロードを直列化された形式からオブジェクトに変換します。protected ObjectSE
convertToInternal
(ObjectSE payload, MessageHeaders headers, ObjectSE conversionHint) ペイロードオブジェクトを直列化された形式に変換します。protected JsonEncoding
getJsonEncoding
(MimeType contentType) 指定されたコンテンツ型に使用する JSON エンコーディングを決定します。このコンバーターの基になるObjectMapper
を返します。protected ClassSE<?>
getSerializationView
(ObjectSE conversionHint) 指定された変換ヒントに基づいて、Jackson 直列化ビューを決定します。protected void
logWarningIfNecessary
(TypeSE type, ThrowableSE cause) ObjectMapper.canDeserialize(com.fasterxml.jackson.databind.JavaType)
/ObjectMapper.canSerialize(java.lang.Class<?>)
チェックからの特定の例外をログに記録するかどうかを決定します。void
setObjectMapper
(ObjectMapper objectMapper) このコンバーターのObjectMapper
を設定します。void
setPrettyPrint
(boolean prettyPrint) JSON を記述するときにDefaultPrettyPrinter
を使用するかどうか。protected boolean
指定されたクラスがこのコンバーターでサポートされているかどうか。クラス org.springframework.messaging.converter.AbstractMessageConverter から継承されたメソッド
addSupportedMimeTypes, fromMessage, fromMessage, getContentTypeResolver, getDefaultContentType, getMimeType, getSerializedPayloadClass, getSupportedMimeTypes, isStrictContentTypeMatch, setContentTypeResolver, setSerializedPayloadClass, setStrictContentTypeMatch, supportsMimeType, toMessage, toMessage
コンストラクターの詳細
MappingJackson2MessageConverter
public MappingJackson2MessageConverter()UTF-8
文字セットでapplication/json
MIME 型をサポートするMappingJackson2MessageConverter
を構築します。MappingJackson2MessageConverter
1 つ以上のカスタム MIME 型をサポートするMappingJackson2MessageConverter
を構築します。- パラメーター:
supportedMimeTypes
- サポートされている MIME 型- 導入:
- 4.1.5
メソッドの詳細
setObjectMapper
このコンバーターのObjectMapper
を設定します。設定しない場合、デフォルトのObjectMapper
が使用されます。カスタム構成の
ObjectMapper
を設定することは、JSON 直列化プロセスをさらに制御する 1 つの方法です。例: 特定の型のカスタムシリアライザーを提供する拡張SerializerFactory
を構成できます。直列化プロセスを改善するためのもう 1 つのオプションは、Jackson が提供するアノテーションを直列化する型に使用することです。この場合、カスタム構成の ObjectMapper は不要です。getObjectMapper
このコンバーターの基になるObjectMapper
を返します。setPrettyPrint
public void setPrettyPrint(boolean prettyPrint) JSON を記述するときにDefaultPrettyPrinter
を使用するかどうか。これは、次のようにObjectMapper
をセットアップするためのショートカットです。ObjectMapper mapper = new ObjectMapper(); mapper.configure(SerializationFeature.INDENT_OUTPUT, true); converter.setObjectMapper(mapper);
canConvertFrom
- オーバーライド:
- クラス
AbstractMessageConverter
のcanConvertFrom
canConvertTo
- オーバーライド:
- クラス
AbstractMessageConverter
のcanConvertTo
logWarningIfNecessary
ObjectMapper.canDeserialize(com.fasterxml.jackson.databind.JavaType)
/ObjectMapper.canSerialize(java.lang.Class<?>)
チェックからの特定の例外をログに記録するかどうかを決定します。- パラメーター:
type
- Jackson が(非)直列化可能性についてテストしたクラスcause
- 評価する Jackson 投げ例外 (通常、JsonMappingException
)- 導入:
- 4.3
supports
クラスからコピーされた説明:AbstractMessageConverter
指定されたクラスがこのコンバーターでサポートされているかどうか。- 次で指定:
- クラス
AbstractMessageConverter
のsupports
- パラメーター:
clazz
- サポートをテストするクラス- 戻り値:
- サポートされている場合は
true
。それ以外の場合はfalse
convertFromInternal
@Nullable protected ObjectSE convertFromInternal(Message<?> message, ClassSE<?> targetClass, @Nullable ObjectSE conversionHint) クラスからコピーされた説明:AbstractMessageConverter
メッセージペイロードを直列化された形式からオブジェクトに変換します。- オーバーライド:
- クラス
AbstractMessageConverter
のconvertFromInternal
- パラメーター:
message
- 入力メッセージtargetClass
- 変換のターゲットクラスconversionHint
-MessageConverter
に渡される追加のオブジェクト。関連するMethodParameter
(null
の場合があります。}- 戻り値:
- 変換の結果、またはコンバーターが変換を実行できない場合は
null
convertToInternal
@Nullable protected ObjectSE convertToInternal(ObjectSE payload, @Nullable MessageHeaders headers, @Nullable ObjectSE conversionHint) クラスからコピーされた説明:AbstractMessageConverter
ペイロードオブジェクトを直列化された形式に変換します。- オーバーライド:
- クラス
AbstractMessageConverter
のconvertToInternal
- パラメーター:
payload
- 変換するオブジェクトheaders
- メッセージのオプションのヘッダー (null
の場合があります)conversionHint
-MessageConverter
に渡される追加のオブジェクト。関連するMethodParameter
(null
の場合があります。}- 戻り値:
- メッセージの結果のペイロード、またはコンバーターが変換を実行できない場合は
null
getSerializationView
指定された変換ヒントに基づいて、Jackson 直列化ビューを決定します。- パラメーター:
conversionHint
- 現在の変換の試行のためにコンバーターに渡される変換ヒントオブジェクト- 戻り値:
- 直列化ビュークラス、または存在しない場合は
null
- 導入:
- 4.2
getJsonEncoding
指定されたコンテンツ型に使用する JSON エンコーディングを決定します。- パラメーター:
contentType
- MessageHeaders からの MIME 型(存在する場合)- 戻り値:
- 使用する JSON エンコード (非
null
)