类 Jackson2ObjectMapperFactoryBean

构造器详细资料

• Jackson2ObjectMapperFactoryBean

  public Jackson2ObjectMapperFactoryBean()

方法详细资料

• setObjectMapper

  public void setObjectMapper​(ObjectMapper objectMapper)

  Set the ObjectMapper instance to use. If not set, the ObjectMapper will be created using its default constructor.

• setCreateXmlMapper

  public void setCreateXmlMapper​(boolean createXmlMapper)

  If set to true and no custom ObjectMapper has been set, a XmlMapper will be created using its default constructor.

  从以下版本开始:

  4.1

• setFactory

  public void setFactory​(JsonFactory factory)

  Define the JsonFactory to be used to create the ObjectMapper instance.

  从以下版本开始:

  5.0

• setDateFormat

  public void setDateFormat​(DateFormat dateFormat)

  Define the format for date/time with the given DateFormat.

  Note: Setting this property makes the exposed ObjectMapper non-thread-safe, according to Jackson's thread safety rules.

  另请参阅:

  setSimpleDateFormat(String)

• setSimpleDateFormat

  public void setSimpleDateFormat​(String format)

  Define the date/time format with a SimpleDateFormat.

  Note: Setting this property makes the exposed ObjectMapper non-thread-safe, according to Jackson's thread safety rules.

  另请参阅:

  setDateFormat(DateFormat)

• setLocale

  public void setLocale​(Locale locale)

  Override the default Locale to use for formatting. Default value used is Locale.getDefault().

  从以下版本开始:

  4.1.5

• setTimeZone

  public void setTimeZone​(TimeZone timeZone)

  Override the default TimeZone to use for formatting. Default value used is UTC (NOT local timezone).

  从以下版本开始:

  4.1.5

• setAnnotationIntrospector

  public void setAnnotationIntrospector​(AnnotationIntrospector annotationIntrospector)

  Set an AnnotationIntrospector for both serialization and deserialization.

• setPropertyNamingStrategy

  public void setPropertyNamingStrategy​(PropertyNamingStrategy propertyNamingStrategy)

  Specify a PropertyNamingStrategy to configure the ObjectMapper with.

  从以下版本开始:

  4.0.2

• setDefaultTyping

  public void setDefaultTyping​(TypeResolverBuilder<?> typeResolverBuilder)

  Specify a TypeResolverBuilder to use for Jackson's default typing.

  从以下版本开始:

  4.2.2

• setSerializationInclusion

  public void setSerializationInclusion​(com.fasterxml.jackson.annotation.JsonInclude.Include serializationInclusion)

  Set a custom inclusion strategy for serialization.

  另请参阅:

  JsonInclude.Include

• setFilters

  public void setFilters​(FilterProvider filters)

  Set the global filters to use in order to support @JsonFilter annotated POJO.

  从以下版本开始:

  4.2

  另请参阅:

  Jackson2ObjectMapperBuilder.filters(FilterProvider)

• setMixIns

  public void setMixIns​(Map<Class<?>,​Class<?>> mixIns)

  Add mix-in annotations to use for augmenting specified class or interface.

  参数:

  mixIns - a Map of entries with target classes (or interface) whose annotations to effectively override as key and mix-in classes (or interface) whose annotations are to be "added" to target's annotations as value.

  从以下版本开始:

  4.1.2

  另请参阅:

  ObjectMapper.addMixInAnnotations(Class, Class)

• setSerializers

  public void setSerializers​(JsonSerializer<?>... serializers)

  Configure custom serializers. Each serializer is registered for the type returned by JsonSerializer.handledType(), which must not be null.

  另请参阅:

  setSerializersByType(Map)

• setSerializersByType

  public void setSerializersByType​(Map<Class<?>,​JsonSerializer<?>> serializers)

  Configure custom serializers for the given types.

  另请参阅:

  setSerializers(JsonSerializer...)

• setDeserializers

  public void setDeserializers​(JsonDeserializer<?>... deserializers)

  Configure custom deserializers. Each deserializer is registered for the type returned by JsonDeserializer.handledType(), which must not be null.

  从以下版本开始:

  4.3

  另请参阅:

  setDeserializersByType(Map)

• setDeserializersByType

  public void setDeserializersByType​(Map<Class<?>,​JsonDeserializer<?>> deserializers)

  Configure custom deserializers for the given types.

• setAutoDetectFields

  public void setAutoDetectFields​(boolean autoDetectFields)

  Shortcut for MapperFeature.AUTO_DETECT_FIELDS option.

• setAutoDetectGettersSetters

  public void setAutoDetectGettersSetters​(boolean autoDetectGettersSetters)

  Shortcut for MapperFeature.AUTO_DETECT_SETTERS/ MapperFeature.AUTO_DETECT_GETTERS/MapperFeature.AUTO_DETECT_IS_GETTERS options.

• setDefaultViewInclusion

  public void setDefaultViewInclusion​(boolean defaultViewInclusion)

  Shortcut for MapperFeature.DEFAULT_VIEW_INCLUSION option.

  从以下版本开始:

  4.1

• setFailOnUnknownProperties

  public void setFailOnUnknownProperties​(boolean failOnUnknownProperties)

  Shortcut for DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES option.

  从以下版本开始:

  4.1.1

• setFailOnEmptyBeans

  public void setFailOnEmptyBeans​(boolean failOnEmptyBeans)

  Shortcut for SerializationFeature.FAIL_ON_EMPTY_BEANS option.

• setIndentOutput

  public void setIndentOutput​(boolean indentOutput)

  Shortcut for SerializationFeature.INDENT_OUTPUT option.

• setDefaultUseWrapper

  public void setDefaultUseWrapper​(boolean defaultUseWrapper)

  Define if a wrapper will be used for indexed (List, array) properties or not by default (only applies to XmlMapper).

  从以下版本开始:

  4.3

• setFeaturesToEnable

  public void setFeaturesToEnable​(Object... featuresToEnable)

  Specify features to enable.

  另请参阅:

  JsonParser.Feature, JsonGenerator.Feature, SerializationFeature, DeserializationFeature, MapperFeature

• setFeaturesToDisable

  public void setFeaturesToDisable​(Object... featuresToDisable)

  Specify features to disable.

  另请参阅:

  JsonParser.Feature, JsonGenerator.Feature, SerializationFeature, DeserializationFeature, MapperFeature

• setModules

  public void setModules​(List<Module> modules)

  Set a complete list of modules to be registered with the ObjectMapper.

  Note: If this is set, no finding of modules is going to happen - not by Jackson, and not by Spring either (see setFindModulesViaServiceLoader(boolean)). As a consequence, specifying an empty list here will suppress any kind of module detection.

  Specify either this or setModulesToInstall(java.lang.Class<? extends com.fasterxml.jackson.databind.Module>...), not both.

  从以下版本开始:

  4.0

  另请参阅:

  Module

• setModulesToInstall

  public void setModulesToInstall​(Class<? extends Module>... modules)

  Specify one or more modules by class (or class name in XML) to be registered with the ObjectMapper.

  Modules specified here will be registered after Spring's autodetection of JSR-310 and Joda-Time, or Jackson's finding of modules (see setFindModulesViaServiceLoader(boolean)), allowing to eventually override their configuration.

  Specify either this or setModules(java.util.List<com.fasterxml.jackson.databind.Module>), not both.

  从以下版本开始:

  4.0.1

  另请参阅:

  Module

• setFindModulesViaServiceLoader

  public void setFindModulesViaServiceLoader​(boolean findModules)

  Set whether to let Jackson find available modules via the JDK ServiceLoader, based on META-INF metadata in the classpath. Requires Jackson 2.2 or higher.

  If this mode is not set, Spring's Jackson2ObjectMapperFactoryBean itself will try to find the JSR-310 and Joda-Time support modules on the classpath - provided that Java 8 and Joda-Time themselves are available, respectively.

  从以下版本开始:

  4.0.1

  另请参阅:

  ObjectMapper.findModules()

• setBeanClassLoader

  public void setBeanClassLoader​(ClassLoader beanClassLoader)

  从接口复制的说明: BeanClassLoaderAware
  Callback that supplies the bean class loader to a bean instance.

  Invoked after the population of normal bean properties but before an initialization callback such as InitializingBean'sInitializingBean.afterPropertiesSet() method or a custom init-method.

  指定者:

  setBeanClassLoader 在接口中 BeanClassLoaderAware

  参数:

  beanClassLoader - the owning class loader

• setHandlerInstantiator

  public void setHandlerInstantiator​(HandlerInstantiator handlerInstantiator)

  Customize the construction of Jackson handlers (JsonSerializer, JsonDeserializer, KeyDeserializer, TypeResolverBuilder and TypeIdResolver).

  从以下版本开始:

  4.1.3

  另请参阅:

  setApplicationContext(ApplicationContext)

• setApplicationContext

  public void setApplicationContext​(ApplicationContext applicationContext)

  Set the builder ApplicationContext in order to autowire Jackson handlers (JsonSerializer, JsonDeserializer, KeyDeserializer, TypeResolverBuilder and TypeIdResolver).

  指定者:

  setApplicationContext 在接口中 ApplicationContextAware

  参数:

  applicationContext - the ApplicationContext object to be used by this object

  从以下版本开始:

  4.1.3

  另请参阅:

  Jackson2ObjectMapperBuilder.applicationContext(ApplicationContext), SpringHandlerInstantiator

• afterPropertiesSet

  public void afterPropertiesSet()

  从接口复制的说明: InitializingBean
  Invoked by the containing BeanFactory after it has set all bean properties and satisfied BeanFactoryAware, ApplicationContextAware etc.

  This method allows the bean instance to perform validation of its overall configuration and final initialization when all bean properties have been set.

  指定者:

  afterPropertiesSet 在接口中 InitializingBean

• getObject

  @Nullable
  public ObjectMapper getObject()

  Return the singleton ObjectMapper.

  指定者:

  getObject 在接口中 FactoryBean<ObjectMapper>

  返回:

  an instance of the bean (can be null)

  另请参阅:

  FactoryBeanNotInitializedException

• getObjectType

  public Class<?> getObjectType()

  从接口复制的说明: FactoryBean
  Return the type of object that this FactoryBean creates, or 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 在接口中 FactoryBean<ObjectMapper>

  返回:

  the type of object that this FactoryBean creates, or null if not known at the time of the call

  另请参阅:

  ListableBeanFactory.getBeansOfType(java.lang.Class<T>)

• isSingleton

  public boolean isSingleton()

  从接口复制的说明: FactoryBean
  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)?

  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.

  The default implementation returns true, since a FactoryBean typically manages a singleton instance.

  指定者:

  isSingleton 在接口中 FactoryBean<ObjectMapper>

  返回:

  whether the exposed object is a singleton

  另请参阅:

  FactoryBean.getObject(), SmartFactoryBean.isPrototype()