类 AbstractView
- java.lang.Object
- org.springframework.context.support.ApplicationObjectSupport
- org.springframework.web.context.support.WebApplicationObjectSupport
- org.springframework.web.servlet.view.AbstractView
- 所有已实现的接口:
Aware
,BeanNameAware
,ApplicationContextAware
,ServletContextAware
,View
- 直接已知子类:
AbstractFeedView
,AbstractJackson2View
,AbstractPdfView
,AbstractUrlBasedView
,AbstractXlsView
,MarshallingView
public abstract class AbstractView extends WebApplicationObjectSupport implements View, BeanNameAware
Abstract base class forView
implementations. Subclasses should be JavaBeans, to allow for convenient configuration as Spring-managed bean instances.Provides support for static attributes, to be made available to the view, with a variety of ways to specify them. Static attributes will be merged with the given dynamic attributes (the model that the controller returned) for each render operation.
Extends
WebApplicationObjectSupport
, which will be helpful to some views. Subclasses just need to implement the actual rendering.
字段概要
字段 修饰符和类型 字段 说明 static String
DEFAULT_CONTENT_TYPE
Default content type.从类继承的字段 org.springframework.context.support.ApplicationObjectSupport
logger
从接口继承的字段 org.springframework.web.servlet.View
PATH_VARIABLES, RESPONSE_STATUS_ATTRIBUTE, SELECTED_CONTENT_TYPE
构造器概要
构造器 构造器 说明 AbstractView()
方法概要
所有方法 实例方法 抽象方法 具体方法 修饰符和类型 方法 说明 void
addStaticAttribute(String name, Object value)
Add static data to this view, exposed in each view.protected Map<String,Object>
createMergedOutputModel(Map<String,?> model, HttpServletRequest request, HttpServletResponse response)
Creates a combined output Map (nevernull
) that includes dynamic values and static attributes.protected RequestContext
createRequestContext(HttpServletRequest request, HttpServletResponse response, Map<String,Object> model)
Create a RequestContext to expose under the specified attribute name.protected ByteArrayOutputStream
createTemporaryOutputStream()
Create a temporary OutputStream for this view.protected void
exposeModelAsRequestAttributes(Map<String,Object> model, HttpServletRequest request)
Expose the model objects in the given map as request attributes.protected String
formatViewName()
protected boolean
generatesDownloadContent()
Return whether this view generates download content (typically binary content like PDF or Excel files).Map<String,Object>
getAttributesMap()
Allow Map access to the static attributes of this view, with the option to add or override specific entries.String
getBeanName()
Return the view's name.String
getContentType()
Return the content type for this view.String
getRequestContextAttribute()
Return the name of the RequestContext attribute, if any.protected HttpServletRequest
getRequestToExpose(HttpServletRequest originalRequest)
Get the request handle to expose torenderMergedOutputModel(java.util.Map<java.lang.String, java.lang.Object>, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)
, i.e. to the view.Map<String,Object>
getStaticAttributes()
Return the static attributes for this view.boolean
isExposePathVariables()
Return whether to add path variables to the model or not.protected void
prepareResponse(HttpServletRequest request, HttpServletResponse response)
Prepare the given response for rendering.void
render(Map<String,?> model, HttpServletRequest request, HttpServletResponse response)
Prepares the view given the specified model, merging it with static attributes and a RequestContext attribute, if necessary.protected abstract void
renderMergedOutputModel(Map<String,Object> model, HttpServletRequest request, HttpServletResponse response)
Subclasses must implement this method to actually render the view.void
setAttributes(Properties attributes)
Set static attributes for this view from ajava.util.Properties
object.void
setAttributesCSV(String propString)
Set static attributes as a CSV string.void
setAttributesMap(Map<String,?> attributes)
Set static attributes for this view from a Map.void
setBeanName(String beanName)
Set the view's name.void
setContentType(String contentType)
Set the content type for this view.void
setExposeContextBeansAsAttributes(boolean exposeContextBeansAsAttributes)
Set whether to make all Spring beans in the application context accessible as request attributes, through lazy checking once an attribute gets accessed.void
setExposedContextBeanNames(String... exposedContextBeanNames)
Specify the names of beans in the context which are supposed to be exposed.void
setExposePathVariables(boolean exposePathVariables)
Specify whether to add path variables to the model or not.void
setRequestContextAttribute(String requestContextAttribute)
Set the name of the RequestContext attribute for this view.protected void
setResponseContentType(HttpServletRequest request, HttpServletResponse response)
Set the content type of the response to the configuredcontent type
unless theView.SELECTED_CONTENT_TYPE
request attribute is present and set to a concrete media type.String
toString()
protected void
writeToResponse(HttpServletResponse response, ByteArrayOutputStream baos)
Write the given temporary OutputStream to the HTTP response.从类继承的方法 org.springframework.web.context.support.WebApplicationObjectSupport
getServletContext, getTempDir, getWebApplicationContext, initApplicationContext, initServletContext, isContextRequired, setServletContext
从类继承的方法 org.springframework.context.support.ApplicationObjectSupport
getApplicationContext, getMessageSourceAccessor, initApplicationContext, obtainApplicationContext, requiredContextClass, setApplicationContext
字段详细资料
DEFAULT_CONTENT_TYPE
public static final String DEFAULT_CONTENT_TYPE
Default content type. Overridable as bean property.- 另请参阅:
- 常量字段值
构造器详细资料
AbstractView
public AbstractView()
方法详细资料
setContentType
public void setContentType(@Nullable String contentType)
Set the content type for this view. Default is "text/html;charset=ISO-8859-1".May be ignored by subclasses if the view itself is assumed to set the content type, e.g. in case of JSPs.
getContentType
@Nullable public String getContentType()
Return the content type for this view.- 指定者:
getContentType
在接口中View
- 返回:
- the content type String (optionally including a character set), or
null
if not predetermined
setRequestContextAttribute
public void setRequestContextAttribute(@Nullable String requestContextAttribute)
Set the name of the RequestContext attribute for this view. Default is none.
getRequestContextAttribute
@Nullable public String getRequestContextAttribute()
Return the name of the RequestContext attribute, if any.
setAttributesCSV
public void setAttributesCSV(@Nullable String propString) throws IllegalArgumentException
Set static attributes as a CSV string. Format is: attname0={value1},attname1={value1}"Static" attributes are fixed attributes that are specified in the View instance configuration. "Dynamic" attributes, on the other hand, are values passed in as part of the model.
setAttributes
public void setAttributes(Properties attributes)
Set static attributes for this view from ajava.util.Properties
object."Static" attributes are fixed attributes that are specified in the View instance configuration. "Dynamic" attributes, on the other hand, are values passed in as part of the model.
This is the most convenient way to set static attributes. Note that static attributes can be overridden by dynamic attributes, if a value with the same name is included in the model.
Can be populated with a String "value" (parsed via PropertiesEditor) or a "props" element in XML bean definitions.
- 另请参阅:
PropertiesEditor
setAttributesMap
public void setAttributesMap(@Nullable Map<String,?> attributes)
Set static attributes for this view from a Map. This allows to set any kind of attribute values, for example bean references."Static" attributes are fixed attributes that are specified in the View instance configuration. "Dynamic" attributes, on the other hand, are values passed in as part of the model.
Can be populated with a "map" or "props" element in XML bean definitions.
- 参数:
attributes
- a Map with name Strings as keys and attribute objects as values
getAttributesMap
public Map<String,Object> getAttributesMap()
Allow Map access to the static attributes of this view, with the option to add or override specific entries.Useful for specifying entries directly, for example via "attributesMap[myKey]". This is particularly useful for adding or overriding entries in child view definitions.
addStaticAttribute
public void addStaticAttribute(String name, Object value)
Add static data to this view, exposed in each view."Static" attributes are fixed attributes that are specified in the View instance configuration. "Dynamic" attributes, on the other hand, are values passed in as part of the model.
Must be invoked before any calls to
render
.- 参数:
name
- the name of the attribute to exposevalue
- the attribute value to expose- 另请参阅:
render(java.util.Map<java.lang.String, ?>, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)
getStaticAttributes
public Map<String,Object> getStaticAttributes()
Return the static attributes for this view. Handy for testing.Returns an unmodifiable Map, as this is not intended for manipulating the Map but rather just for checking the contents.
- 返回:
- the static attributes in this view
setExposePathVariables
public void setExposePathVariables(boolean exposePathVariables)
Specify whether to add path variables to the model or not.Path variables are commonly bound to URI template variables through the
@PathVariable
annotation. They're are effectively URI template variables with type conversion applied to them to derive typed Object values. Such values are frequently needed in views for constructing links to the same and other URLs.Path variables added to the model override static attributes (see
setAttributes(Properties)
) but not attributes already present in the model.By default this flag is set to
true
. Concrete view types can override this.- 参数:
exposePathVariables
-true
to expose path variables, andfalse
otherwise
isExposePathVariables
public boolean isExposePathVariables()
Return whether to add path variables to the model or not.
setExposeContextBeansAsAttributes
public void setExposeContextBeansAsAttributes(boolean exposeContextBeansAsAttributes)
Set whether to make all Spring beans in the application context accessible as request attributes, through lazy checking once an attribute gets accessed.This will make all such beans accessible in plain
${...}
expressions in a JSP 2.0 page, as well as in JSTL'sc:out
value expressions.Default is "false". Switch this flag on to transparently expose all Spring beans in the request attribute namespace.
NOTE: Context beans will override any custom request or session attributes of the same name that have been manually added. However, model attributes (as explicitly exposed to this view) of the same name will always override context beans.
setExposedContextBeanNames
public void setExposedContextBeanNames(String... exposedContextBeanNames)
Specify the names of beans in the context which are supposed to be exposed. If this is non-null, only the specified beans are eligible for exposure as attributes.If you'd like to expose all Spring beans in the application context, switch the
"exposeContextBeansAsAttributes"
flag on but do not list specific bean names for this property.
setBeanName
public void setBeanName(@Nullable String beanName)
Set the view's name. Helpful for traceability.Framework code must call this when constructing views.
- 指定者:
setBeanName
在接口中BeanNameAware
- 参数:
beanName
- the name of the bean in the factory. Note that this name is the actual bean name used in the factory, which may differ from the originally specified name: in particular for inner bean names, the actual bean name might have been made unique through appending "#..." suffixes. Use theBeanFactoryUtils.originalBeanName(String)
method to extract the original bean name (without suffix), if desired.
getBeanName
@Nullable public String getBeanName()
Return the view's name. Should never benull
, if the view was correctly configured.
render
public void render(@Nullable Map<String,?> model, HttpServletRequest request, HttpServletResponse response) throws Exception
Prepares the view given the specified model, merging it with static attributes and a RequestContext attribute, if necessary. Delegates to renderMergedOutputModel for the actual rendering.- 指定者:
render
在接口中View
- 参数:
model
- a Map with name Strings as keys and corresponding model objects as values (Map can also benull
in case of empty model)request
- current HTTP requestresponse
- he HTTP response we are building- 抛出:
Exception
- if rendering failed- 另请参阅:
renderMergedOutputModel(java.util.Map<java.lang.String, java.lang.Object>, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)
createMergedOutputModel
protected Map<String,Object> createMergedOutputModel(@Nullable Map<String,?> model, HttpServletRequest request, HttpServletResponse response)
Creates a combined output Map (nevernull
) that includes dynamic values and static attributes. Dynamic values take precedence over static attributes.
createRequestContext
protected RequestContext createRequestContext(HttpServletRequest request, HttpServletResponse response, Map<String,Object> model)
Create a RequestContext to expose under the specified attribute name.The default implementation creates a standard RequestContext instance for the given request and model. Can be overridden in subclasses for custom instances.
- 参数:
request
- current HTTP requestmodel
- combined output Map (nevernull
), with dynamic values taking precedence over static attributes- 返回:
- the RequestContext instance
- 另请参阅:
setRequestContextAttribute(java.lang.String)
,RequestContext
prepareResponse
protected void prepareResponse(HttpServletRequest request, HttpServletResponse response)
Prepare the given response for rendering.The default implementation applies a workaround for an IE bug when sending download content via HTTPS.
- 参数:
request
- current HTTP requestresponse
- current HTTP response
generatesDownloadContent
protected boolean generatesDownloadContent()
Return whether this view generates download content (typically binary content like PDF or Excel files).The default implementation returns
false
. Subclasses are encouraged to returntrue
here if they know that they are generating download content that requires temporary caching on the client side, typically via the response OutputStream.
getRequestToExpose
protected HttpServletRequest getRequestToExpose(HttpServletRequest originalRequest)
Get the request handle to expose torenderMergedOutputModel(java.util.Map<java.lang.String, java.lang.Object>, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)
, i.e. to the view.The default implementation wraps the original request for exposure of Spring beans as request attributes (if demanded).
- 参数:
originalRequest
- the original servlet request as provided by the engine- 返回:
- the wrapped request, or the original request if no wrapping is necessary
- 另请参阅:
setExposeContextBeansAsAttributes(boolean)
,setExposedContextBeanNames(java.lang.String...)
,ContextExposingHttpServletRequest
renderMergedOutputModel
protected abstract void renderMergedOutputModel(Map<String,Object> model, HttpServletRequest request, HttpServletResponse response) throws Exception
Subclasses must implement this method to actually render the view.The first step will be preparing the request: In the JSP case, this would mean setting model objects as request attributes. The second step will be the actual rendering of the view, for example including the JSP via a RequestDispatcher.
- 参数:
model
- combined output Map (nevernull
), with dynamic values taking precedence over static attributesrequest
- current HTTP requestresponse
- current HTTP response- 抛出:
Exception
- if rendering failed
exposeModelAsRequestAttributes
protected void exposeModelAsRequestAttributes(Map<String,Object> model, HttpServletRequest request) throws Exception
Expose the model objects in the given map as request attributes. Names will be taken from the model Map. This method is suitable for all resources reachable byRequestDispatcher
.- 参数:
model
- a Map of model objects to exposerequest
- current HTTP request- 抛出:
Exception
createTemporaryOutputStream
protected ByteArrayOutputStream createTemporaryOutputStream()
Create a temporary OutputStream for this view.This is typically used as IE workaround, for setting the content length header from the temporary stream before actually writing the content to the HTTP response.
writeToResponse
protected void writeToResponse(HttpServletResponse response, ByteArrayOutputStream baos) throws IOException
Write the given temporary OutputStream to the HTTP response.- 参数:
response
- current HTTP responsebaos
- the temporary OutputStream to write- 抛出:
IOException
- if writing/flushing failed
setResponseContentType
protected void setResponseContentType(HttpServletRequest request, HttpServletResponse response)
Set the content type of the response to the configuredcontent type
unless theView.SELECTED_CONTENT_TYPE
request attribute is present and set to a concrete media type.
formatViewName
protected String formatViewName()