public class FreeMarkerView extends AbstractTemplateView
Exposes the following JavaBean properties:
Depends on a single FreeMarkerConfig
object such as FreeMarkerConfigurer
being accessible in the current web application context, with any bean name.
Alternatively, you can set the FreeMarker Configuration
object as a
bean property. See setConfiguration(freemarker.template.Configuration)
for more details on the impacts
of this approach.
Note: Spring's FreeMarker support requires FreeMarker 2.3 or higher.
AbstractUrlBasedView.setUrl(java.lang.String)
,
AbstractTemplateView.setExposeSpringMacroHelpers(boolean)
,
setEncoding(java.lang.String)
,
setConfiguration(freemarker.template.Configuration)
,
FreeMarkerConfig
,
FreeMarkerConfigurer
SPRING_MACRO_REQUEST_CONTEXT_ATTRIBUTE
DEFAULT_CONTENT_TYPE
logger
PATH_VARIABLES, RESPONSE_STATUS_ATTRIBUTE, SELECTED_CONTENT_TYPE
Constructor and Description |
---|
FreeMarkerView() |
Modifier and Type | Method and Description |
---|---|
protected FreeMarkerConfig |
autodetectConfiguration()
Autodetect a
FreeMarkerConfig object via the ApplicationContext. |
protected freemarker.template.SimpleHash |
buildTemplateModel(Map<String,Object> model,
HttpServletRequest request,
HttpServletResponse response)
Build a FreeMarker template model for the given model Map.
|
boolean |
checkResource(Locale locale)
Check that the FreeMarker template used for this view exists and is valid.
|
protected void |
doRender(Map<String,Object> model,
HttpServletRequest request,
HttpServletResponse response)
Render the FreeMarker view to the given response, using the given model
map which contains the complete template model to use.
|
protected void |
exposeHelpers(Map<String,Object> model,
HttpServletRequest request)
Expose helpers unique to each rendering operation.
|
protected freemarker.template.Configuration |
getConfiguration()
Return the FreeMarker configuration used by this view.
|
protected String |
getEncoding()
Return the encoding for the FreeMarker template.
|
protected freemarker.template.ObjectWrapper |
getObjectWrapper()
Return the configured FreeMarker
ObjectWrapper , or the
default wrapper if none specified. |
protected freemarker.template.Template |
getTemplate(Locale locale)
Retrieve the FreeMarker template for the given locale,
to be rendering by this view.
|
protected freemarker.template.Template |
getTemplate(String name,
Locale locale)
Retrieve the FreeMarker template specified by the given name,
using the encoding specified by the "encoding" bean property.
|
protected void |
initServletContext(ServletContext servletContext)
Invoked on startup.
|
protected freemarker.template.Configuration |
obtainConfiguration()
Obtain the FreeMarker configuration for actual use.
|
protected void |
processTemplate(freemarker.template.Template template,
freemarker.template.SimpleHash model,
HttpServletResponse response)
Process the FreeMarker template to the servlet response.
|
protected void |
renderMergedTemplateModel(Map<String,Object> model,
HttpServletRequest request,
HttpServletResponse response)
Process the model map by merging it with the FreeMarker template.
|
void |
setConfiguration(freemarker.template.Configuration configuration)
Set the FreeMarker Configuration to be used by this view.
|
void |
setEncoding(String encoding)
Set the encoding of the FreeMarker template file.
|
applyContentType, renderMergedOutputModel, setAllowRequestOverride, setAllowSessionOverride, setExposeRequestAttributes, setExposeSessionAttributes, setExposeSpringMacroHelpers
afterPropertiesSet, getUrl, isUrlRequired, setUrl, toString
addStaticAttribute, createMergedOutputModel, createRequestContext, createTemporaryOutputStream, exposeModelAsRequestAttributes, formatViewName, generatesDownloadContent, getAttributesMap, getBeanName, getContentType, getRequestContextAttribute, getRequestToExpose, getStaticAttributes, isExposePathVariables, prepareResponse, render, setAttributes, setAttributesCSV, setAttributesMap, setBeanName, setContentType, setExposeContextBeansAsAttributes, setExposedContextBeanNames, setExposePathVariables, setRequestContextAttribute, setResponseContentType, writeToResponse
getServletContext, getTempDir, getWebApplicationContext, initApplicationContext, isContextRequired, setServletContext
getApplicationContext, getMessageSourceAccessor, initApplicationContext, obtainApplicationContext, requiredContextClass, setApplicationContext
public void setEncoding(@Nullable String encoding)
Specify the encoding in the FreeMarker Configuration rather than per template if all your templates share a common encoding.
@Nullable protected String getEncoding()
public void setConfiguration(@Nullable freemarker.template.Configuration configuration)
If this is not set, the default lookup will occur: a single FreeMarkerConfig
is expected in the current web application context, with any bean name.
Note: using this method will cause a new instance of TaglibFactory
to created for every single FreeMarkerView
instance. This can be quite expensive
in terms of memory and initial CPU usage. In production it is recommended that you use
a FreeMarkerConfig
which exposes a single shared TaglibFactory
.
@Nullable protected freemarker.template.Configuration getConfiguration()
protected freemarker.template.Configuration obtainConfiguration()
null
)IllegalStateException
- in case of no Configuration object setprotected void initServletContext(ServletContext servletContext) throws BeansException
Checks that the template for the default Locale can be found: FreeMarker will check non-Locale-specific templates if a locale-specific one is not found.
initServletContext
in class WebApplicationObjectSupport
servletContext
- the ServletContext that this application object runs in
(never null
)BeansException
TemplateCache.getTemplate(java.lang.String, java.util.Locale, java.lang.Object, java.lang.String, boolean)
protected FreeMarkerConfig autodetectConfiguration() throws BeansException
FreeMarkerConfig
object via the ApplicationContext.BeansException
- if no Configuration instance could be foundApplicationObjectSupport.getApplicationContext()
,
setConfiguration(freemarker.template.Configuration)
protected freemarker.template.ObjectWrapper getObjectWrapper()
ObjectWrapper
, or the
default wrapper
if none specified.Configurable.getObjectWrapper()
public boolean checkResource(Locale locale) throws Exception
Can be overridden to customize the behavior, for example in case of multiple templates to be rendered into a single view.
checkResource
in class AbstractUrlBasedView
locale
- the desired Locale that we're looking fortrue
if the resource exists (or is assumed to exist);
false
if we know that it does not existException
- if the resource exists but is invalid (e.g. could not be parsed)protected void renderMergedTemplateModel(Map<String,Object> model, HttpServletRequest request, HttpServletResponse response) throws Exception
This method can be overridden if custom behavior is needed.
renderMergedTemplateModel
in class AbstractTemplateView
model
- combined output Map, with request attributes and
session attributes merged into it if requiredrequest
- current HTTP requestresponse
- current HTTP responseException
- if rendering failedprotected void exposeHelpers(Map<String,Object> model, HttpServletRequest request) throws Exception
Called by renderMergedTemplateModel
. The default implementation
is empty. This method can be overridden to add custom helpers to the model.
model
- the model that will be passed to the template at merge timerequest
- current HTTP requestException
- if there's a fatal error while we're adding information to the contextrenderMergedTemplateModel(java.util.Map<java.lang.String, java.lang.Object>, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)
protected void doRender(Map<String,Object> model, HttpServletRequest request, HttpServletResponse response) throws Exception
The default implementation renders the template specified by the "url"
bean property, retrieved via getTemplate
. It delegates to the
processTemplate
method to merge the template instance with
the given template model.
Adds the standard Freemarker hash models to the model: request parameters, request, session and application (ServletContext), as well as the JSP tag library hash model.
Can be overridden to customize the behavior, for example to render multiple templates into a single view.
model
- the model to use for renderingrequest
- current HTTP requestresponse
- current servlet responseIOException
- if the template file could not be retrievedException
- if rendering failedAbstractUrlBasedView.setUrl(java.lang.String)
,
RequestContextUtils.getLocale(javax.servlet.http.HttpServletRequest)
,
getTemplate(java.util.Locale)
,
processTemplate(freemarker.template.Template, freemarker.template.SimpleHash, javax.servlet.http.HttpServletResponse)
,
FreemarkerServlet
protected freemarker.template.SimpleHash buildTemplateModel(Map<String,Object> model, HttpServletRequest request, HttpServletResponse response)
The default implementation builds a AllHttpScopesHashModel
.
model
- the model to use for renderingrequest
- current HTTP requestresponse
- current servlet responseSimpleHash
or subclass thereofprotected freemarker.template.Template getTemplate(Locale locale) throws IOException
By default, the template specified by the "url" bean property will be retrieved.
locale
- the current localeIOException
- if the template file could not be retrievedAbstractUrlBasedView.setUrl(java.lang.String)
,
getTemplate(String, java.util.Locale)
protected freemarker.template.Template getTemplate(String name, Locale locale) throws IOException
Can be called by subclasses to retrieve a specific template, for example to render multiple templates into a single view.
name
- the file name of the desired templatelocale
- the current localeIOException
- if the template file could not be retrievedprotected void processTemplate(freemarker.template.Template template, freemarker.template.SimpleHash model, HttpServletResponse response) throws IOException, freemarker.template.TemplateException
Can be overridden to customize the behavior.
template
- the template to processmodel
- the model for the templateresponse
- servlet response (use this to get the OutputStream or Writer)IOException
- if the template file could not be retrievedfreemarker.template.TemplateException
- if thrown by FreeMarkerTemplate.process(Object, java.io.Writer)