public class Jackson2ObjectMapperFactoryBean extends java.lang.Object implements FactoryBean<ObjectMapper>, InitializingBean
FactoryBean
for creating a Jackson 2 ObjectMapper
with setters
to enable or disable Jackson features from within XML configuration.
Example usage with
MappingJackson2HttpMessageConverter
:
<bean class="org.springframework.http.converter.json.MappingJackson2HttpMessageConverter"> <property name="objectMapper"> <bean class="org.springframework.web.context.support.Jackson2ObjectMapperFactoryBean" p:autoDetectFields="false" p:autoDetectGettersSetters="false" p:annotationIntrospector-ref="jaxbAnnotationIntrospector" /> </property> </bean>
Example usage with MappingJackson2JsonView:
<bean class="org.springframework.web.servlet.view.json.MappingJackson2JsonView"> <property name="objectMapper"> <bean class="org.springframework.web.context.support.Jackson2ObjectMapperFactoryBean" p:failOnEmptyBeans="false" p:indentOutput="true"> <property name="serializers"> <array> <bean class="org.mycompany.MyCustomSerializer" /> </array> </property> </bean> </property> </bean>
In case there are no specific setters provided (for some rarely used
options), you can still use the more general methods
setFeaturesToEnable(Object[])
and setFeaturesToDisable(Object[])
.
<bean class="org.springframework.web.context.support.Jackson2ObjectMapperFactoryBean"> <property name="featuresToEnable"> <array> <util:constant static-field="com.fasterxml.jackson.databind.SerializationFeature$WRAP_ROOT_VALUE"/> <util:constant static-field="com.fasterxml.jackson.databind.SerializationFeature$CLOSE_CLOSEABLE"/> </array> </property> <property name="featuresToDisable"> <array> <util:constant static-field="com.fasterxml.jackson.databind.MapperFeature$USE_ANNOTATIONS"/> </array> </property> </bean>
Modifier and Type | Field and Description |
---|---|
private AnnotationIntrospector |
annotationIntrospector |
private java.text.DateFormat |
dateFormat |
private java.util.Map<java.lang.Class<?>, |
deserializers |
private java.util.Map<java.lang.Object,java.lang.Boolean> |
features |
private ObjectMapper |
objectMapper |
private java.util.Map<java.lang.Class<?>, |
serializers |
Constructor and Description |
---|
Jackson2ObjectMapperFactoryBean() |
Modifier and Type | Method and Description |
---|---|
private <T> void |
addDeserializers(SimpleModule module) |
private <T> void |
addSerializers(SimpleModule module) |
void |
afterPropertiesSet()
Invoked by a BeanFactory after it has set all bean properties supplied
(and satisfied BeanFactoryAware and ApplicationContextAware).
|
private void |
configureFeature(java.lang.Object feature,
boolean enabled) |
ObjectMapper |
getObject()
Return the singleton ObjectMapper.
|
java.lang.Class<?> |
getObjectType()
Return the type of object that this FactoryBean creates,
or
null if not known in advance. |
boolean |
isSingleton()
Is the object managed by this factory a singleton? That is,
will
FactoryBean.getObject() always return the same object
(a reference that can be cached)? |
void |
setAnnotationIntrospector(AnnotationIntrospector annotationIntrospector)
Set the
AnnotationIntrospector for both serialization and
deserialization. |
void |
setAutoDetectFields(boolean autoDetectFields)
Shortcut for
MapperFeature#AUTO_DETECT_FIELDS option. |
void |
setAutoDetectGettersSetters(boolean autoDetectGettersSetters)
Shortcut for
MapperFeature#AUTO_DETECT_SETTERS /
MapperFeature#AUTO_DETECT_GETTERS option. |
void |
setDateFormat(java.text.DateFormat dateFormat)
Define the format for date/time with the given
DateFormat . |
void |
setDeserializersByType(java.util.Map<java.lang.Class<?>,
Configure custom deserializers for the given types.
|
void |
setFailOnEmptyBeans(boolean failOnEmptyBeans)
Shortcut for
SerializationFeature#FAIL_ON_EMPTY_BEANS option. |
void |
setFeaturesToDisable(java.lang.Object... featuresToDisable)
Specify features to disable.
|
void |
setFeaturesToEnable(java.lang.Object... featuresToEnable)
Specify features to enable.
|
void |
setIndentOutput(boolean indentOutput)
Shortcut for
SerializationFeature#INDENT_OUTPUT option. |
void |
setObjectMapper(ObjectMapper objectMapper)
Set the ObjectMapper instance to use.
|
void |
setSerializers(
Configure custom serializers.
|
void |
setSerializersByType(java.util.Map<java.lang.Class<?>,
Configure custom serializers for the given types.
|
void |
setSimpleDateFormat(java.lang.String format)
Define the date/time format with a
SimpleDateFormat . |
private ObjectMapper objectMapper
private java.util.Map<java.lang.Object,java.lang.Boolean> features
private java.text.DateFormat dateFormat
private AnnotationIntrospector annotationIntrospector
private final java.util.Map<java.lang.Class<?>,> serializers
private final java.util.Map<java.lang.Class<?>,> deserializers
public void setObjectMapper(ObjectMapper objectMapper)
public void setDateFormat(java.text.DateFormat dateFormat)
DateFormat
.
Note: Setting this property makes the exposed ObjectMapper
non-thread-safe, according to Jackson's thread safety rules.
setSimpleDateFormat(String)
public void setSimpleDateFormat(java.lang.String format)
SimpleDateFormat
.
Note: Setting this property makes the exposed ObjectMapper
non-thread-safe, according to Jackson's thread safety rules.
setDateFormat(DateFormat)
public void setAnnotationIntrospector(AnnotationIntrospector annotationIntrospector)
AnnotationIntrospector
for both serialization and
deserialization.public void setSerializers(... serializers)
JsonSerializer#handledType()
, which must not be
null
.setSerializersByType(Map)
public void setSerializersByType(java.util.Map<java.lang.Class<?>,> serializers)
#setSerializers(JsonSerializer...)
public void setDeserializersByType(java.util.Map<java.lang.Class<?>,> deserializers)
public void setAutoDetectFields(boolean autoDetectFields)
MapperFeature#AUTO_DETECT_FIELDS
option.public void setAutoDetectGettersSetters(boolean autoDetectGettersSetters)
MapperFeature#AUTO_DETECT_SETTERS
/
MapperFeature#AUTO_DETECT_GETTERS
option.public void setFailOnEmptyBeans(boolean failOnEmptyBeans)
SerializationFeature#FAIL_ON_EMPTY_BEANS
option.public void setIndentOutput(boolean indentOutput)
SerializationFeature#INDENT_OUTPUT
option.public void setFeaturesToEnable(java.lang.Object... featuresToEnable)
com.fasterxml.jackson.core.JsonParser.Feature
,
com.fasterxml.jackson.core.JsonGenerator.Feature
,
com.fasterxml.jackson.databind.SerializationFeature
,
com.fasterxml.jackson.databind.DeserializationFeature
,
com.fasterxml.jackson.databind.MapperFeature
public void setFeaturesToDisable(java.lang.Object... featuresToDisable)
com.fasterxml.jackson.core.JsonParser.Feature
,
com.fasterxml.jackson.core.JsonGenerator.Feature
,
com.fasterxml.jackson.databind.SerializationFeature
,
com.fasterxml.jackson.databind.DeserializationFeature
,
com.fasterxml.jackson.databind.MapperFeature
public void afterPropertiesSet()
InitializingBean
This method allows the bean instance to perform initialization only possible when all bean properties have been set and to throw an exception in the event of misconfiguration.
afterPropertiesSet
in interface InitializingBean
private <T> void addSerializers(SimpleModule module)
private <T> void addDeserializers(SimpleModule module)
private void configureFeature(java.lang.Object feature, boolean enabled)
public ObjectMapper getObject()
getObject
in interface FactoryBean<ObjectMapper>
null
)FactoryBeanNotInitializedException
public java.lang.Class<?> getObjectType()
FactoryBean
null
if not known in advance.
This allows one to check for specific types of beans without instantiating objects, for example on autowiring.
In the case of implementations that are creating a singleton object, this method should try to avoid singleton creation as far as possible; it should rather estimate the type in advance. For prototypes, returning a meaningful type here is advisable too.
This method can be called before this FactoryBean has been fully initialized. It must not rely on state created during initialization; of course, it can still use such state if available.
NOTE: Autowiring will simply ignore FactoryBeans that return
null
here. Therefore it is highly recommended to implement
this method properly, using the current state of the FactoryBean.
getObjectType
in interface FactoryBean<ObjectMapper>
null
if not known at the time of the callListableBeanFactory.getBeansOfType(java.lang.Class<T>)
public boolean isSingleton()
FactoryBean
FactoryBean.getObject()
always return the same object
(a reference that can be cached)?
NOTE: If a FactoryBean indicates to hold a singleton object,
the object returned from getObject()
might get cached
by the owning BeanFactory. Hence, do not return true
unless the FactoryBean always exposes the same reference.
The singleton status of the FactoryBean itself will generally be provided by the owning BeanFactory; usually, it has to be defined as singleton there.
NOTE: This method returning false
does not
necessarily indicate that returned objects are independent instances.
An implementation of the extended SmartFactoryBean
interface
may explicitly indicate independent instances through its
SmartFactoryBean.isPrototype()
method. Plain FactoryBean
implementations which do not implement this extended interface are
simply assumed to always return independent instances if the
isSingleton()
implementation returns false
.
isSingleton
in interface FactoryBean<ObjectMapper>
FactoryBean.getObject()
,
SmartFactoryBean.isPrototype()