クラス MultipartHttpMessageWriter
java.lang.ObjectSE
org.springframework.http.codec.LoggingCodecSupport
org.springframework.http.codec.multipart.MultipartWriterSupport
org.springframework.http.codec.multipart.MultipartHttpMessageWriter
- 実装されたすべてのインターフェース:
HttpMessageWriter<MultiValueMap<StringSE,
?>>
public class MultipartHttpMessageWriter
extends MultipartWriterSupport
implements HttpMessageWriter<MultiValueMap<StringSE,?>>
MultiValueMap<String, ?>
をマルチパートフォームデータ、つまり "multipart/form-data"
としてリクエストの本文に書き込むための HttpMessageWriter
。 個々のパーツの直列化は、他のライターに委譲されます。デフォルトでは、String
SE および Resource
パーツのみがサポートされていますが、コンストラクター引数を使用して他のパーツを構成できます。
このライターは、委譲先の FormHttpMessageWriter
で構成できます。これは、(各ライターを個別に登録するのではなく)フォームデータとマルチパートデータの両方をサポートするための推奨される方法です。これにより、MediaType
が指定されておらず、ジェネリクスがターゲット要素型に存在しない場合、実際のマップで値をインスペクションできます。プレーンフォームデータ(文字列値のみ)を書き込むかどうかを決定します。
- 導入:
- 5.0
- 作成者:
- Sebastien Deleuze, Rossen Stoyanchev
- 関連事項:
フィールドサマリー
クラス org.springframework.http.codec.multipart.MultipartWriterSupport から継承されたフィールド
DEFAULT_CHARSET
クラス org.springframework.http.codec.LoggingCodecSupport から継承されたフィールド
logger
コンストラクターのサマリー
コンストラクターコンストラクター説明パーツライター(String および Resource)のデフォルトリストを持つコンストラクター。MultipartHttpMessageWriter
(SupplierSE<ListSE<HttpMessageWriter<?>>> partWritersSupplier, HttpMessageWriter<MultiValueMap<StringSE, StringSE>> formWriter) メディア型が指定されておらず、実際のマップが String 値のみで構成されている場合に、パーツを直列化するためのライターの明示的なリストと、プレーンフォームデータのライターをフォールバックするためのサプライヤーを持つコンストラクター。MultipartHttpMessageWriter
(ListSE<HttpMessageWriter<?>> partWriters) パーツを直列化するためのライターの明示的なリストを持つコンストラクター。MultipartHttpMessageWriter
(ListSE<HttpMessageWriter<?>> partWriters, HttpMessageWriter<MultiValueMap<StringSE, StringSE>> formWriter) メディア型が指定されておらず、実際のマップが文字列値のみで構成されている場合に、パーツを直列化するライターの明示的なリストとプレーンフォームデータのライターをフォールバックするコンストラクター。方法の概要
修飾子と型メソッド説明boolean
canWrite
(ResolvableType elementType, MediaType mediaType) 指定されたオブジェクト型がこのライターでサポートされているかどうか。構成されたフォームライターを返します。構成されたパーツライターを返します。reactor.core.publisher.Mono<VoidSE>
write
(Publisher<? extends MultiValueMap<StringSE, ?>> inputStream, ResolvableType elementType, MediaType mediaType, ReactiveHttpOutputMessage outputMessage, MapSE<StringSE, ObjectSE> hints) オブジェクトの特定のストリームを出力メッセージに書き込みます。クラス org.springframework.http.codec.multipart.MultipartWriterSupport から継承されたメソッド
generateBoundaryLine, generateLastLine, generateMultipartBoundary, generateNewLine, generatePartHeaders, getCharset, getMultipartMediaType, getWritableMediaTypes, setCharset
クラス org.springframework.http.codec.LoggingCodecSupport から継承されたメソッド
isEnableLoggingRequestDetails, setEnableLoggingRequestDetails
クラス java.lang.ObjectSE から継承されたメソッド
clone, equalsSE, finalize, getClass, hashCode, notify, notifyAll, toString, wait, waitSE, waitSE
インターフェース org.springframework.http.codec.HttpMessageWriter から継承されたメソッド
getWritableMediaTypes, getWritableMediaTypes, write
コンストラクターの詳細
MultipartHttpMessageWriter
public MultipartHttpMessageWriter()パーツライター(String および Resource)のデフォルトリストを持つコンストラクター。MultipartHttpMessageWriter
パーツを直列化するためのライターの明示的なリストを持つコンストラクター。MultipartHttpMessageWriter
public MultipartHttpMessageWriter(ListSE<HttpMessageWriter<?>> partWriters, @Nullable HttpMessageWriter<MultiValueMap<StringSE, StringSE>> formWriter) メディア型が指定されておらず、実際のマップが文字列値のみで構成されている場合に、パーツを直列化するライターの明示的なリストとプレーンフォームデータのライターをフォールバックするコンストラクター。- パラメーター:
partWriters
- パーツをシリアライズするためのライターformWriter
- フォームデータのフォールバックライター、デフォルトではnull
MultipartHttpMessageWriter
public MultipartHttpMessageWriter(SupplierSE<ListSE<HttpMessageWriter<?>>> partWritersSupplier, @Nullable HttpMessageWriter<MultiValueMap<StringSE, StringSE>> formWriter) メディア型が指定されておらず、実際のマップが String 値のみで構成されている場合に、パーツを直列化するためのライターの明示的なリストと、プレーンフォームデータのライターをフォールバックするためのサプライヤーを持つコンストラクター。- パラメーター:
partWritersSupplier
- パーツ連載用ライターのサプライヤーformWriter
- フォームデータのフォールバックライター、デフォルトではnull
- 導入:
- 6.0.3
メソッドの詳細
getPartWriters
構成されたパーツライターを返します。- 導入:
- 5.0.7
getFormWriter
構成されたフォームライターを返します。- 導入:
- 5.1.13
canWrite
インターフェースからコピーされた説明:HttpMessageWriter
指定されたオブジェクト型がこのライターでサポートされているかどうか。- 次で指定:
- インターフェース
HttpMessageWriter<MultiValueMap<StringSE,
の?>> canWrite
- パラメーター:
elementType
- チェックするオブジェクトの型mediaType
- 書き込みのメディア型 (おそらくnull
)- 戻り値:
- 書き込み可能な場合は
true
、それ以外の場合はfalse
write
public reactor.core.publisher.Mono<VoidSE> write(Publisher<? extends MultiValueMap<StringSE, ?>> inputStream, ResolvableType elementType, @Nullable MediaType mediaType, ReactiveHttpOutputMessage outputMessage, MapSE<StringSE, ObjectSE> hints) インターフェースからコピーされた説明:HttpMessageWriter
オブジェクトの特定のストリームを出力メッセージに書き込みます。- 次で指定:
- インターフェース
HttpMessageWriter<MultiValueMap<StringSE,
の?>> write
- パラメーター:
inputStream
- 書き込むオブジェクトelementType
-HttpMessageWriter.canWrite(ResolvableType, MediaType)
を介して事前にチェックされている必要があるストリーム内のオブジェクトの型mediaType
- 書き込みのコンテンツ型 (ライターのデフォルトのコンテンツ型を使用する必要があることを示すnull
)outputMessage
- 書き込むメッセージhints
- エンコードおよび書き込み方法に関する追加情報- 戻り値:
- 完了またはエラーを示します