クラス AbstractMappingJacksonResponseBodyAdvice
java.lang.ObjectSE
org.springframework.web.servlet.mvc.method.annotation.AbstractMappingJacksonResponseBodyAdvice
- 実装されたすべてのインターフェース:
ResponseBodyAdvice<ObjectSE>
- 既知の直属サブクラス
JsonViewResponseBodyAdvice
public abstract class AbstractMappingJacksonResponseBodyAdvice
extends ObjectSE
implements ResponseBodyAdvice<ObjectSE>
AbstractJackson2HttpMessageConverter
の具象サブクラスで JSON 直列化の前にレスポンスをカスタマイズする ResponseBodyAdvice
実装の便利な基本クラス。- 導入:
- 4.1
- 作成者:
- Rossen Stoyanchev, Sebastien Deleuze
コンストラクターのサマリー
メソッドのサマリー
修飾子と型メソッド説明final ObjectSE
beforeBodyWrite
(ObjectSE body, MethodParameter returnType, MediaType contentType, ClassSE<? extends HttpMessageConverter<?>> converterType, ServerHttpRequest request, ServerHttpResponse response) HttpMessageConverter
が選択された後、その書き込みメソッドが呼び出される直前に呼び出されます。protected abstract void
beforeBodyWriteInternal
(MappingJacksonValue bodyContainer, MediaType contentType, MethodParameter returnType, ServerHttpRequest request, ServerHttpResponse response) コンバーター型がMappingJackson2HttpMessageConverter
の場合にのみ呼び出されます。protected MappingJacksonValue
getOrCreateContainer
(ObjectSE body) 本体をMappingJacksonValue
値コンテナーでラップするか(追加の直列化手順を提供するため)、すでにラップされている場合は単にキャストします。boolean
supports
(MethodParameter returnType, ClassSE<? extends HttpMessageConverter<?>> converterType) このコンポーネントが、指定されたコントローラーメソッドの戻り値の型と選択されたHttpMessageConverter
型をサポートするかどうか。
コンストラクターの詳細
AbstractMappingJacksonResponseBodyAdvice
public AbstractMappingJacksonResponseBodyAdvice()
メソッドの詳細
supports
public boolean supports(MethodParameter returnType, ClassSE<? extends HttpMessageConverter<?>> converterType) インターフェースからコピーされた説明:ResponseBodyAdvice
このコンポーネントが、指定されたコントローラーメソッドの戻り値の型と選択されたHttpMessageConverter
型をサポートするかどうか。- 次で指定:
- インターフェース
ResponseBodyAdvice<ObjectSE>
のsupports
- パラメーター:
returnType
- 戻り型converterType
- 選択したコンバーター型- 戻り値:
-
ResponseBodyAdvice.beforeBodyWrite(T, org.springframework.core.MethodParameter, org.springframework.http.MediaType, java.lang.Class<? extends org.springframework.http.converter.HttpMessageConverter<?>>, org.springframework.http.server.ServerHttpRequest, org.springframework.http.server.ServerHttpResponse)
を呼び出す必要がある場合はtrue
。それ以外の場合はfalse
beforeBodyWrite
@Nullable public final ObjectSE beforeBodyWrite(@Nullable ObjectSE body, MethodParameter returnType, MediaType contentType, ClassSE<? extends HttpMessageConverter<?>> converterType, ServerHttpRequest request, ServerHttpResponse response) インターフェースからコピーされた説明:ResponseBodyAdvice
HttpMessageConverter
が選択された後、その書き込みメソッドが呼び出される直前に呼び出されます。- 次で指定:
- インターフェース
ResponseBodyAdvice<ObjectSE>
のbeforeBodyWrite
- パラメーター:
body
- 書き込まれる本文returnType
- コントローラーメソッドの戻りの型contentType
- コンテンツネゴシエーションを通じて選択されたコンテンツ型converterType
- レスポンスに書き込むために選択されたコンバーター型request
- 現在のリクエストresponse
- 現在のレスポンス- 戻り値:
- 渡されたボディまたは変更された(おそらく新しい)インスタンス
getOrCreateContainer
本体をMappingJacksonValue
値コンテナーでラップするか(追加の直列化手順を提供するため)、すでにラップされている場合は単にキャストします。beforeBodyWriteInternal
protected abstract void beforeBodyWriteInternal(MappingJacksonValue bodyContainer, MediaType contentType, MethodParameter returnType, ServerHttpRequest request, ServerHttpResponse response) コンバーター型がMappingJackson2HttpMessageConverter
の場合にのみ呼び出されます。