Class JacksonJsonEncoder

java.lang.Object

org.springframework.http.codec.JacksonCodecSupport

org.springframework.http.codec.AbstractJacksonEncoder

org.springframework.http.codec.json.JacksonJsonEncoder

All Implemented Interfaces:

Encoder<Object>, HttpMessageEncoder<Object>

public class JacksonJsonEncoder
extends AbstractJacksonEncoder

Encode from an Object stream to a byte stream of JSON objects using Jackson 3.x. For non-streaming use cases, Flux elements are collected into a List before serialization for performance reason.

The default constructor loads JacksonModules found by MapperBuilder.findModules(ClassLoader).

Since:

7.0

Author:

Sebastien Deleuze

See Also:

• JacksonJsonDecoder

Field Summary

Fields inherited from class org.springframework.http.codec.JacksonCodecSupport

FILTER_PROVIDER_HINT, JSON_VIEW_HINT, logger, objectMapperRegistrations

Constructor Summary

Constructors

Constructor	Description
JacksonJsonEncoder()	Construct a new instance with a JsonMapper customized with the JacksonModules found by MapperBuilder.findModules(ClassLoader) and ProblemDetailJacksonMixin.
JacksonJsonEncoder(ObjectMapper mapper)	Construct a new instance with the provided ObjectMapper.
JacksonJsonEncoder(ObjectMapper mapper, MimeType... mimeTypes)	Construct a new instance with the provided ObjectMapper and MimeTypes.

Method Summary

Modifier and Type	Method	Description
protected ObjectWriter	customizeWriter(ObjectWriter writer, @Nullable MimeType mimeType, ResolvableType elementType, @Nullable Map<String,Object> hints)	Subclasses can use this method to customize the ObjectWriter used for writing values.
protected List<MimeType>	getMediaTypesForProblemDetail()	Return the supported media type(s) for ProblemDetail.

Methods inherited from class org.springframework.http.codec.AbstractJacksonEncoder

canEncode, encode, encodeValue, getAnnotation, getEncodableMimeTypes, getEncodableMimeTypes, getEncodeHints, getJsonEncoding, getStreamingMediaTypes, getStreamingMediaTypeSeparator, setStreamingMediaTypes

Methods inherited from class org.springframework.http.codec.JacksonCodecSupport

getHints, getJavaType, getMimeTypes, getMimeTypes, getObjectMapper, getObjectMapperRegistrations, getObjectMappersForType, getParameter, registerObjectMappersForType, selectObjectMapper, supportsMimeType

Methods inherited from class java.lang.Object

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

Constructor Details

JacksonJsonEncoder

public JacksonJsonEncoder()

Construct a new instance with a JsonMapper customized with the JacksonModules found by MapperBuilder.findModules(ClassLoader) and ProblemDetailJacksonMixin.

JacksonJsonEncoder

public JacksonJsonEncoder(ObjectMapper mapper)

Construct a new instance with the provided ObjectMapper.

See Also:

• JsonMapper.builder()
• MapperBuilder.findModules(ClassLoader)

JacksonJsonEncoder

public JacksonJsonEncoder(ObjectMapper mapper,
 MimeType... mimeTypes)

Construct a new instance with the provided ObjectMapper and MimeTypes.

See Also:

• JsonMapper.builder()
• MapperBuilder.findModules(ClassLoader)

Method Details

getMediaTypesForProblemDetail

protected List<MimeType> getMediaTypesForProblemDetail()

Description copied from class: JacksonCodecSupport

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

Overrides:

getMediaTypesForProblemDetail in class JacksonCodecSupport

customizeWriter

protected ObjectWriter customizeWriter(ObjectWriter writer,
 @Nullable MimeType mimeType,
 ResolvableType elementType,
 @Nullable Map<String,Object> hints)

Description copied from class: AbstractJacksonEncoder

Subclasses can use this method to customize the ObjectWriter used for writing values.

Overrides:

customizeWriter in class AbstractJacksonEncoder

Parameters:

writer - the writer instance to customize

mimeType - the selected MIME type

elementType - the type of element values to write

hints - a map with serialization hints; the Reactor Context, when available, may be accessed under the key ContextView.class.getName()

Returns:

the customized ObjectWriter to use