程序包 cn.taketoday.http.converter.json

类 MappingJackson2HttpMessageConverter

java.lang.Object

cn.taketoday.http.converter.AbstractHttpMessageConverter<T>

cn.taketoday.http.converter.AbstractGenericHttpMessageConverter<Object>

cn.taketoday.http.converter.json.AbstractJackson2HttpMessageConverter

cn.taketoday.http.converter.json.MappingJackson2HttpMessageConverter

所有已实现的接口:

GenericHttpMessageConverter<Object>, HttpMessageConverter<Object>

public class MappingJackson2HttpMessageConverter
extends AbstractJackson2HttpMessageConverter

Implementation of HttpMessageConverter that can read and write JSON using Jackson 2.x's ObjectMapper.

This converter can be used to bind to typed beans, or untyped HashMap instances.

By default, this converter supports application/json and application/*+json with UTF-8 character set. This can be overridden by setting the supportedMediaTypes property.

The default constructor uses the default configuration provided by Jackson2ObjectMapperBuilder.

Compatible with Jackson 2.9 to 2.12.

从以下版本开始:

4.0

作者:

Arjen Poutsma, Keith Donald, Rossen Stoyanchev, Juergen Hoeller, Sebastien Deleuze, Harry Yang

字段概要

字段

修饰符和类型	字段	说明
private String	jsonPrefix
private static final List<MediaType>	problemDetailMediaTypes

从类继承的字段 cn.taketoday.http.converter.json.AbstractJackson2HttpMessageConverter

defaultObjectMapper

从类继承的字段 cn.taketoday.http.converter.AbstractHttpMessageConverter

logger

构造器概要

构造器

构造器	说明
MappingJackson2HttpMessageConverter()	Construct a new MappingJackson2HttpMessageConverter using default configuration provided by Jackson2ObjectMapperBuilder.
MappingJackson2HttpMessageConverter(ObjectMapper objectMapper)	Construct a new MappingJackson2HttpMessageConverter with a custom ObjectMapper.

方法概要

修饰符和类型	方法	说明
protected List<MediaType>	getMediaTypesForProblemDetail()	Return the supported media type(s) for ProblemDetail.
void	setJsonPrefix(String jsonPrefix)	Specify a custom prefix to use for this view's JSON output.
void	setPrefixJson(boolean prefixJson)	Indicate whether the JSON output by this view should be prefixed with ")]}', ".
protected void	writePrefix(JsonGenerator generator, Object object)	Write a prefix before the main content.

从类继承的方法 cn.taketoday.http.converter.json.AbstractJackson2HttpMessageConverter

canRead, canRead, canWrite, customizeReader, customizeWriter, getCharset, getContentLength, getDefaultContentType, getJavaType, getJsonEncoding, getObjectMapper, getObjectMappersForType, getSupportedMediaTypes, logWarningIfNecessary, read, readInternal, registerObjectMappersForType, setObjectMapper, setPrettyPrint, writeInternal, writeSuffix

从类继承的方法 cn.taketoday.http.converter.AbstractGenericHttpMessageConverter

canWrite, supports, write, writeInternal

从类继承的方法 cn.taketoday.http.converter.AbstractHttpMessageConverter

addDefaultHeaders, canRead, canWrite, getDefaultCharset, getSupportedMediaTypes, read, setDefaultCharset, setSupportedMediaTypes, write

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

从接口继承的方法 cn.taketoday.http.converter.HttpMessageConverter

getSupportedMediaTypes, read, write

字段详细资料

problemDetailMediaTypes

private static final List<MediaType> problemDetailMediaTypes

jsonPrefix

@Nullable
private String jsonPrefix

构造器详细资料

MappingJackson2HttpMessageConverter

public MappingJackson2HttpMessageConverter()

Construct a new MappingJackson2HttpMessageConverter using default configuration provided by Jackson2ObjectMapperBuilder.

MappingJackson2HttpMessageConverter

public MappingJackson2HttpMessageConverter(ObjectMapper objectMapper)

Construct a new MappingJackson2HttpMessageConverter with a custom ObjectMapper. You can use Jackson2ObjectMapperBuilder to build it easily.

另请参阅:

• Jackson2ObjectMapperBuilder.json()

方法详细资料

setJsonPrefix

public void setJsonPrefix(@Nullable
 String jsonPrefix)

Specify a custom prefix to use for this view's JSON output. Default is none.

另请参阅:

• setPrefixJson(boolean)

setPrefixJson

public void setPrefixJson(boolean prefixJson)

Indicate whether the JSON output by this view should be prefixed with ")]}', ". Default is false.

Prefixing the JSON string in this manner is used to help prevent JSON Hijacking. The prefix renders the string syntactically invalid as a script so that it cannot be hijacked. This prefix should be stripped before parsing the string as JSON.

另请参阅:

• setJsonPrefix(java.lang.String)

writePrefix

protected void writePrefix(JsonGenerator generator,
 Object object)
                    throws IOException

从类复制的说明: AbstractJackson2HttpMessageConverter

Write a prefix before the main content.

覆盖:

writePrefix 在类中 AbstractJackson2HttpMessageConverter

参数:

generator - the generator to use for writing content.

object - the object to write to the output message.

抛出:

IOException

getMediaTypesForProblemDetail

protected List<MediaType> getMediaTypesForProblemDetail()

从类复制的说明: AbstractJackson2HttpMessageConverter

Return the supported media type(s) for ProblemDetail. By default, an empty list, unless overridden in subclasses.

覆盖:

getMediaTypesForProblemDetail 在类中 AbstractJackson2HttpMessageConverter