程序包 cn.taketoday.web.servlet.view

类 InternalResourceView

java.lang.Object

cn.taketoday.context.support.ApplicationObjectSupport

cn.taketoday.web.view.AbstractView

cn.taketoday.web.view.AbstractUrlBasedView

cn.taketoday.web.servlet.view.InternalResourceView

所有已实现的接口:

cn.taketoday.beans.factory.Aware, cn.taketoday.beans.factory.BeanNameAware, cn.taketoday.beans.factory.InitializingBean, cn.taketoday.context.ApplicationContextAware, ServletContextAware, View

直接已知子类:

JstlView

public class InternalResourceView
extends AbstractUrlBasedView
implements ServletContextAware

Wrapper for a JSP or other resource within the same web application. Exposes model objects as request attributes and forwards the request to the specified resource URL using a RequestDispatcher.

A URL for this view is supposed to specify a resource within the web application, suitable for RequestDispatcher's forward or include method.

If operating within an already included request or within a response that has already been committed, this view will fall back to an include instead of a forward. This can be enforced by calling response.flushBuffer() (which will commit the response) before rendering the view.

Typical usage with InternalResourceViewResolver looks as follows, from the perspective of the DispatcherServlet context definition:

<bean id="viewResolver" class="cn.taketoday.web.servlet.view.InternalResourceViewResolver">
   <property name="prefix" value="/WEB-INF/jsp/"/>
   <property name="suffix" value=".jsp"/>
 </bean>

Every view name returned from a handler will be translated to a JSP resource (for example: "myView" → "/WEB-INF/jsp/myView.jsp"), using this view class by default.

从以下版本开始:

4.0

作者:

Rod Johnson, Juergen Hoeller, Rob Harrop

另请参阅:

• RequestDispatcher.forward(jakarta.servlet.ServletRequest, jakarta.servlet.ServletResponse)
• RequestDispatcher.include(jakarta.servlet.ServletRequest, jakarta.servlet.ServletResponse)
• ServletResponse.flushBuffer()
• InternalResourceViewResolver
• JstlView

字段概要

字段

修饰符和类型	字段	说明
private boolean	alwaysInclude
private boolean	preventDispatchLoop
private ServletContext	servletContext

从类继承的字段 cn.taketoday.web.view.AbstractView

DEFAULT_CONTENT_TYPE

从类继承的字段 cn.taketoday.context.support.ApplicationObjectSupport

applicationContext, log, messageSourceAccessor

从接口继承的字段 cn.taketoday.web.view.View

RESPONSE_STATUS_ATTRIBUTE, SELECTED_CONTENT_TYPE

构造器概要

构造器

构造器	说明
InternalResourceView()	Constructor for use as a bean.
InternalResourceView(String url)	Create a new InternalResourceView with the given URL.
InternalResourceView(String url, boolean alwaysInclude)	Create a new InternalResourceView with the given URL.

方法概要

修饰符和类型	方法	说明
protected void	exposeHelpers(HttpServletRequest servletRequest, RequestContext request)	Expose helpers unique to each rendering operation.
protected RequestDispatcher	getRequestDispatcher(HttpServletRequest request, String path)	Obtain the RequestDispatcher to use for the forward/include.
ServletContext	getServletContext()
protected void	initServletContext(ServletContext servletContext)
protected boolean	isContextRequired()	An ApplicationContext is not strictly required for InternalResourceView.
protected String	prepareForRendering(HttpServletRequest request, HttpServletResponse response)	Prepare for rendering, and determine the request dispatcher path to forward to (or to include).
protected void	renderMergedOutputModel(Map<String,Object> model, RequestContext request)	Render the internal resource given the specified model.
void	setAlwaysInclude(boolean alwaysInclude)	Specify whether to always include the view rather than forward to it.
void	setPreventDispatchLoop(boolean preventDispatchLoop)	Set whether to explicitly prevent dispatching back to the current handler path.
final void	setServletContext(ServletContext servletContext)	Set the ServletContext that this object runs in.
protected boolean	useInclude(HttpServletRequest request, HttpServletResponse response)	Determine whether to use RequestDispatcher's include or forward method.

从类继承的方法 cn.taketoday.web.view.AbstractUrlBasedView

afterPropertiesSet, checkResource, getUrl, isUrlRequired, setUrl, toString

从类继承的方法 cn.taketoday.web.view.AbstractView

addStaticAttribute, createMergedOutputModel, createTemporaryOutputStream, exposeModelAsRequestAttributes, formatViewName, generatesDownloadContent, getAttributesMap, getBeanName, getContentType, getRequestContextAttribute, getRequestContextToExpose, getStaticAttributes, isExposePathVariables, prepareResponse, render, setAttributes, setAttributesCSV, setAttributesMap, setBeanName, setContentType, setExposeContextBeansAsAttributes, setExposedContextBeanNames, setExposeOutputRedirectModel, setExposePathVariables, setRequestContextAttribute, setResponseContentType, writeToResponse

从类继承的方法 cn.taketoday.context.support.ApplicationObjectSupport

getApplicationContext, getMessageSourceAccessor, initApplicationContext, initApplicationContext, obtainApplicationContext, requiredContextClass, setApplicationContext, unwrapContext, unwrapFactory

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

字段详细资料

servletContext

@Nullable
private ServletContext servletContext

alwaysInclude

private boolean alwaysInclude

preventDispatchLoop

private boolean preventDispatchLoop

构造器详细资料

InternalResourceView

public InternalResourceView()

Constructor for use as a bean.

另请参阅:

• AbstractUrlBasedView.setUrl(java.lang.String)
• setAlwaysInclude(boolean)

InternalResourceView

public InternalResourceView(String url)

Create a new InternalResourceView with the given URL.

参数:

url - the URL to forward to

另请参阅:

• setAlwaysInclude(boolean)

InternalResourceView

public InternalResourceView(String url,
 boolean alwaysInclude)

Create a new InternalResourceView with the given URL.

参数:

url - the URL to forward to

alwaysInclude - whether to always include the view rather than forward to it

方法详细资料

setAlwaysInclude

public void setAlwaysInclude(boolean alwaysInclude)

Specify whether to always include the view rather than forward to it.

Default is "false". Switch this flag on to enforce the use of a Servlet include, even if a forward would be possible.

另请参阅:

• RequestDispatcher.forward(jakarta.servlet.ServletRequest, jakarta.servlet.ServletResponse)
• RequestDispatcher.include(jakarta.servlet.ServletRequest, jakarta.servlet.ServletResponse)
• useInclude(HttpServletRequest, HttpServletResponse)

setPreventDispatchLoop

public void setPreventDispatchLoop(boolean preventDispatchLoop)

Set whether to explicitly prevent dispatching back to the current handler path.

Default is "false". Switch this to "true" for convention-based views where a dispatch back to the current handler path is a definitive error.

isContextRequired

protected boolean isContextRequired()

An ApplicationContext is not strictly required for InternalResourceView.

覆盖:

isContextRequired 在类中 cn.taketoday.context.support.ApplicationObjectSupport

renderMergedOutputModel

protected void renderMergedOutputModel(Map<String,Object> model,
 RequestContext request)
                                throws Exception

Render the internal resource given the specified model. This includes setting the model as request attributes.

指定者:

renderMergedOutputModel 在类中 AbstractView

参数:

model - combined output Map (never null), with dynamic values taking precedence over static attributes

request - current HTTP request context

抛出:

Exception - if rendering failed

exposeHelpers

protected void exposeHelpers(HttpServletRequest servletRequest,
 RequestContext request)
                      throws Exception

Expose helpers unique to each rendering operation. This is necessary so that different rendering operations can't overwrite each other's contexts etc.

Called by renderMergedOutputModel(Map, RequestContext). The default implementation is empty. This method can be overridden to add custom helpers as request attributes.

参数:

request - current HTTP request

抛出:

Exception - if there's a fatal error while we're adding attributes

另请参阅:

• renderMergedOutputModel(java.util.Map<java.lang.String, java.lang.Object>, cn.taketoday.web.RequestContext)
• exposeHelpers(jakarta.servlet.http.HttpServletRequest, cn.taketoday.web.RequestContext)

prepareForRendering

protected String prepareForRendering(HttpServletRequest request,
 HttpServletResponse response)
                              throws Exception

Prepare for rendering, and determine the request dispatcher path to forward to (or to include).

This implementation simply returns the configured URL. Subclasses can override this to determine a resource to render, typically interpreting the URL in a different manner.

参数:

request - current HTTP request

response - current HTTP response

返回:

the request dispatcher path to use

抛出:

Exception - if preparations failed

另请参阅:

• AbstractUrlBasedView.getUrl()

getRequestDispatcher

@Nullable
protected RequestDispatcher getRequestDispatcher(HttpServletRequest request,
 String path)

Obtain the RequestDispatcher to use for the forward/include.

The default implementation simply calls ServletRequest.getRequestDispatcher(String). Can be overridden in subclasses.

参数:

request - current HTTP request

path - the target URL (as returned from prepareForRendering(jakarta.servlet.http.HttpServletRequest, jakarta.servlet.http.HttpServletResponse))

返回:

a corresponding RequestDispatcher

useInclude

protected boolean useInclude(HttpServletRequest request,
 HttpServletResponse response)

Determine whether to use RequestDispatcher's include or forward method.

Performs a check whether an include URI attribute is found in the request, indicating an include request, and whether the response has already been committed. In both cases, an include will be performed, as a forward is not possible anymore.

参数:

request - current HTTP request

response - current HTTP response

返回:

true for include, false for forward

另请参阅:

• RequestDispatcher.forward(jakarta.servlet.ServletRequest, jakarta.servlet.ServletResponse)
• RequestDispatcher.include(jakarta.servlet.ServletRequest, jakarta.servlet.ServletResponse)
• ServletResponse.isCommitted()
• ServletUtils.isIncludeRequest(jakarta.servlet.ServletRequest)

setServletContext

public final void setServletContext(ServletContext servletContext)

从接口复制的说明: ServletContextAware

Set the ServletContext 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's setApplicationContext.

指定者:

setServletContext 在接口中 ServletContextAware

参数:

servletContext - the ServletContext object to be used by this object

另请参阅:

• InitializingBean.afterPropertiesSet()
• ApplicationContextAware.setApplicationContext(cn.taketoday.context.ApplicationContext)

initServletContext

protected void initServletContext(ServletContext servletContext)

getServletContext

@Nullable
public ServletContext getServletContext()