类 StringHttpMessageConverter
- java.lang.Object
- org.springframework.http.converter.AbstractHttpMessageConverter<String>
- org.springframework.http.converter.StringHttpMessageConverter
- 所有已实现的接口:
HttpMessageConverter<String>
public class StringHttpMessageConverter extends AbstractHttpMessageConverter<String>
Implementation ofHttpMessageConverter
that can read and write strings.By default, this converter supports all media types (
*/*
), and writes with aContent-Type
oftext/plain
. This can be overridden by setting thesupportedMediaTypes
property.- 从以下版本开始:
- 3.0
- 作者:
- Arjen Poutsma, Juergen Hoeller
字段概要
字段 修饰符和类型 字段 说明 static Charset
DEFAULT_CHARSET
The default charset used by the converter.从类继承的字段 org.springframework.http.converter.AbstractHttpMessageConverter
logger
构造器概要
构造器 构造器 说明 StringHttpMessageConverter()
A default constructor that uses"ISO-8859-1"
as the default charset.StringHttpMessageConverter(Charset defaultCharset)
A constructor accepting a default charset to use if the requested content type does not specify one.
方法概要
所有方法 实例方法 具体方法 修饰符和类型 方法 说明 protected void
addDefaultHeaders(HttpHeaders headers, String s, MediaType type)
Add default headers to the output message.protected List<Charset>
getAcceptedCharsets()
Return the list of supportedCharsets
.protected Long
getContentLength(String str, MediaType contentType)
Returns the content length for the given type.protected String
readInternal(Class<? extends String> clazz, HttpInputMessage inputMessage)
Abstract template method that reads the actual object.void
setWriteAcceptCharset(boolean writeAcceptCharset)
Whether theAccept-Charset
header should be written to any outgoing request sourced from the value ofCharset.availableCharsets()
.boolean
supports(Class<?> clazz)
Indicates whether the given class is supported by this converter.protected void
writeInternal(String str, HttpOutputMessage outputMessage)
Abstract template method that writes the actual body.从类继承的方法 org.springframework.http.converter.AbstractHttpMessageConverter
canRead, canRead, canWrite, canWrite, getDefaultCharset, getDefaultContentType, getSupportedMediaTypes, read, setDefaultCharset, setSupportedMediaTypes, write
字段详细资料
DEFAULT_CHARSET
public static final Charset DEFAULT_CHARSET
The default charset used by the converter.
构造器详细资料
StringHttpMessageConverter
public StringHttpMessageConverter()
A default constructor that uses"ISO-8859-1"
as the default charset.
StringHttpMessageConverter
public StringHttpMessageConverter(Charset defaultCharset)
A constructor accepting a default charset to use if the requested content type does not specify one.
方法详细资料
setWriteAcceptCharset
public void setWriteAcceptCharset(boolean writeAcceptCharset)
Whether theAccept-Charset
header should be written to any outgoing request sourced from the value ofCharset.availableCharsets()
. The behavior is suppressed if the header has already been set.As of 5.2, by default is set to
false
.
supports
public boolean supports(Class<?> clazz)
从类复制的说明:AbstractHttpMessageConverter
Indicates whether the given class is supported by this converter.- 指定者:
supports
在类中AbstractHttpMessageConverter<String>
- 参数:
clazz
- the class to test for support- 返回:
true
if supported;false
otherwise
readInternal
protected String readInternal(Class<? extends String> clazz, HttpInputMessage inputMessage) throws IOException
从类复制的说明:AbstractHttpMessageConverter
Abstract template method that reads the actual object. Invoked fromAbstractHttpMessageConverter.read(java.lang.Class<? extends T>, org.springframework.http.HttpInputMessage)
.- 指定者:
readInternal
在类中AbstractHttpMessageConverter<String>
- 参数:
clazz
- the type of object to returninputMessage
- the HTTP input message to read from- 返回:
- the converted object
- 抛出:
IOException
- in case of I/O errors
getContentLength
protected Long getContentLength(String str, @Nullable MediaType contentType)
从类复制的说明:AbstractHttpMessageConverter
Returns the content length for the given type.By default, this returns
null
, meaning that the content length is unknown. Can be overridden in subclasses.- 覆盖:
getContentLength
在类中AbstractHttpMessageConverter<String>
- 参数:
str
- the type to return the content length for- 返回:
- the content length, or
null
if not known
addDefaultHeaders
protected void addDefaultHeaders(HttpHeaders headers, String s, @Nullable MediaType type) throws IOException
从类复制的说明:AbstractHttpMessageConverter
Add default headers to the output message.This implementation delegates to
AbstractHttpMessageConverter.getDefaultContentType(Object)
if a content type was not provided, set if necessary the default character set, callsAbstractHttpMessageConverter.getContentLength(T, org.springframework.http.MediaType)
, and sets the corresponding headers.
writeInternal
protected void writeInternal(String str, HttpOutputMessage outputMessage) throws IOException
从类复制的说明:AbstractHttpMessageConverter
Abstract template method that writes the actual body. Invoked fromAbstractHttpMessageConverter.write(T, org.springframework.http.MediaType, org.springframework.http.HttpOutputMessage)
.- 指定者:
writeInternal
在类中AbstractHttpMessageConverter<String>
- 参数:
str
- the object to write to the output messageoutputMessage
- the HTTP output message to write to- 抛出:
IOException
- in case of I/O errors
getAcceptedCharsets
protected List<Charset> getAcceptedCharsets()
Return the list of supportedCharsets
.By default, returns
Charset.availableCharsets()
. Can be overridden in subclasses.- 返回:
- the list of accepted charsets