AbstractJackson2HttpMessageConverter (Spring Framework 5.1.1.RELEASE API)

java.lang.Object
- org.springframework.http.converter.AbstractHttpMessageConverter<T>
- - org.springframework.http.converter.AbstractGenericHttpMessageConverter<java.lang.Object>
  - - org.springframework.http.converter.json.AbstractJackson2HttpMessageConverter

実装済みのインターフェース一覧:
GenericHttpMessageConverter<java.lang.Object>, HttpMessageConverter<java.lang.Object>
既知の直属サブクラス
MappingJackson2CborHttpMessageConverter, MappingJackson2HttpMessageConverter, MappingJackson2SmileHttpMessageConverter, MappingJackson2XmlHttpMessageConverter
```
public abstract class AbstractJackson2HttpMessageConverter
extends AbstractGenericHttpMessageConverter<java.lang.Object>
```
Jackson ベースおよびコンテンツ型に依存しない HttpMessageConverter 実装の抽象基本クラス。
Spring 5.0 の時点で、Jackson 2.9 以降と互換性があります。
導入:
4.1
作成者:
Arjen Poutsma, Keith Donald, Rossen Stoyanchev, Juergen Hoeller, Sebastien Deleuze
関連事項:
MappingJackson2HttpMessageConverter

フィールド概要

フィールド
修飾子と型	フィールドと説明
`static java.nio.charset.Charset`	`DEFAULT_CHARSET` コンバーターが使用するデフォルトの文字セット。
`protected ObjectMapper`	`objectMapper`

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

コンストラクター概要

コンストラクター
修飾子	コンストラクターと説明
`protected`	`AbstractJackson2HttpMessageConverter(ObjectMapper objectMapper)`
`protected`	`AbstractJackson2HttpMessageConverter(ObjectMapper objectMapper, MediaType... supportedMediaTypes)`
`protected`	`AbstractJackson2HttpMessageConverter(ObjectMapper objectMapper, MediaType supportedMediaType)`

方法の概要

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`boolean`	`canRead(java.lang.Class<?> clazz, MediaType mediaType)` この実装は、指定されたクラスがサポートされているかどうか、およびサポートされているメディア型に指定されたメディア型が含まれているかどうかをチェックします。
`boolean`	`canRead(java.lang.reflect.Type type, java.lang.Class<?> contextClass, MediaType mediaType)` 指定された型がこのコンバーターで読み取れるかどうかを示します。
`boolean`	`canWrite(java.lang.Class<?> clazz, MediaType mediaType)` この実装は、指定されたクラスがサポートされているかどうか、およびサポートされているメディア型に指定されたメディア型が含まれているかどうかをチェックします。
`protected java.lang.Long`	`getContentLength(java.lang.Object object, MediaType contentType)` 指定された型のコンテンツの長さを返します。
`protected MediaType`	`getDefaultContentType(java.lang.Object object)` 指定された型のデフォルトのコンテンツ型を返します。
`protected JavaType`	`getJavaType(java.lang.reflect.Type type, java.lang.Class<?> contextClass)` 指定された型とコンテキストクラスの Jackson `JavaType` を返します。
`protected JsonEncoding`	`getJsonEncoding(MediaType contentType)` 指定されたコンテンツ型に使用する JSON エンコーディングを決定します。
`ObjectMapper`	`getObjectMapper()` このビューの基になる `ObjectMapper` を返します。
`protected void`	`logWarningIfNecessary(java.lang.reflect.Type type, java.lang.Throwable cause)` `ObjectMapper.canDeserialize(com.fasterxml.jackson.databind.JavaType)`/`ObjectMapper.canSerialize(java.lang.Class<?>)` チェックからの特定の例外をログに記録するかどうかを決定します。
`java.lang.Object`	`read(java.lang.reflect.Type type, java.lang.Class<?> contextClass, HttpInputMessage inputMessage)` 指定された入力メッセージから指定された型のオブジェクトを読み取り、それを返します。
`protected java.lang.Object`	`readInternal(java.lang.Class<?> clazz, HttpInputMessage inputMessage)` 実際のオブジェクトを読み取る抽象テンプレートメソッド。
`void`	`setObjectMapper(ObjectMapper objectMapper)` このビューの `ObjectMapper` を設定します。
`void`	`setPrettyPrint(boolean prettyPrint)` JSON を記述するときに `DefaultPrettyPrinter` を使用するかどうか。
`protected void`	`writeInternal(java.lang.Object object, java.lang.reflect.Type type, HttpOutputMessage outputMessage)` 実際の本文を書き込む抽象テンプレートメソッド。
`protected void`	`writePrefix(JsonGenerator generator, java.lang.Object object)` メインコンテンツの前にプレフィックスを書きます。
`protected void`	`writeSuffix(JsonGenerator generator, java.lang.Object object)` メインコンテンツの後にサフィックスを記述します。

クラス org.springframework.http.converter.AbstractGenericHttpMessageConverter から継承されたメソッド
canWrite, supports, write, writeInternal

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

クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

- フィールドの詳細
  - DEFAULT_CHARSET
```
public static final java.nio.charset.Charset DEFAULT_CHARSET
```
    コンバーターが使用するデフォルトの文字セット。
  - objectMapper
```
protected ObjectMapper objectMapper
```
- コンストラクターの詳細
  - AbstractJackson2HttpMessageConverter
```
protected AbstractJackson2HttpMessageConverter(ObjectMapper objectMapper)
```
  - AbstractJackson2HttpMessageConverter
```
protected AbstractJackson2HttpMessageConverter(ObjectMapper objectMapper,
                                               MediaType supportedMediaType)
```
  - AbstractJackson2HttpMessageConverter
```
protected AbstractJackson2HttpMessageConverter(ObjectMapper objectMapper,
                                               MediaType... supportedMediaTypes)
```
- メソッドの詳細
  - setObjectMapper
```
public void setObjectMapper(ObjectMapper objectMapper)
```
    このビューの ObjectMapper を設定します。設定しない場合、デフォルトの ObjectMapper が使用されます。
    カスタム構成の ObjectMapper を設定することは、JSON 直列化プロセスをさらに制御する 1 つの方法です。例: 特定の型のカスタムシリアライザーを提供する拡張 SerializerFactory を構成できます。直列化プロセスを改善するためのもう 1 つのオプションは、Jackson が提供するアノテーションを直列化する型に使用することです。この場合、カスタム構成の ObjectMapper は不要です。
  - getObjectMapper
```
public 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);
 
```
  - canRead
```
public boolean canRead(java.lang.Class<?> clazz,
                       @Nullable
                       MediaType mediaType)
```
    クラスからコピーされた説明: AbstractHttpMessageConverter
    この実装は、指定されたクラスがサポートされているかどうか、およびサポートされているメディア型に指定されたメディア型が含まれているかどうかをチェックします。
    次で指定:
    インターフェース HttpMessageConverter<java.lang.Object> 内の canRead
    オーバーライド:
    クラス AbstractHttpMessageConverter<java.lang.Object> の canRead
    パラメーター:
    clazz - 読み込み可能性をテストするクラス
    mediaType - 読み取るメディア型（指定しない場合は null にできます）; 通常、Content-Type ヘッダーの値。
    戻り値:
    読み取り可能な場合は true。それ以外の場合は false
  - canRead
```
public boolean canRead(java.lang.reflect.Type type,
                       @Nullable
                       java.lang.Class<?> contextClass,
                       @Nullable
                       MediaType mediaType)
```
    インターフェースからコピーされた説明: GenericHttpMessageConverter
    指定された型がこのコンバーターで読み取れるかどうかを示します。このメソッドは、HttpMessageConverter.canRead(Class, MediaType) と同じチェックを実行し、ジェネリクス型に関連する追加のチェックを実行する必要があります。
    次で指定:
    インターフェース GenericHttpMessageConverter<java.lang.Object> 内の canRead
    オーバーライド:
    クラス AbstractGenericHttpMessageConverter<java.lang.Object> の canRead
    パラメーター:
    type - 読みやすさをテストするための（潜在的に汎用）型
    contextClass - ターゲット型のコンテキストクラス。たとえば、ターゲット型がメソッドシグネチャーに表示されるクラス (null にすることができます)
    mediaType - 読み取るメディア型は、指定しない場合は null にできます。通常、Content-Type ヘッダーの値。
    戻り値:
    読み取り可能な場合は true。それ以外の場合は false
  - canWrite
```
public boolean canWrite(java.lang.Class<?> clazz,
                        @Nullable
                        MediaType mediaType)
```
    クラスからコピーされた説明: AbstractHttpMessageConverter
    この実装は、指定されたクラスがサポートされているかどうか、およびサポートされているメディア型に指定されたメディア型が含まれているかどうかをチェックします。
    次で指定:
    インターフェース HttpMessageConverter<java.lang.Object> 内の canWrite
    オーバーライド:
    クラス AbstractHttpMessageConverter<java.lang.Object> の canWrite
    パラメーター:
    clazz - 書き込み可能性をテストするクラス
    mediaType - 書き込むメディア型（指定しない場合は null にすることができます）; 通常、Accept ヘッダーの値。
    戻り値:
    書き込み可能な場合は true。それ以外の場合は false
  - logWarningIfNecessary
```
protected void logWarningIfNecessary(java.lang.reflect.Type type,
                                     @Nullable
                                     java.lang.Throwable cause)
```
    ObjectMapper.canDeserialize(com.fasterxml.jackson.databind.JavaType)/ObjectMapper.canSerialize(java.lang.Class<?>) チェックからの特定の例外をログに記録するかどうかを決定します。
    パラメーター:
    type - Jackson が（非）直列化可能性についてテストしたクラス
    cause - 評価する Jackson 投げ例外 (通常、JsonMappingException )
    導入:
    4.3
  - readInternal
```
protected java.lang.Object readInternal(java.lang.Class<?> clazz,
                                        HttpInputMessage inputMessage)
                                 throws java.io.IOException,
                                        HttpMessageNotReadableException
```
    クラスからコピーされた説明: AbstractHttpMessageConverter
    実際のオブジェクトを読み取る抽象テンプレートメソッド。AbstractHttpMessageConverter.read(java.lang.Class<? extends T>, org.springframework.http.HttpInputMessage) から呼び出されます。
    次で指定:
    クラス AbstractHttpMessageConverter<java.lang.Object> の readInternal
    パラメーター:
    clazz - 返すオブジェクトの型
    inputMessage - 読み込む HTTP 入力メッセージ
    戻り値:
    変換されたオブジェクト
    例外:
    java.io.IOException - I/O エラーの場合
    HttpMessageNotReadableException - 変換エラーの場合
  - read
```
public java.lang.Object read(java.lang.reflect.Type type,
                             @Nullable
                             java.lang.Class<?> contextClass,
                             HttpInputMessage inputMessage)
                      throws java.io.IOException,
                             HttpMessageNotReadableException
```
    インターフェースからコピーされた説明: GenericHttpMessageConverter
    指定された入力メッセージから指定された型のオブジェクトを読み取り、それを返します。
    パラメーター:
    type - 返される（潜在的に汎用の）型のオブジェクト。この型は、このインターフェースの canRead メソッドに事前に渡されている必要があります。このメソッドは true を返している必要があります。
    contextClass - ターゲット型のコンテキストクラス。たとえば、ターゲット型がメソッドシグネチャーに表示されるクラス (null にすることができます)
    inputMessage - 読み込む HTTP 入力メッセージ
    戻り値:
    変換されたオブジェクト
    例外:
    java.io.IOException - I/O エラーの場合
    HttpMessageNotReadableException - 変換エラーの場合
  - writeInternal
```
protected void writeInternal(java.lang.Object object,
                             @Nullable
                             java.lang.reflect.Type type,
                             HttpOutputMessage outputMessage)
                      throws java.io.IOException,
                             HttpMessageNotWritableException
```
    クラスからコピーされた説明: AbstractGenericHttpMessageConverter
    実際の本文を書き込む抽象テンプレートメソッド。AbstractGenericHttpMessageConverter.write(T, java.lang.reflect.Type, org.springframework.http.MediaType, org.springframework.http.HttpOutputMessage) から呼び出されます。
    次で指定:
    クラス AbstractGenericHttpMessageConverter<java.lang.Object> の writeInternal
    パラメーター:
    object - 出力メッセージに書き込むオブジェクト
    type - 書き込むオブジェクトの型 (null の場合があります)
    outputMessage - 書き込む HTTP 出力メッセージ
    例外:
    java.io.IOException - I/O エラーの場合
    HttpMessageNotWritableException - 変換エラーの場合
  - writePrefix
```
protected void writePrefix(JsonGenerator generator,
                           java.lang.Object object)
                    throws java.io.IOException
```
    メインコンテンツの前にプレフィックスを書きます。
    パラメーター:
    generator - コンテンツの書き込みに使用するジェネレーター。
    object - 出力メッセージに書き込むオブジェクト。
    例外:
    java.io.IOException
  - writeSuffix
```
protected void writeSuffix(JsonGenerator generator,
                           java.lang.Object object)
                    throws java.io.IOException
```
    メインコンテンツの後にサフィックスを記述します。
    パラメーター:
    generator - コンテンツの書き込みに使用するジェネレーター。
    object - 出力メッセージに書き込むオブジェクト。
    例外:
    java.io.IOException
  - getJavaType
```
protected JavaType getJavaType(java.lang.reflect.Type type,
                               @Nullable
                               java.lang.Class<?> contextClass)
```
    指定された型とコンテキストクラスの Jackson JavaType を返します。
    パラメーター:
    type - Jackson JavaType を返す汎用型
    contextClass - ターゲット型のコンテキストクラス。たとえば、ターゲット型がメソッドシグネチャーに表示されるクラス (null にすることができます)
    戻り値:
    Jackson JavaType
  - getJsonEncoding
```
protected JsonEncoding getJsonEncoding(@Nullable
                                       MediaType contentType)
```
    指定されたコンテンツ型に使用する JSON エンコーディングを決定します。
    パラメーター:
    contentType - 呼び出し元によってリクエストされたメディア型
    戻り値:
    使用する JSON エンコード (決して null ではない)
  - getDefaultContentType
```
@Nullable
protected MediaType getDefaultContentType(java.lang.Object object)
                                             throws java.io.IOException
```
    クラスからコピーされた説明: AbstractHttpMessageConverter
    指定された型のデフォルトのコンテンツ型を返します。指定されたコンテンツ型パラメーターなしで AbstractHttpMessageConverter.write(T, org.springframework.http.MediaType, org.springframework.http.HttpOutputMessage) が呼び出されたときに呼び出されます。
    デフォルトでは、supportedMediaTypes プロパティの最初の要素があれば、それを返します。サブクラスでオーバーライドできます。
    オーバーライド:
    クラス AbstractHttpMessageConverter<java.lang.Object> の getDefaultContentType
    パラメーター:
    object - コンテンツ型を返す型
    戻り値:
    コンテンツ型、または不明の場合は null
    例外:
    java.io.IOException
  - getContentLength
```
protected java.lang.Long getContentLength(java.lang.Object object,
                                          @Nullable
                                          MediaType contentType)
                                   throws java.io.IOException
```
    クラスからコピーされた説明: AbstractHttpMessageConverter
    指定された型のコンテンツの長さを返します。
    デフォルトでは、これは null を返します。これは、コンテンツの長さが不明であることを意味します。サブクラスでオーバーライドできます。
    オーバーライド:
    クラス AbstractHttpMessageConverter<java.lang.Object> の getContentLength
    パラメーター:
    object - コンテンツの長さを返す型
    戻り値:
    コンテンツの長さ、または不明の場合は null
    例外:
    java.io.IOException

クラス AbstractJackson2HttpMessageConverter

フィールド概要

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

コンストラクター概要

方法の概要

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

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

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

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

フィールドの詳細

DEFAULT_CHARSET

objectMapper

コンストラクターの詳細

AbstractJackson2HttpMessageConverter

AbstractJackson2HttpMessageConverter

AbstractJackson2HttpMessageConverter

メソッドの詳細

setObjectMapper

getObjectMapper

setPrettyPrint

canRead

canRead

canWrite

logWarningIfNecessary

readInternal

read

writeInternal

writePrefix

writeSuffix

getJavaType

getJsonEncoding

getDefaultContentType

getContentLength