类 ScriptFactoryPostProcessor
- java.lang.Object
- org.springframework.beans.factory.config.InstantiationAwareBeanPostProcessorAdapter
- org.springframework.scripting.support.ScriptFactoryPostProcessor
- 所有已实现的接口:
Aware
,BeanClassLoaderAware
,BeanFactoryAware
,BeanPostProcessor
,InstantiationAwareBeanPostProcessor
,SmartInstantiationAwareBeanPostProcessor
,DisposableBean
,ResourceLoaderAware
,Ordered
public class ScriptFactoryPostProcessor extends InstantiationAwareBeanPostProcessorAdapter implements BeanClassLoaderAware, BeanFactoryAware, ResourceLoaderAware, DisposableBean, Ordered
BeanPostProcessor
that handlesScriptFactory
definitions, replacing each factory with the actual scripted Java object generated by it.This is similar to the
FactoryBean
mechanism, but is specifically tailored for scripts and not built into Spring's core container itself but rather implemented as an extension.NOTE: The most important characteristic of this post-processor is that constructor arguments are applied to the
ScriptFactory
instance while bean property values are applied to the generated scripted object. Typically, constructor arguments include a script source locator and potentially script interfaces, while bean property values include references and config values to inject into the scripted object itself.The following
ScriptFactoryPostProcessor
will automatically be applied to the twoScriptFactory
definitions below. At runtime, the actual scripted objects will be exposed for "bshMessenger" and "groovyMessenger", rather than theScriptFactory
instances. Both of those are supposed to be castable to the example'sMessenger
interfaces here.<bean class="org.springframework.scripting.support.ScriptFactoryPostProcessor"/> <bean id="bshMessenger" class="org.springframework.scripting.bsh.BshScriptFactory"> <constructor-arg value="classpath:mypackage/Messenger.bsh"/> <constructor-arg value="mypackage.Messenger"/> <property name="message" value="Hello World!"/> </bean> <bean id="groovyMessenger" class="org.springframework.scripting.groovy.GroovyScriptFactory"> <constructor-arg value="classpath:mypackage/Messenger.groovy"/> <property name="message" value="Hello World!"/> </bean>
NOTE: Please note that the above excerpt from a Spring XML bean definition file uses just the <bean/>-style syntax (in an effort to illustrate using the
ScriptFactoryPostProcessor
itself). In reality, you would never create a <bean/> definition for aScriptFactoryPostProcessor
explicitly; rather you would import the tags from the'lang'
namespace and simply create scripted beans using the tags in that namespace... as part of doing so, aScriptFactoryPostProcessor
will implicitly be created for you.The Spring reference documentation contains numerous examples of using tags in the
'lang'
namespace; by way of an example, find below a Groovy-backed bean defined using the'lang:groovy'
tag.<?xml version="1.0" encoding="UTF-8"?> <beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:lang="http://www.springframework.org/schema/lang"> <!-- this is the bean definition for the Groovy-backed Messenger implementation --> <lang:groovy id="messenger" script-source="classpath:Messenger.groovy"> <lang:property name="message" value="I Can Do The Frug" /> </lang:groovy> <!-- an otherwise normal bean that will be injected by the Groovy-backed Messenger --> <bean id="bookingService" class="x.y.DefaultBookingService"> <property name="messenger" ref="messenger" /> </bean> </beans>
- 从以下版本开始:
- 2.0
- 作者:
- Juergen Hoeller, Rob Harrop, Rick Evans, Mark Fisher
字段概要
字段 修饰符和类型 字段 说明 static String
INLINE_SCRIPT_PREFIX
TheResource
-style prefix that denotes an inline script.static String
LANGUAGE_ATTRIBUTE
protected Log
logger
Logger available to subclassesstatic String
PROXY_TARGET_CLASS_ATTRIBUTE
static String
REFRESH_CHECK_DELAY_ATTRIBUTE
从接口继承的字段 org.springframework.core.Ordered
HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE
构造器概要
构造器 构造器 说明 ScriptFactoryPostProcessor()
方法概要
所有方法 实例方法 具体方法 修饰符和类型 方法 说明 protected ScriptSource
convertToScriptSource(String beanName, String scriptSourceLocator, ResourceLoader resourceLoader)
Convert the given script source locator to a ScriptSource instance.protected Class<?>
createCompositeInterface(Class<?>[] interfaces)
Create a composite interface Class for the given interfaces, implementing the given interfaces in one single Class.protected Class<?>
createConfigInterface(BeanDefinition bd, Class<?>[] interfaces)
Create a config interface for the given bean definition, defining setter methods for the defined property values as well as an init method and a destroy method (if defined).protected Object
createRefreshableProxy(TargetSource ts, Class<?>[] interfaces, boolean proxyTargetClass)
Create a refreshable proxy for the given AOP TargetSource.protected BeanDefinition
createScriptedObjectBeanDefinition(BeanDefinition bd, String scriptFactoryBeanName, ScriptSource scriptSource, Class<?>[] interfaces)
Create a bean definition for the scripted object, based on the given script definition, extracting the definition data that is relevant for the scripted object (that is, everything but bean class and constructor arguments).protected BeanDefinition
createScriptFactoryBeanDefinition(BeanDefinition bd)
Create a ScriptFactory bean definition based on the given script definition, extracting only the definition data that is relevant for the ScriptFactory (that is, only bean class and constructor arguments).void
destroy()
Destroy the inner bean factory (used for scripts) on shutdown.int
getOrder()
Get the order value of this object.protected ScriptSource
getScriptSource(String beanName, String scriptSourceLocator)
Obtain a ScriptSource for the given bean, lazily creating it if not cached already.Object
postProcessBeforeInstantiation(Class<?> beanClass, String beanName)
Apply this BeanPostProcessor before the target bean gets instantiated.Class<?>
predictBeanType(Class<?> beanClass, String beanName)
Predict the type of the bean to be eventually returned from this processor'sInstantiationAwareBeanPostProcessor.postProcessBeforeInstantiation(java.lang.Class<?>, java.lang.String)
callback.protected void
prepareScriptBeans(BeanDefinition bd, String scriptFactoryBeanName, String scriptedObjectBeanName)
Prepare the script beans in the internal BeanFactory that this post-processor uses.protected boolean
resolveProxyTargetClass(BeanDefinition beanDefinition)
protected long
resolveRefreshCheckDelay(BeanDefinition beanDefinition)
Get the refresh check delay for the givenScriptFactory
BeanDefinition
.void
setBeanClassLoader(ClassLoader classLoader)
Callback that supplies the beanclass loader
to a bean instance.void
setBeanFactory(BeanFactory beanFactory)
Callback that supplies the owning factory to a bean instance.void
setDefaultProxyTargetClass(boolean defaultProxyTargetClass)
Flag to signal that refreshable proxies should be created to proxy the target class not its interfaces.void
setDefaultRefreshCheckDelay(long defaultRefreshCheckDelay)
Set the delay between refresh checks, in milliseconds.void
setResourceLoader(ResourceLoader resourceLoader)
Set the ResourceLoader that this object runs in.从类继承的方法 org.springframework.beans.factory.config.InstantiationAwareBeanPostProcessorAdapter
determineCandidateConstructors, getEarlyBeanReference, postProcessAfterInitialization, postProcessAfterInstantiation, postProcessBeforeInitialization, postProcessPropertyValues
字段详细资料
INLINE_SCRIPT_PREFIX
public static final String INLINE_SCRIPT_PREFIX
TheResource
-style prefix that denotes an inline script.An inline script is a script that is defined right there in the (typically XML) configuration, as opposed to being defined in an external file.
- 另请参阅:
- 常量字段值
REFRESH_CHECK_DELAY_ATTRIBUTE
public static final String REFRESH_CHECK_DELAY_ATTRIBUTE
PROXY_TARGET_CLASS_ATTRIBUTE
public static final String PROXY_TARGET_CLASS_ATTRIBUTE
LANGUAGE_ATTRIBUTE
public static final String LANGUAGE_ATTRIBUTE
构造器详细资料
ScriptFactoryPostProcessor
public ScriptFactoryPostProcessor()
方法详细资料
setDefaultRefreshCheckDelay
public void setDefaultRefreshCheckDelay(long defaultRefreshCheckDelay)
Set the delay between refresh checks, in milliseconds. Default is -1, indicating no refresh checks at all.Note that an actual refresh will only happen when the
ScriptSource
indicates that it has been modified.
setDefaultProxyTargetClass
public void setDefaultProxyTargetClass(boolean defaultProxyTargetClass)
Flag to signal that refreshable proxies should be created to proxy the target class not its interfaces.- 参数:
defaultProxyTargetClass
- the flag value to set
setBeanClassLoader
public void setBeanClassLoader(ClassLoader classLoader)
从接口复制的说明:BeanClassLoaderAware
Callback that supplies the beanclass loader
to a bean instance.Invoked after the population of normal bean properties but before an initialization callback such as
InitializingBean's
InitializingBean.afterPropertiesSet()
method or a custom init-method.- 指定者:
setBeanClassLoader
在接口中BeanClassLoaderAware
- 参数:
classLoader
- the owning class loader; may benull
in which case a defaultClassLoader
must be used, for example theClassLoader
obtained viaClassUtils.getDefaultClassLoader()
setBeanFactory
public void setBeanFactory(BeanFactory beanFactory)
从接口复制的说明:BeanFactoryAware
Callback that supplies the owning factory to a bean instance.Invoked after the population of normal bean properties but before an initialization callback such as
InitializingBean.afterPropertiesSet()
or a custom init-method.- 指定者:
setBeanFactory
在接口中BeanFactoryAware
- 参数:
beanFactory
- owning BeanFactory (nevernull
). The bean can immediately call methods on the factory.- 另请参阅:
BeanInitializationException
setResourceLoader
public void setResourceLoader(ResourceLoader resourceLoader)
从接口复制的说明:ResourceLoaderAware
Set the ResourceLoader that this object runs in.This might be a ResourcePatternResolver, which can be checked through
instanceof ResourcePatternResolver
. See also theResourcePatternUtils.getResourcePatternResolver
method.Invoked after population of normal bean properties but before an init callback like InitializingBean's
afterPropertiesSet
or a custom init-method. Invoked before ApplicationContextAware'ssetApplicationContext
.- 指定者:
setResourceLoader
在接口中ResourceLoaderAware
- 参数:
resourceLoader
- the ResourceLoader object to be used by this object- 另请参阅:
ResourcePatternResolver
,ResourcePatternUtils.getResourcePatternResolver(org.springframework.core.io.ResourceLoader)
getOrder
public int getOrder()
从接口复制的说明:Ordered
Get the order value of this object.Higher values are interpreted as lower priority. As a consequence, the object with the lowest value has the highest priority (somewhat analogous to Servlet
load-on-startup
values).Same order values will result in arbitrary sort positions for the affected objects.
- 指定者:
getOrder
在接口中Ordered
- 返回:
- the order value
- 另请参阅:
Ordered.HIGHEST_PRECEDENCE
,Ordered.LOWEST_PRECEDENCE
predictBeanType
public Class<?> predictBeanType(Class<?> beanClass, String beanName)
从接口复制的说明:SmartInstantiationAwareBeanPostProcessor
Predict the type of the bean to be eventually returned from this processor'sInstantiationAwareBeanPostProcessor.postProcessBeforeInstantiation(java.lang.Class<?>, java.lang.String)
callback.- 指定者:
predictBeanType
在接口中SmartInstantiationAwareBeanPostProcessor
- 覆盖:
predictBeanType
在类中InstantiationAwareBeanPostProcessorAdapter
- 参数:
beanClass
- the raw class of the beanbeanName
- the name of the bean- 返回:
- the type of the bean, or
null
if not predictable
postProcessBeforeInstantiation
public Object postProcessBeforeInstantiation(Class<?> beanClass, String beanName)
从接口复制的说明:InstantiationAwareBeanPostProcessor
Apply this BeanPostProcessor before the target bean gets instantiated. The returned bean object may be a proxy to use instead of the target bean, effectively suppressing default instantiation of the target bean.If a non-null object is returned by this method, the bean creation process will be short-circuited. The only further processing applied is the
BeanPostProcessor.postProcessAfterInitialization(java.lang.Object, java.lang.String)
callback from the configuredBeanPostProcessors
.This callback will be applied to bean definitions with their bean class, as well as to factory-method definitions in which case the returned bean type will be passed in here.
Post-processors may implement the extended
SmartInstantiationAwareBeanPostProcessor
interface in order to predict the type of the bean object that they are going to return here.- 指定者:
postProcessBeforeInstantiation
在接口中InstantiationAwareBeanPostProcessor
- 覆盖:
postProcessBeforeInstantiation
在类中InstantiationAwareBeanPostProcessorAdapter
- 参数:
beanClass
- the class of the bean to be instantiatedbeanName
- the name of the bean- 返回:
- the bean object to expose instead of a default instance of the target bean, or
null
to proceed with default instantiation - 另请参阅:
InstantiationAwareBeanPostProcessor.postProcessAfterInstantiation(java.lang.Object, java.lang.String)
,AbstractBeanDefinition.getBeanClass()
,AbstractBeanDefinition.getFactoryMethodName()
prepareScriptBeans
protected void prepareScriptBeans(BeanDefinition bd, String scriptFactoryBeanName, String scriptedObjectBeanName)
Prepare the script beans in the internal BeanFactory that this post-processor uses. Each original bean definition will be split into a ScriptFactory definition and a scripted object definition.- 参数:
bd
- the original bean definition in the main BeanFactoryscriptFactoryBeanName
- the name of the internal ScriptFactory beanscriptedObjectBeanName
- the name of the internal scripted object bean
resolveRefreshCheckDelay
protected long resolveRefreshCheckDelay(BeanDefinition beanDefinition)
Get the refresh check delay for the givenScriptFactory
BeanDefinition
. If theBeanDefinition
has ametadata attribute
under the keyREFRESH_CHECK_DELAY_ATTRIBUTE
which is a validNumber
type, then this value is used. Otherwise, thedefaultRefreshCheckDelay
value is used.- 参数:
beanDefinition
- the BeanDefinition to check- 返回:
- the refresh check delay
resolveProxyTargetClass
protected boolean resolveProxyTargetClass(BeanDefinition beanDefinition)
createScriptFactoryBeanDefinition
protected BeanDefinition createScriptFactoryBeanDefinition(BeanDefinition bd)
Create a ScriptFactory bean definition based on the given script definition, extracting only the definition data that is relevant for the ScriptFactory (that is, only bean class and constructor arguments).- 参数:
bd
- the full script bean definition- 返回:
- the extracted ScriptFactory bean definition
- 另请参阅:
ScriptFactory
getScriptSource
protected ScriptSource getScriptSource(String beanName, String scriptSourceLocator)
Obtain a ScriptSource for the given bean, lazily creating it if not cached already.- 参数:
beanName
- the name of the scripted beanscriptSourceLocator
- the script source locator associated with the bean- 返回:
- the corresponding ScriptSource instance
- 另请参阅:
convertToScriptSource(java.lang.String, java.lang.String, org.springframework.core.io.ResourceLoader)
convertToScriptSource
protected ScriptSource convertToScriptSource(String beanName, String scriptSourceLocator, ResourceLoader resourceLoader)
Convert the given script source locator to a ScriptSource instance.By default, supported locators are Spring resource locations (such as "file:C:/myScript.bsh" or "classpath:myPackage/myScript.bsh") and inline scripts ("inline:myScriptText...").
- 参数:
beanName
- the name of the scripted beanscriptSourceLocator
- the script source locatorresourceLoader
- the ResourceLoader to use (if necessary)- 返回:
- the ScriptSource instance
createConfigInterface
protected Class<?> createConfigInterface(BeanDefinition bd, Class<?>[] interfaces)
Create a config interface for the given bean definition, defining setter methods for the defined property values as well as an init method and a destroy method (if defined).This implementation creates the interface via CGLIB's InterfaceMaker, determining the property types from the given interfaces (as far as possible).
- 参数:
bd
- the bean definition (property values etc) to create a config interface forinterfaces
- the interfaces to check against (might define getters corresponding to the setters we're supposed to generate)- 返回:
- the config interface
- 另请参阅:
InterfaceMaker
,BeanUtils.findPropertyType(java.lang.String, java.lang.Class<?>...)
createCompositeInterface
protected Class<?> createCompositeInterface(Class<?>[] interfaces)
Create a composite interface Class for the given interfaces, implementing the given interfaces in one single Class.The default implementation builds a JDK proxy class for the given interfaces.
- 参数:
interfaces
- the interfaces to merge- 返回:
- the merged interface as Class
- 另请参阅:
Proxy.getProxyClass(java.lang.ClassLoader, java.lang.Class<?>...)
createScriptedObjectBeanDefinition
protected BeanDefinition createScriptedObjectBeanDefinition(BeanDefinition bd, String scriptFactoryBeanName, ScriptSource scriptSource, Class<?>[] interfaces)
Create a bean definition for the scripted object, based on the given script definition, extracting the definition data that is relevant for the scripted object (that is, everything but bean class and constructor arguments).- 参数:
bd
- the full script bean definitionscriptFactoryBeanName
- the name of the internal ScriptFactory beanscriptSource
- the ScriptSource for the scripted beaninterfaces
- the interfaces that the scripted bean is supposed to implement- 返回:
- the extracted ScriptFactory bean definition
- 另请参阅:
ScriptFactory.getScriptedObject(org.springframework.scripting.ScriptSource, java.lang.Class<?>...)
createRefreshableProxy
protected Object createRefreshableProxy(TargetSource ts, Class<?>[] interfaces, boolean proxyTargetClass)
Create a refreshable proxy for the given AOP TargetSource.- 参数:
ts
- the refreshable TargetSourceinterfaces
- the proxy interfaces (may benull
to indicate proxying of all interfaces implemented by the target class)- 返回:
- the generated proxy
- 另请参阅:
RefreshableScriptTargetSource
destroy
public void destroy()
Destroy the inner bean factory (used for scripts) on shutdown.- 指定者:
destroy
在接口中DisposableBean