类 FormHttpMessageWriter
- java.lang.Object
- org.springframework.http.codec.LoggingCodecSupport
- org.springframework.http.codec.FormHttpMessageWriter
- 所有已实现的接口:
HttpMessageWriter<MultiValueMap<String,String>>
public class FormHttpMessageWriter extends LoggingCodecSupport implements HttpMessageWriter<MultiValueMap<String,String>>
HttpMessageWriterfor writing aMultiValueMap<String, String>as HTML form data, i.e."application/x-www-form-urlencoded", to the body of a request.Note that unless the media type is explicitly set to
MediaType.APPLICATION_FORM_URLENCODED, thecanWrite(org.springframework.core.ResolvableType, org.springframework.http.MediaType)method will need generic type information to confirm the target map has String values. This is because a MultiValueMap with non-String values can be used to write multipart requests.To support both form data and multipart requests, consider using
MultipartHttpMessageWriterconfigured with this writer as the fallback for writing plain form data.- 从以下版本开始:
- 5.0
- 作者:
- Sebastien Deleuze, Rossen Stoyanchev
- 另请参阅:
MultipartHttpMessageWriter
字段概要
字段 修饰符和类型 字段 说明 static CharsetDEFAULT_CHARSETThe default charset used by the writer.从类继承的字段 org.springframework.http.codec.LoggingCodecSupport
logger
构造器概要
构造器 构造器 说明 FormHttpMessageWriter()
方法概要
所有方法 实例方法 具体方法 修饰符和类型 方法 说明 booleancanWrite(ResolvableType elementType, MediaType mediaType)Whether the given object type is supported by this writer.CharsetgetDefaultCharset()Return the configured default charset.protected MediaTypegetMediaType(MediaType mediaType)List<MediaType>getWritableMediaTypes()Return theMediaType's that this writer supports.protected StringserializeForm(MultiValueMap<String,String> formData, Charset charset)voidsetDefaultCharset(Charset charset)Set the default character set to use for writing form data when the response Content-Type header does not explicitly specify it.reactor.core.publisher.Mono<Void>write(org.reactivestreams.Publisher<? extends MultiValueMap<String,String>> inputStream, ResolvableType elementType, MediaType mediaType, ReactiveHttpOutputMessage message, Map<String,Object> hints)Write an given stream of object to the output message.从类继承的方法 org.springframework.http.codec.LoggingCodecSupport
isEnableLoggingRequestDetails, setEnableLoggingRequestDetails
从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
从接口继承的方法 org.springframework.http.codec.HttpMessageWriter
write
字段详细资料
DEFAULT_CHARSET
public static final Charset DEFAULT_CHARSET
The default charset used by the writer.
构造器详细资料
FormHttpMessageWriter
public FormHttpMessageWriter()
方法详细资料
setDefaultCharset
public void setDefaultCharset(Charset charset)
Set the default character set to use for writing form data when the response Content-Type header does not explicitly specify it.By default this is set to "UTF-8".
getDefaultCharset
public Charset getDefaultCharset()
Return the configured default charset.
getWritableMediaTypes
public List<MediaType> getWritableMediaTypes()
从接口复制的说明:HttpMessageWriterReturn theMediaType's that this writer supports.- 指定者:
getWritableMediaTypes在接口中HttpMessageWriter<MultiValueMap<String,String>>
canWrite
public boolean canWrite(ResolvableType elementType, @Nullable MediaType mediaType)
从接口复制的说明:HttpMessageWriterWhether the given object type is supported by this writer.- 指定者:
canWrite在接口中HttpMessageWriter<MultiValueMap<String,String>>- 参数:
elementType- the type of object to checkmediaType- the media type for the write (possiblynull)- 返回:
trueif writable,falseotherwise
write
public reactor.core.publisher.Mono<Void> write(org.reactivestreams.Publisher<? extends MultiValueMap<String,String>> inputStream, ResolvableType elementType, @Nullable MediaType mediaType, ReactiveHttpOutputMessage message, Map<String,Object> hints)
从接口复制的说明:HttpMessageWriterWrite an given stream of object to the output message.- 指定者:
write在接口中HttpMessageWriter<MultiValueMap<String,String>>- 参数:
inputStream- the objects to writeelementType- the type of objects in the stream which must have been previously checked viaHttpMessageWriter.canWrite(ResolvableType, MediaType)mediaType- the content type for the write (possiblynullto indicate that the default content type of the writer must be used)message- the message to write tohints- additional information about how to encode and write- 返回:
- indicates completion or error
getMediaType
protected MediaType getMediaType(@Nullable MediaType mediaType)
serializeForm
protected String serializeForm(MultiValueMap<String,String> formData, Charset charset)