MappingJackson2JsonView (Spring Framework API)

java.lang.ObjectSE
- org.springframework.context.support.ApplicationObjectSupport
- - org.springframework.web.context.support.WebApplicationObjectSupport
  - - org.springframework.web.servlet.view.AbstractView
    - - org.springframework.web.servlet.view.json.AbstractJackson2View
      - org.springframework.web.servlet.view.json.MappingJackson2JsonView

実装されたすべてのインターフェース:
Aware, BeanNameAware, ApplicationContextAware, ServletContextAware, View
```
public class MappingJackson2JsonView
extends AbstractJackson2View
```
Spring MVC View は、Jackson 2 ObjectMapper を使用して現在のリクエストのモデルをシリアライズすることで JSON コンテンツをレンダリングします。
デフォルトでは、モデルマップのコンテンツ全体（フレームワーク固有のクラスを除く）は JSON としてエンコードされます。モデルに含まれるキーが 1 つのみの場合は、setExtractValueFromSingleKeyModel(boolean) を介して JSON のみとしてエンコードされた抽出することができます
デフォルトのコンストラクターは、Jackson2ObjectMapperBuilder が提供するデフォルトの構成を使用します。
Spring 5.3 以降、Jackson 2.9 から 2.12 と互換性があります。
導入:
3.1.2
作成者:
Jeremy Grelle, Arjen Poutsma, Rossen Stoyanchev, Juergen Hoeller, Sebastien Deleuze

フィールドサマリー
フィールド
修飾子と型フィールドと説明
static StringSE DEFAULT_CONTENT_TYPE
デフォルトのコンテンツ型: "application/json".
- クラス org.springframework.web.servlet.view.json.AbstractJackson2View から継承されたフィールド
  updateContentLength
- クラス org.springframework.context.support.ApplicationObjectSupport から継承されたフィールド
  logger
- インターフェース org.springframework.web.servlet.View から継承されたフィールド
  PATH_VARIABLES, RESPONSE_STATUS_ATTRIBUTE, SELECTED_CONTENT_TYPE

フィールド
修飾子と型	フィールドと説明
`static StringSE`	`DEFAULT_CONTENT_TYPE` デフォルトのコンテンツ型: "application/json".

コンストラクターのサマリー

コンストラクター
コンストラクターと説明
`MappingJackson2JsonView()` `Jackson2ObjectMapperBuilder` によって提供されるデフォルト構成を使用して、コンテンツ型を `application/json` に設定して、新しい `MappingJackson2JsonView` を構築します。
`MappingJackson2JsonView(ObjectMapper objectMapper)` 提供された `ObjectMapper` を使用して新しい `MappingJackson2JsonView` を構築し、コンテンツ型を `application/json` に設定します。

メソッドのサマリー

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`protected ObjectSE`	`filterModel(MapSE<StringSE, ObjectSE> model)` 指定されたモデルから不要な属性を除外します。
`SetSE<StringSE>`	`getModelKeys()` このビューによってレンダリングされるモデルの属性を返します。
`void`	`setExtractValueFromSingleKeyModel(boolean extractValueFromSingleKeyModel)` 単一の属性を含むモデルをマップとして直列化するか、モデルから単一の値を抽出して直接直列化するかを設定します。
`void`	`setJsonPrefix(StringSE jsonPrefix)` このビューの JSON 出力に使用するカスタムプレフィックスを指定します。
`void`	`setModelKey(StringSE modelKey)` このビューによってレンダリングされるモデルの属性を設定します。
`void`	`setModelKeys(SetSE<StringSE> modelKeys)` このビューによってレンダリングされるモデルの属性を設定します。
`void`	`setPrefixJson(boolean prefixJson)` このビューによる JSON 出力の前に `"）]} '、"` を付ける必要があるかどうかを示します。
`protected void`	`writePrefix(JsonGenerator generator, ObjectSE object)` メインコンテンツの前にプレフィックスを書きます。

クラス org.springframework.web.servlet.view.json.AbstractJackson2View から継承されたメソッド
filterAndWrapModel, getEncoding, getObjectMapper, prepareResponse, renderMergedOutputModel, setDisableCaching, setEncoding, setObjectMapper, setPrettyPrint, setUpdateContentLength, writeContent, writeSuffix

クラス org.springframework.web.servlet.view.AbstractView から継承されたメソッド
addStaticAttribute, createMergedOutputModel, createRequestContext, createTemporaryOutputStream, exposeModelAsRequestAttributes, formatViewName, generatesDownloadContent, getAttributesMap, getBeanName, getContentType, getRequestContextAttribute, getRequestToExpose, getStaticAttributes, isExposePathVariables, render, setAttributes, setAttributesCSV, setAttributesMap, setBeanName, setContentType, setExposeContextBeansAsAttributes, setExposedContextBeanNames, setExposePathVariables, setRequestContextAttribute, setResponseContentType, toString, writeToResponse

クラス org.springframework.web.context.support.WebApplicationObjectSupport から継承されたメソッド
getServletContext, getTempDir, getWebApplicationContext, initApplicationContext, initServletContext, isContextRequired, setServletContext

クラス org.springframework.context.support.ApplicationObjectSupport から継承されたメソッド
getApplicationContext, getMessageSourceAccessor, initApplicationContext, obtainApplicationContext, requiredContextClass, setApplicationContext

クラス java.lang.ObjectSE から継承されたメソッド
cloneSE, equalsSE, finalizeSE, getClassSE, hashCodeSE, notifySE, notifyAllSE, waitSE, waitSE, waitSE

- フィールドの詳細
  - DEFAULT_CONTENT_TYPE
```
public static final StringSE DEFAULT_CONTENT_TYPE
```
    デフォルトのコンテンツ型: "application/json"。AbstractView.setContentType(java.lang.String) を介してオーバーライドできます。
    関連事項:
    定数フィールド値
- コンストラクターの詳細
  - MappingJackson2JsonView
```
public MappingJackson2JsonView()
```
    Jackson2ObjectMapperBuilder によって提供されるデフォルト構成を使用して、コンテンツ型を application/json に設定して、新しい MappingJackson2JsonView を構築します。
  - MappingJackson2JsonView
```
public MappingJackson2JsonView(ObjectMapper objectMapper)
```
    提供された ObjectMapper を使用して新しい MappingJackson2JsonView を構築し、コンテンツ型を application/json に設定します。
    導入:
    4.2.1
- メソッドの詳細
  - setJsonPrefix
```
public void setJsonPrefix(StringSE jsonPrefix)
```
    このビューの JSON 出力に使用するカスタムプレフィックスを指定します。デフォルトはなしです。
    関連事項:
    setPrefixJson(boolean)
  - setPrefixJson
```
public void setPrefixJson(boolean prefixJson)
```
    このビューによる JSON 出力の前に "）]} '、" を付ける必要があるかどうかを示します。デフォルトは false です。
    この方法で JSON 文字列のプレフィックスを使用すると、JSON ハイジャックを防ぐことができます。プレフィックスは、文字列をスクリプトとして構文的に無効にして、ハイジャックできないようにします。このプレフィックスは、文字列を JSON として解析する前に削除する必要があります。
    関連事項:
    setJsonPrefix(java.lang.String)
  - setModelKey
```
public void setModelKey(StringSE modelKey)
```
    このビューによってレンダリングされるモデルの属性を設定します。設定すると、他のすべてのモデル属性は無視されます。
    次で指定:
    クラス AbstractJackson2View の setModelKey
  - setModelKeys
```
public void setModelKeys(@Nullable
                         SetSE<StringSE> modelKeys)
```
    このビューによってレンダリングされるモデルの属性を設定します。設定すると、他のすべてのモデル属性は無視されます。
  - getModelKeys
```
@Nullable
public final SetSE<StringSE> getModelKeys()
```
    このビューによってレンダリングされるモデルの属性を返します。
  - setExtractValueFromSingleKeyModel
```
public void setExtractValueFromSingleKeyModel(boolean extractValueFromSingleKeyModel)
```
    単一の属性を含むモデルをマップとして直列化するか、モデルから単一の値を抽出して直接直列化するかを設定します。
    このフラグを設定することの効果は、MappingJackson2HttpMessageConverter を @ResponseBody リクエスト処理メソッドとともに使用することに似ています。
    デフォルトは false です。
  - filterModel
```
protected ObjectSE filterModel(MapSE<StringSE,ObjectSE> model)
```
    指定されたモデルから不要な属性を除外します。戻り値は、別の MapSE または単一の値オブジェクトのいずれかです。
    デフォルトの実装では、BindingResult インスタンスと、modelKeys プロパティに含まれていないエントリが削除されます。
    次で指定:
    クラス AbstractJackson2View の filterModel
    パラメーター:
    model - AbstractJackson2View.renderMergedOutputModel(java.util.Map<java.lang.String, java.lang.Object>, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse) に渡されるモデル
    戻り値:
    レンダリングされる値
  - writePrefix
```
protected void writePrefix(JsonGenerator generator,
                           ObjectSE object)
                    throws IOExceptionSE
```
    クラスからコピーされた説明: AbstractJackson2View
    メインコンテンツの前にプレフィックスを書きます。
    オーバーライド:
    クラス AbstractJackson2View の writePrefix
    パラメーター:
    generator - コンテンツの書き込みに使用するジェネレーター。
    object - 出力メッセージに書き込むオブジェクト。
    例外:
    IOExceptionSE

クラス MappingJackson2JsonView

フィールドサマリー

クラス org.springframework.web.servlet.view.json.AbstractJackson2View から継承されたフィールド

クラス org.springframework.context.support.ApplicationObjectSupport から継承されたフィールド

インターフェース org.springframework.web.servlet.View から継承されたフィールド

コンストラクターのサマリー

メソッドのサマリー

クラス org.springframework.web.servlet.view.json.AbstractJackson2View から継承されたメソッド

クラス org.springframework.web.servlet.view.AbstractView から継承されたメソッド

クラス org.springframework.web.context.support.WebApplicationObjectSupport から継承されたメソッド

クラス org.springframework.context.support.ApplicationObjectSupport から継承されたメソッド

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

フィールドの詳細

DEFAULT_CONTENT_TYPE

コンストラクターの詳細

MappingJackson2JsonView

MappingJackson2JsonView

メソッドの詳細

setJsonPrefix

setPrefixJson

setModelKey

setModelKeys

getModelKeys

setExtractValueFromSingleKeyModel

filterModel

writePrefix