接口 FactoryBean<T>
- 类型参数:
T
- the bean type
- 所有已知子接口:
SmartFactoryBean<T>
- 所有已知实现类:
AbstractEntityManagerFactoryBean
,AbstractFactoryBean
,AbstractServiceLoaderBasedFactoryBean
,AbstractSingletonProxyFactoryBean
,CacheProxyFactoryBean
,ConcurrentMapCacheFactoryBean
,ConnectorServerFactoryBean
,ContentNegotiationManagerFactoryBean
,ConversionServiceFactoryBean
,CronTriggerFactoryBean
,DateTimeFormatterFactoryBean
,DateTimeFormatterFactoryBean
,EhCacheFactoryBean
,EhCacheManagerFactoryBean
,EmbeddedDatabaseFactoryBean
,FieldRetrievingFactoryBean
,ForkJoinPoolFactoryBean
,FormattingConversionServiceFactoryBean
,FreeMarkerConfigurationFactoryBean
,GsonFactoryBean
,HessianProxyFactoryBean
,HibernateJpaSessionFactoryBean
,HttpInvokerProxyFactoryBean
,Jackson2ObjectMapperFactoryBean
,JaxWsPortProxyFactoryBean
,JCacheManagerFactoryBean
,JmsInvokerProxyFactoryBean
,JndiObjectFactoryBean
,JndiRmiProxyFactoryBean
,JobDetailFactoryBean
,JtaTransactionManagerFactoryBean
,ListFactoryBean
,LocalConnectionFactoryBean
,LocalContainerEntityManagerFactoryBean
,LocalEntityManagerFactoryBean
,LocalJaxWsServiceFactoryBean
,LocalSessionFactoryBean
,LocalStatelessSessionProxyFactoryBean
,MapFactoryBean
,MBeanProxyFactoryBean
,MBeanServerConnectionFactoryBean
,MBeanServerFactoryBean
,MethodInvokingFactoryBean
,MethodInvokingJobDetailFactoryBean
,MethodLocatingFactoryBean
,ObjectFactoryCreatingFactoryBean
,PropertiesFactoryBean
,PropertyPathFactoryBean
,ProviderCreatingFactoryBean
,ProxyFactoryBean
,ProxyFactoryBean
,ResourceAdapterFactoryBean
,RmiProxyFactoryBean
,RmiRegistryFactoryBean
,ScheduledExecutorFactoryBean
,SchedulerFactoryBean
,ScopedProxyFactoryBean
,ServiceFactoryBean
,ServiceListFactoryBean
,ServiceLoaderFactoryBean
,ServiceLocatorFactoryBean
,ServletContextAttributeFactoryBean
,ServletContextParameterFactoryBean
,ServletServerContainerFactoryBean
,SetFactoryBean
,SharedEntityManagerBean
,SimpleHttpServerFactoryBean
,SimpleRemoteStatelessSessionProxyFactoryBean
,SimpleTriggerFactoryBean
,SortedResourcesFactoryBean
,TaskExecutorFactoryBean
,ThreadPoolExecutorFactoryBean
,TimerManagerFactoryBean
,TransactionProxyFactoryBean
,WebSocketContainerFactoryBean
,WebSphereMBeanServerFactoryBean
,YamlMapFactoryBean
,YamlPropertiesFactoryBean
public interface FactoryBean<T>
Interface to be implemented by objects used within aBeanFactory
which are themselves factories for individual objects. If a bean implements this interface, it is used as a factory for an object to expose, not directly as a bean instance that will be exposed itself.NB: A bean that implements this interface cannot be used as a normal bean. A FactoryBean is defined in a bean style, but the object exposed for bean references (
getObject()
) is always the object that it creates.FactoryBeans can support singletons and prototypes, and can either create objects lazily on demand or eagerly on startup. The
SmartFactoryBean
interface allows for exposing more fine-grained behavioral metadata.This interface is heavily used within the framework itself, for example for the AOP
ProxyFactoryBean
or theJndiObjectFactoryBean
. It can be used for custom components as well; however, this is only common for infrastructure code.FactoryBean
is a programmatic contract. Implementations are not supposed to rely on annotation-driven injection or other reflective facilities.getObjectType()
getObject()
invocations may arrive early in the bootstrap process, even ahead of any post-processor setup. If you need access to other beans, implementBeanFactoryAware
and obtain them programmatically.The container is only responsible for managing the lifecycle of the FactoryBean instance, not the lifecycle of the objects created by the FactoryBean. Therefore, a destroy method on an exposed bean object (such as
Closeable.close()
will not be called automatically. Instead, a FactoryBean should implementDisposableBean
and delegate any such close call to the underlying object.Finally, FactoryBean objects participate in the containing BeanFactory's synchronization of bean creation. There is usually no need for internal synchronization other than for purposes of lazy initialization within the FactoryBean itself (or the like).
- 从以下版本开始:
- 08.03.2003
- 作者:
- Rod Johnson, Juergen Hoeller
- 另请参阅:
BeanFactory
,ProxyFactoryBean
,JndiObjectFactoryBean
字段概要
字段 修饰符和类型 字段 说明 static String
OBJECT_TYPE_ATTRIBUTE
The name of an attribute that can beset
on aBeanDefinition
so that factory beans can signal their object type when it can't be deduced from the factory bean class.
方法概要
所有方法 实例方法 抽象方法 默认方法 修饰符和类型 方法 说明 T
getObject()
Return an instance (possibly shared or independent) of the object managed by this factory.Class<?>
getObjectType()
Return the type of object that this FactoryBean creates, ornull
if not known in advance.default boolean
isSingleton()
Is the object managed by this factory a singleton?
字段详细资料
OBJECT_TYPE_ATTRIBUTE
static final String OBJECT_TYPE_ATTRIBUTE
The name of an attribute that can beset
on aBeanDefinition
so that factory beans can signal their object type when it can't be deduced from the factory bean class.- 从以下版本开始:
- 5.2
- 另请参阅:
- 常量字段值
方法详细资料
getObject
@Nullable T getObject() throws Exception
Return an instance (possibly shared or independent) of the object managed by this factory.As with a
BeanFactory
, this allows support for both the Singleton and Prototype design pattern.If this FactoryBean is not fully initialized yet at the time of the call (for example because it is involved in a circular reference), throw a corresponding
FactoryBeanNotInitializedException
.As of Spring 2.0, FactoryBeans are allowed to return
null
objects. The factory will consider this as normal value to be used; it will not throw a FactoryBeanNotInitializedException in this case anymore. FactoryBean implementations are encouraged to throw FactoryBeanNotInitializedException themselves now, as appropriate.- 返回:
- an instance of the bean (can be
null
) - 抛出:
Exception
- in case of creation errors- 另请参阅:
FactoryBeanNotInitializedException
getObjectType
@Nullable Class<?> getObjectType()
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.- 返回:
- 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
default boolean isSingleton()
Is the object managed by this factory a singleton? That is, willgetObject()
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
.The default implementation returns
true
, since aFactoryBean
typically manages a singleton instance.- 返回:
- whether the exposed object is a singleton
- 另请参阅:
getObject()
,SmartFactoryBean.isPrototype()