类 GsonFactoryBean
- java.lang.Object
- org.springframework.http.converter.json.GsonFactoryBean
- 所有已实现的接口:
FactoryBean<com.google.gson.Gson>
,InitializingBean
public class GsonFactoryBean extends Object implements FactoryBean<com.google.gson.Gson>, InitializingBean
AFactoryBean
for creating a Google Gson 2.xGson
instance.- 从以下版本开始:
- 4.1
- 作者:
- Roy Clarkson, Juergen Hoeller
构造器概要
构造器 构造器 说明 GsonFactoryBean()
方法概要
所有方法 实例方法 具体方法 修饰符和类型 方法 说明 void
afterPropertiesSet()
Invoked by the containingBeanFactory
after it has set all bean properties and satisfiedBeanFactoryAware
,ApplicationContextAware
etc.com.google.gson.Gson
getObject()
Return the created Gson instance.Class<?>
getObjectType()
Return the type of object that this FactoryBean creates, ornull
if not known in advance.boolean
isSingleton()
Is the object managed by this factory a singleton?void
setBase64EncodeByteArrays(boolean base64EncodeByteArrays)
Whether to Base64-encodebyte[]
properties when reading and writing JSON.void
setDateFormatPattern(String dateFormatPattern)
Define the date/time format with aSimpleDateFormat
-style pattern.void
setDisableHtmlEscaping(boolean disableHtmlEscaping)
Whether to use theGsonBuilder.disableHtmlEscaping()
when writing JSON.void
setPrettyPrinting(boolean prettyPrinting)
Whether to use theGsonBuilder.setPrettyPrinting()
when writing JSON.void
setSerializeNulls(boolean serializeNulls)
Whether to use theGsonBuilder.serializeNulls()
option when writing JSON.
构造器详细资料
GsonFactoryBean
public GsonFactoryBean()
方法详细资料
setBase64EncodeByteArrays
public void setBase64EncodeByteArrays(boolean base64EncodeByteArrays)
Whether to Base64-encodebyte[]
properties when reading and writing JSON.When set to
true
, a customTypeAdapter
will be registered viaGsonBuilder.registerTypeHierarchyAdapter(Class, Object)
which serializes abyte[]
property to and from a Base64-encoded String instead of a JSON array.NOTE: Use of this option requires the presence of the Apache Commons Codec library on the classpath when running on Java 6 or 7. On Java 8, the standard
Base64
facility is used instead.
setSerializeNulls
public void setSerializeNulls(boolean serializeNulls)
Whether to use theGsonBuilder.serializeNulls()
option when writing JSON. This is a shortcut for setting up aGson
as follows:new GsonBuilder().serializeNulls().create();
setPrettyPrinting
public void setPrettyPrinting(boolean prettyPrinting)
Whether to use theGsonBuilder.setPrettyPrinting()
when writing JSON. This is a shortcut for setting up aGson
as follows:new GsonBuilder().setPrettyPrinting().create();
setDisableHtmlEscaping
public void setDisableHtmlEscaping(boolean disableHtmlEscaping)
Whether to use theGsonBuilder.disableHtmlEscaping()
when writing JSON. Set totrue
to disable HTML escaping in JSON. This is a shortcut for setting up aGson
as follows:new GsonBuilder().disableHtmlEscaping().create();
setDateFormatPattern
public void setDateFormatPattern(String dateFormatPattern)
Define the date/time format with aSimpleDateFormat
-style pattern. This is a shortcut for setting up aGson
as follows:new GsonBuilder().setDateFormat(dateFormatPattern).create();
afterPropertiesSet
public void afterPropertiesSet()
从接口复制的说明:InitializingBean
Invoked by the containingBeanFactory
after it has set all bean properties and satisfiedBeanFactoryAware
,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
public com.google.gson.Gson getObject()
Return the created Gson instance.- 指定者:
getObject
在接口中FactoryBean<com.google.gson.Gson>
- 返回:
- an instance of the bean (can be
null
) - 另请参阅:
FactoryBeanNotInitializedException
getObjectType
public Class<?> getObjectType()
从接口复制的说明:FactoryBean
Return the type of object that this FactoryBean creates, ornull
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<com.google.gson.Gson>
- 返回:
- 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, willFactoryBean.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 returntrue
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 extendedSmartFactoryBean
interface may explicitly indicate independent instances through itsSmartFactoryBean.isPrototype()
method. PlainFactoryBean
implementations which do not implement this extended interface are simply assumed to always return independent instances if theisSingleton()
implementation returnsfalse
.- 指定者:
isSingleton
在接口中FactoryBean<com.google.gson.Gson>
- 返回:
- whether the exposed object is a singleton
- 另请参阅:
FactoryBean.getObject()
,SmartFactoryBean.isPrototype()