Class FreeMarkerView
- All Implemented Interfaces:
Aware
,BeanNameAware
,InitializingBean
,ApplicationContextAware
,ServletContextAware
,View
Exposes the following configuration properties:
url
: the location of the FreeMarker template relative to the FreeMarker template context (directory).encoding
: the encoding used to decode byte sequences to character sequences when reading the FreeMarker template file. Default is determined by the FreeMarkerConfiguration
.contentType
: the content type of the rendered response. Defaults to"text/html;charset=ISO-8859-1"
but should typically be set to a value that corresponds to the actual generated content type (see note below).
Depends on a single FreeMarkerConfig
object such as
FreeMarkerConfigurer
being accessible in the current web application
context. Alternatively the FreeMarker Configuration
can be set directly
via setConfiguration(freemarker.template.Configuration)
.
Note: To ensure that the correct encoding is used when rendering the
response, set the content type with an
appropriate charset
attribute — for example,
"text/html;charset=UTF-8"
. When using FreeMarkerViewResolver
to create the view for you, set the
content type
directly in the FreeMarkerViewResolver
.
Note: Spring's FreeMarker support requires FreeMarker 2.3.21 or higher. As of Spring Framework 6.0, FreeMarker templates are rendered in a minimal fashion without JSP support, just exposing request attributes in addition to the MVC-provided model map for alignment with common Servlet resources.
- Since:
- 03.03.2004
- Author:
- Darren Davison, Juergen Hoeller, Sam Brannen
- See Also:
-
Field Summary
Fields inherited from class org.springframework.web.servlet.view.AbstractTemplateView
SPRING_MACRO_REQUEST_CONTEXT_ATTRIBUTE
Fields inherited from class org.springframework.web.servlet.view.AbstractView
DEFAULT_CONTENT_TYPE
Fields inherited from class org.springframework.context.support.ApplicationObjectSupport
logger
Fields inherited from interface org.springframework.web.servlet.View
PATH_VARIABLES, RESPONSE_STATUS_ATTRIBUTE, SELECTED_CONTENT_TYPE
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionprotected FreeMarkerConfig
Autodetect aFreeMarkerConfig
object via theApplicationContext
.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
Return the FreeMarkerConfiguration
used by this view.protected String
Get the encoding used to decode byte sequences to character sequences when reading the FreeMarker template file for this view, ornull
to signal that the FreeMarkerConfiguration
should be used to determine the encoding.protected freemarker.template.ObjectWrapper
Return the configured FreeMarkerObjectWrapper
, or the default wrapper if none specified.protected freemarker.template.Template
getTemplate
(String name, Locale locale) Retrieve the FreeMarkerTemplate
for the specified name and locale, using the configured encoding if set.protected freemarker.template.Template
getTemplate
(Locale locale) Retrieve the FreeMarkerTemplate
for the given locale, to be rendered by this view.protected void
initServletContext
(ServletContext servletContext) Invoked on startup.protected freemarker.template.Configuration
Obtain the FreeMarkerConfiguration
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 FreeMarkerConfiguration
to be used by this view.void
setEncoding
(String encoding) Set the encoding used to decode byte sequences to character sequences when reading the FreeMarker template file for this view.Methods inherited from class org.springframework.web.servlet.view.AbstractTemplateView
applyContentType, renderMergedOutputModel, setAllowRequestOverride, setAllowSessionOverride, setExposeRequestAttributes, setExposeSessionAttributes, setExposeSpringMacroHelpers
Methods inherited from class org.springframework.web.servlet.view.AbstractUrlBasedView
afterPropertiesSet, getUrl, isUrlRequired, setUrl, toString
Methods inherited from class org.springframework.web.servlet.view.AbstractView
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
Methods inherited from class org.springframework.web.context.support.WebApplicationObjectSupport
getServletContext, getTempDir, getWebApplicationContext, initApplicationContext, isContextRequired, setServletContext
Methods inherited from class org.springframework.context.support.ApplicationObjectSupport
getApplicationContext, getMessageSourceAccessor, initApplicationContext, obtainApplicationContext, requiredContextClass, setApplicationContext
-
Constructor Details
-
FreeMarkerView
public FreeMarkerView()
-
-
Method Details
-
setEncoding
Set the encoding used to decode byte sequences to character sequences when reading the FreeMarker template file for this view.Defaults to
null
to signal that the FreeMarkerConfiguration
should be used to determine the encoding.A non-null encoding will override the default encoding determined by the FreeMarker
Configuration
.If the encoding is not explicitly set here or in the FreeMarker
Configuration
, FreeMarker will read template files using the platform file encoding (defined by the JVM system propertyfile.encoding
) or"utf-8"
if the platform file encoding is undefined.It's recommended to specify the encoding in the FreeMarker
Configuration
rather than per template if all your templates share a common encoding.Note that the specified or default encoding is not used for template rendering. Instead, an explicit encoding must be specified for the rendering process. See the note in the class-level documentation for details.
- See Also:
-
Configuration.setDefaultEncoding(java.lang.String)
getEncoding()
AbstractView.setContentType(String)
-
getEncoding
Get the encoding used to decode byte sequences to character sequences when reading the FreeMarker template file for this view, ornull
to signal that the FreeMarkerConfiguration
should be used to determine the encoding.- See Also:
-
setConfiguration
Set the FreeMarkerConfiguration
to be used by this view.If not set, the default lookup will occur: a single
FreeMarkerConfig
is expected in the current web application context, with any bean name. -
getConfiguration
Return the FreeMarkerConfiguration
used by this view. -
obtainConfiguration
protected freemarker.template.Configuration obtainConfiguration()Obtain the FreeMarkerConfiguration
for actual use.- Returns:
- the FreeMarker configuration (never
null
) - Throws:
IllegalStateException
- in case of no Configuration object set- Since:
- 5.0
-
initServletContext
Invoked on startup. Looks for a singleFreeMarkerConfig
bean to find the relevantConfiguration
for this view.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.
- Overrides:
initServletContext
in classWebApplicationObjectSupport
- Parameters:
servletContext
- the ServletContext that this application object runs in (nevernull
)- Throws:
BeansException
- See Also:
-
TemplateCache.getTemplate(java.lang.String, java.util.Locale, java.lang.Object, java.lang.String, boolean)
-
autodetectConfiguration
Autodetect aFreeMarkerConfig
object via theApplicationContext
.- Returns:
- the
FreeMarkerConfig
instance to use for FreeMarkerViews - Throws:
BeansException
- if noFreeMarkerConfig
bean could be found- See Also:
-
getObjectWrapper
protected freemarker.template.ObjectWrapper getObjectWrapper()Return the configured FreeMarkerObjectWrapper
, or the default wrapper if none specified.- See Also:
-
Configurable.getObjectWrapper()
-
checkResource
Check that the FreeMarker template used for this view exists and is valid.Can be overridden to customize the behavior, for example in case of multiple templates to be rendered into a single view.
- Overrides:
checkResource
in classAbstractUrlBasedView
- Parameters:
locale
- the desired Locale that we're looking for- Returns:
true
if the resource exists (or is assumed to exist);false
if we know that it does not exist- Throws:
Exception
- if the resource exists but is invalid (e.g. could not be parsed)
-
renderMergedTemplateModel
protected void renderMergedTemplateModel(Map<String, Object> model, HttpServletRequest request, HttpServletResponse response) throws ExceptionProcess the model map by merging it with the FreeMarker template.Output is directed to the servlet response.
This method can be overridden if custom behavior is needed.
- Specified by:
renderMergedTemplateModel
in classAbstractTemplateView
- Parameters:
model
- combined output Map, with request attributes and session attributes merged into it if requiredrequest
- current HTTP requestresponse
- current HTTP response- Throws:
Exception
- if rendering failed
-
exposeHelpers
Expose helpers unique to each rendering operation. This is necessary so that different rendering operations can't overwrite each other's formats etc.Called by
renderMergedTemplateModel
. The default implementation is empty. This method can be overridden to add custom helpers to the model.- Parameters:
model
- the model that will be passed to the template at merge timerequest
- current HTTP request- Throws:
Exception
- if there's a fatal error while we're adding information to the context- See Also:
-
doRender
protected void doRender(Map<String, Object> model, HttpServletRequest request, HttpServletResponse response) throws ExceptionRender the FreeMarker view to the given response, using the given model map which contains the complete template model to use.The default implementation renders the template specified by the "url" bean property, retrieved via
getTemplate
. It delegates to theprocessTemplate
method to merge the template instance with the given template model.Can be overridden to customize the behavior, for example to render multiple templates into a single view.
- Parameters:
model
- the model to use for renderingrequest
- current HTTP requestresponse
- current servlet response- Throws:
IOException
- if the template file could not be retrievedException
- if rendering failed- See Also:
-
buildTemplateModel
protected freemarker.template.SimpleHash buildTemplateModel(Map<String, Object> model, HttpServletRequest request, HttpServletResponse response) Build a FreeMarker template model for the given model Map.The default implementation builds a
SimpleHash
for the given MVC model with an additional fallback to request attributes.- Parameters:
model
- the model to use for renderingrequest
- current HTTP requestresponse
- current servlet response- Returns:
- the FreeMarker template model, as a
SimpleHash
or subclass thereof
-
getTemplate
Retrieve the FreeMarkerTemplate
for the given locale, to be rendered by this view.By default, the template specified by the "url" bean property will be retrieved.
- Parameters:
locale
- the current locale- Returns:
- the FreeMarker
Template
to render - Throws:
IOException
- if the template file could not be retrieved- See Also:
-
getTemplate
Retrieve the FreeMarkerTemplate
for the specified name and locale, using the configured encoding if set.Can be called by subclasses to retrieve a specific template, for example to render multiple templates into a single view.
- Parameters:
name
- the file name of the desired templatelocale
- the current locale- Returns:
- the FreeMarker template
- Throws:
IOException
- if the template file could not be retrieved- See Also:
-
processTemplate
protected void processTemplate(freemarker.template.Template template, freemarker.template.SimpleHash model, HttpServletResponse response) throws IOException, freemarker.template.TemplateException Process the FreeMarker template to the servlet response.Can be overridden to customize the behavior.
- Parameters:
template
- the template to processmodel
- the model for the templateresponse
- servlet response (use this to get the OutputStream or Writer)- Throws:
IOException
- if the template file could not be retrievedfreemarker.template.TemplateException
- if thrown by FreeMarker- See Also:
-
Template.process(Object, java.io.Writer)
-