类 VelocityConfigurer
- java.lang.Object
- org.springframework.ui.velocity.VelocityEngineFactory
- org.springframework.web.servlet.view.velocity.VelocityConfigurer
@Deprecated public class VelocityConfigurer extends VelocityEngineFactory implements VelocityConfig, InitializingBean, ResourceLoaderAware, ServletContextAware
已过时。as of Spring 4.3, in favor of FreeMarkerJavaBean to configure Velocity for web usage, via the "configLocation" and/or "velocityProperties" and/or "resourceLoaderPath" bean properties. The simplest way to use this class is to specify just a "resourceLoaderPath"; you do not need any further configuration then.<bean id="velocityConfig" class="org.springframework.web.servlet.view.velocity.VelocityConfigurer"> <property name="resourceLoaderPath"><value>/WEB-INF/velocity/</value></property> </bean>
This bean must be included in the application context of any application using Spring'sVelocityView
for web MVC. It exists purely to configure Velocity; it is not meant to be referenced by application components (just internally by VelocityView). This class implementsVelocityConfig
in order to be found by VelocityView without depending on the bean name of this configurer. Each DispatcherServlet may define its own VelocityConfigurer if desired, potentially with different template loader paths.Note that you can also refer to a pre-configured VelocityEngine instance via the "velocityEngine" property, e.g. set up by
VelocityEngineFactoryBean
, This allows to share a VelocityEngine for web and email usage, for example.This configurer registers the "spring.vm" Velocimacro library for web views (contained in this package and thus in
spring.jar
), which makes all of Spring's default Velocity macros available to the views. This allows for using the Spring-provided macros such as follows:#springBind("person.age") age is ${status.value}
- 作者:
- Rod Johnson, Juergen Hoeller, Darren Davison
- 另请参阅:
VelocityEngineFactory.setConfigLocation(org.springframework.core.io.Resource)
,VelocityEngineFactory.setVelocityProperties(java.util.Properties)
,VelocityEngineFactory.setResourceLoaderPath(java.lang.String)
,setVelocityEngine(org.apache.velocity.app.VelocityEngine)
,VelocityView
字段概要
从类继承的字段 org.springframework.ui.velocity.VelocityEngineFactory
logger
构造器概要
构造器 构造器 说明 VelocityConfigurer()
已过时。
方法概要
所有方法 实例方法 具体方法 已过时的方法 修饰符和类型 方法 说明 void
afterPropertiesSet()
已过时。Initialize VelocityEngineFactory's VelocityEngine if not overridden by a pre-configured VelocityEngine.org.apache.velocity.app.VelocityEngine
getVelocityEngine()
已过时。Return the VelocityEngine for the current web application context.protected void
postProcessVelocityEngine(org.apache.velocity.app.VelocityEngine velocityEngine)
已过时。Provides a ClasspathResourceLoader in addition to any default or user-defined loader in order to load the spring Velocity macros from the class path.void
setServletContext(ServletContext servletContext)
已过时。Set theServletContext
that this object runs in.void
setVelocityEngine(org.apache.velocity.app.VelocityEngine velocityEngine)
已过时。Set a pre-configured VelocityEngine to use for the Velocity web configuration: e.g. a shared one for web and email usage, set up viaVelocityEngineFactoryBean
.从类继承的方法 org.springframework.ui.velocity.VelocityEngineFactory
createVelocityEngine, getResourceLoader, initSpringResourceLoader, initVelocityResourceLoader, isPreferFileSystemAccess, newVelocityEngine, setConfigLocation, setOverrideLogging, setPreferFileSystemAccess, setResourceLoader, setResourceLoaderPath, setVelocityProperties, setVelocityPropertiesMap
从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
从接口继承的方法 org.springframework.context.ResourceLoaderAware
setResourceLoader
构造器详细资料
VelocityConfigurer
public VelocityConfigurer()
已过时。
方法详细资料
setVelocityEngine
public void setVelocityEngine(org.apache.velocity.app.VelocityEngine velocityEngine)
已过时。Set a pre-configured VelocityEngine to use for the Velocity web configuration: e.g. a shared one for web and email usage, set up viaVelocityEngineFactoryBean
.Note that the Spring macros will not be enabled automatically in case of an external VelocityEngine passed in here. Make sure to include
spring.vm
in your template loader path in such a scenario (if there is an actual need to use those macros).If this is not set, VelocityEngineFactory's properties (inherited by this class) have to be specified.
setServletContext
public void setServletContext(ServletContext servletContext)
已过时。从接口复制的说明:ServletContextAware
Set theServletContext
that this object runs in.Invoked after population of normal bean properties but before an init callback like InitializingBean's
afterPropertiesSet
or a custom init-method. Invoked after ApplicationContextAware'ssetApplicationContext
.- 指定者:
setServletContext
在接口中ServletContextAware
- 参数:
servletContext
- ServletContext object to be used by this object- 另请参阅:
InitializingBean.afterPropertiesSet()
,ApplicationContextAware.setApplicationContext(org.springframework.context.ApplicationContext)
afterPropertiesSet
public void afterPropertiesSet() throws IOException, org.apache.velocity.exception.VelocityException
已过时。Initialize VelocityEngineFactory's VelocityEngine if not overridden by a pre-configured VelocityEngine.- 指定者:
afterPropertiesSet
在接口中InitializingBean
- 抛出:
IOException
org.apache.velocity.exception.VelocityException
- 另请参阅:
VelocityEngineFactory.createVelocityEngine()
,setVelocityEngine(org.apache.velocity.app.VelocityEngine)
postProcessVelocityEngine
protected void postProcessVelocityEngine(org.apache.velocity.app.VelocityEngine velocityEngine)
已过时。Provides a ClasspathResourceLoader in addition to any default or user-defined loader in order to load the spring Velocity macros from the class path.- 覆盖:
postProcessVelocityEngine
在类中VelocityEngineFactory
- 参数:
velocityEngine
- the current VelocityEngine- 另请参阅:
ClasspathResourceLoader
getVelocityEngine
public org.apache.velocity.app.VelocityEngine getVelocityEngine()
已过时。从接口复制的说明:VelocityConfig
Return the VelocityEngine for the current web application context. May be unique to one servlet, or shared in the root context.- 指定者:
getVelocityEngine
在接口中VelocityConfig
- 返回:
- the VelocityEngine