クラス DecoderHttpMessageReader<T>
java.lang.ObjectSE
org.springframework.http.codec.DecoderHttpMessageReader<T>
- 型パラメーター:
T- デコードされた出力ストリーム内のオブジェクトの型
- 実装されているすべてのインターフェース:
HttpMessageReader<T>
- 既知の直属サブクラス
ResourceHttpMessageReader
ラップして
Decoder に委譲する HttpMessageReader。 また、リクエストやコントローラーメソッドのパラメーターアノテーションなど、サーバー側で利用可能な追加情報からデコードヒントを事前に解決する HttpMessageReader。
- 導入:
- 5.0
- 作成者:
- Arjen Poutsma, Sebastien Deleuze, Rossen Stoyanchev
コンストラクターの概要
コンストラクター方法の概要
修飾子と型メソッド説明booleancanRead(ResolvableType elementType, @Nullable MediaType mediaType) 指定されたオブジェクト型がこのリーダーでサポートされているかどうか。getContentType(HttpMessage inputMessage) "Content-Type" ヘッダーに基づいて HTTP メッセージの Content-Type を決定するか、デフォルトでMediaType.APPLICATION_OCTET_STREAMに設定します。このリーダーのDecoderを返します。このリーダーでサポートされているメディア型のリストを返します。getReadableMediaTypes(ResolvableType elementType) 指定された型の要素について、このリーダーでサポートされているメディア型のリストを返します。getReadHints(ResolvableType actualType, ResolvableType elementType, ServerHttpRequest request, ServerHttpResponse response) たとえば、サーバーリクエストまたはコントローラーメソッドパラメーターからのアノテーションに基づいて、デコードの追加のヒントを取得します。getReadHints(ResolvableType elementType, ReactiveHttpInputMessage message) 入力 HTTP メッセージに基づいてデコードするための追加のヒントを取得します。read(ResolvableType actualType, ResolvableType elementType, ServerHttpRequest request, ServerHttpResponse response, MapSE<StringSE, ObjectSE> hints) 追加のコンテキストが利用可能な、HttpMessageReader.read(ResolvableType, ReactiveHttpInputMessage, Map)のサーバー側のみの代替。read(ResolvableType elementType, ReactiveHttpInputMessage message, MapSE<StringSE, ObjectSE> hints) 入力メッセージから読み取り、オブジェクトのストリームにデコードします。readMono(ResolvableType actualType, ResolvableType elementType, ServerHttpRequest request, ServerHttpResponse response, MapSE<StringSE, ObjectSE> hints) 追加のコンテキストを使用できる、HttpMessageReader.readMono(ResolvableType, ReactiveHttpInputMessage, Map)のサーバー側のみの代替。readMono(ResolvableType elementType, ReactiveHttpInputMessage message, MapSE<StringSE, ObjectSE> hints) 入力メッセージから読み取り、単一のオブジェクトにデコードします。
コンストラクターの詳細
DecoderHttpMessageReader
メソッドの詳細
getDecoder
getReadableMediaTypes
インターフェースからコピーされた説明:HttpMessageReaderこのリーダーでサポートされているメディア型のリストを返します。このリストは、考えられるすべてのターゲット要素型に適用されるとは限らないため、このメソッドの呼び出しは通常、canWrite(elementType, null)を介して保護する必要があります。このリストでは、特定の要素型でのみサポートされているメディア型を除外することもできます。または、HttpMessageReader.getReadableMediaTypes(ResolvableType)を使用してより正確なリストを作成します。- 次で指定:
- インターフェース
HttpMessageReader<T>のgetReadableMediaTypes - 戻り値:
- サポートされているメディア型の一般的なリスト
getReadableMediaTypes
インターフェースからコピーされた説明:HttpMessageReader指定された型の要素について、このリーダーでサポートされているメディア型のリストを返します。リーダーが要素型をサポートしていない場合、またはメディア型のサブセットに対してのみサポートしている場合、このリストはHttpMessageReader.getReadableMediaTypes()とは異なる場合があります。- 次で指定:
- インターフェース
HttpMessageReader<T>のgetReadableMediaTypes - パラメーター:
elementType- 読み取る要素の型- 戻り値:
- 特定のクラスでサポートされているメディア型のリスト
canRead
インターフェースからコピーされた説明:HttpMessageReader指定されたオブジェクト型がこのリーダーでサポートされているかどうか。- 次で指定:
- インターフェース
HttpMessageReader<T>のcanRead - パラメーター:
elementType- チェックするオブジェクトの型mediaType- 読み取り用のメディア型 (おそらくnull)- 戻り値:
- 読み取り可能な場合は
true、そうでない場合はfalse
read
public Flux<T> read(ResolvableType elementType, ReactiveHttpInputMessage message, MapSE<StringSE, ObjectSE> hints) インターフェースからコピーされた説明:HttpMessageReader入力メッセージから読み取り、オブジェクトのストリームにデコードします。- 次で指定:
- インターフェース
HttpMessageReader<T>のread - パラメーター:
elementType-HttpMessageReader.canRead(ResolvableType, MediaType)を介して事前にチェックされている必要があるストリーム内のオブジェクトの型message- 読み取るメッセージhints- 入力の読み取りおよびデコード方法に関する追加情報- 戻り値:
- 要素のデコードされたストリーム
readMono
public Mono<T> readMono(ResolvableType elementType, ReactiveHttpInputMessage message, MapSE<StringSE, ObjectSE> hints) インターフェースからコピーされた説明:HttpMessageReader入力メッセージから読み取り、単一のオブジェクトにデコードします。- 次で指定:
- インターフェース
HttpMessageReader<T>のreadMono - パラメーター:
elementType-HttpMessageReader.canRead(ResolvableType, MediaType)を介して事前にチェックされている必要があるストリーム内のオブジェクトの型message- 読み取るメッセージhints- 入力の読み取りおよびデコード方法に関する追加情報- 戻り値:
- デコードされたオブジェクト
getContentType
"Content-Type" ヘッダーに基づいて HTTP メッセージの Content-Type を決定するか、デフォルトでMediaType.APPLICATION_OCTET_STREAMに設定します。- パラメーター:
inputMessage- HTTP メッセージ- 戻り値:
- MediaType、場合によっては
null。
getReadHints
protected MapSE<StringSE,ObjectSE> getReadHints(ResolvableType elementType, ReactiveHttpInputMessage message) 入力 HTTP メッセージに基づいてデコードするための追加のヒントを取得します。- 導入:
- 5.3
read
public Flux<T> read(ResolvableType actualType, ResolvableType elementType, ServerHttpRequest request, ServerHttpResponse response, MapSE<StringSE, ObjectSE> hints) インターフェースからコピーされた説明:HttpMessageReader追加のコンテキストが利用可能な、HttpMessageReader.read(ResolvableType, ReactiveHttpInputMessage, Map)のサーバー側のみの代替。- 次で指定:
- インターフェース
HttpMessageReader<T>のread - パラメーター:
actualType- ターゲットメソッドパラメーターの実際の型。アノテーション付きコントローラーの場合、MethodParameterにはResolvableType.getSource()を介してアクセスできます。elementType- 出力ストリーム内のオブジェクトの型request- 現在のリクエストresponse- 現在のレスポンスhints- 本文の読み方に関する追加情報- 戻り値:
- 要素のデコードされたストリーム
readMono
public Mono<T> readMono(ResolvableType actualType, ResolvableType elementType, ServerHttpRequest request, ServerHttpResponse response, MapSE<StringSE, ObjectSE> hints) インターフェースからコピーされた説明:HttpMessageReader追加のコンテキストを使用できる、HttpMessageReader.readMono(ResolvableType, ReactiveHttpInputMessage, Map)のサーバー側のみの代替。- 次で指定:
- インターフェース
HttpMessageReader<T>のreadMono - パラメーター:
actualType- ターゲットメソッドパラメーターの実際の型。アノテーション付きコントローラーの場合、MethodParameterにはResolvableType.getSource()を介してアクセスできます。elementType- 出力ストリーム内のオブジェクトの型request- 現在のリクエストresponse- 現在のレスポンスhints- 本文の読み方に関する追加情報- 戻り値:
- 要素のデコードされたストリーム
getReadHints
protected MapSE<StringSE,ObjectSE> getReadHints(ResolvableType actualType, ResolvableType elementType, ServerHttpRequest request, ServerHttpResponse response) たとえばサーバーリクエストやコントローラーメソッドパラメーターからのアノテーションに基づいて、デコードに関する追加のヒントを取得します。デフォルトでは、HttpMessageDecoderのインスタンスである場合はデコーダーに委譲します。