类 RedirectView
- 所有已实现的接口:
Aware
,BeanNameAware
,InitializingBean
,ApplicationContextAware
,ServletContextAware
,SmartView
,View
public class RedirectView extends AbstractUrlBasedView implements SmartView
View that redirects to an absolute, context relative, or current request relative URL. The URL may be a URI template in which case the URI template variables will be replaced with values available in the model. By default all primitive model attributes (or collections thereof) are exposed as HTTP query parameters (assuming they've not been used as URI template variables), but this behavior can be changed by overriding theisEligibleProperty(String, Object)
method.A URL for this view is supposed to be an HTTP redirect URL, i.e. suitable for HttpServletResponse's
sendRedirect
method, which is what actually does the redirect if the HTTP 1.0 flag is on, or via sending back an HTTP 303 code - if the HTTP 1.0 compatibility flag is off.Note that while the default value for the "contextRelative" flag is off, you will probably want to almost always set it to true. With the flag off, URLs starting with "/" are considered relative to the web server root, while with the flag on, they are considered relative to the web application root. Since most web applications will never know or care what their context path actually is, they are much better off setting this flag to true, and submitting paths which are to be considered relative to the web application root.
NOTE when using this redirect view in a Portlet environment: Make sure that your controller respects the Portlet
sendRedirect
constraints.- 作者:
- Rod Johnson, Juergen Hoeller, Colin Sampaleanu, Sam Brannen, Arjen Poutsma, Rossen Stoyanchev
- 另请参阅:
setContextRelative(boolean)
,setHttp10Compatible(boolean)
,setExposeModelAttributes(boolean)
,HttpServletResponse.sendRedirect(java.lang.String)
字段概要
从类继承的字段 org.springframework.web.servlet.view.AbstractView
DEFAULT_CONTENT_TYPE
从类继承的字段 org.springframework.context.support.ApplicationObjectSupport
logger
从接口继承的字段 org.springframework.web.servlet.View
PATH_VARIABLES, RESPONSE_STATUS_ATTRIBUTE, SELECTED_CONTENT_TYPE
构造器概要
构造器 构造器 说明 RedirectView()
Constructor for use as a bean.RedirectView(String url)
Create a new RedirectView with the given URL.RedirectView(String url, boolean contextRelative)
Create a new RedirectView with the given URL.RedirectView(String url, boolean contextRelative, boolean http10Compatible)
Create a new RedirectView with the given URL.RedirectView(String url, boolean contextRelative, boolean http10Compatible, boolean exposeModelAttributes)
Create a new RedirectView with the given URL.
方法概要
所有方法 实例方法 具体方法 修饰符和类型 方法 说明 protected void
appendCurrentQueryParams(StringBuilder targetUrl, HttpServletRequest request)
Append the query string of the current request to the target redirect URL.protected void
appendQueryProperties(StringBuilder targetUrl, Map<String,Object> model, String encodingScheme)
Append query properties to the redirect URL.protected String
createTargetUrl(Map<String,Object> model, HttpServletRequest request)
Create the target URL by checking if the redirect string is a URI template first, expanding it with the given model, and then optionally appending simple type model attributes as query String parameters.String[]
getHosts()
Return the configured application hosts.protected HttpStatus
getHttp11StatusCode(HttpServletRequest request, HttpServletResponse response, String targetUrl)
Determines the status code to use for HTTP 1.1 compatible requests.protected boolean
isContextRequired()
An ApplicationContext is not strictly required for RedirectView.protected boolean
isEligibleProperty(String key, Object value)
Determine whether the given model element should be exposed as a query property.protected boolean
isEligibleValue(Object value)
Determine whether the given model element value is eligible for exposure.boolean
isPropagateQueryProperties()
Whether to propagate the query params of the current URL.boolean
isRedirectView()
Returns "true" indicating this view performs a redirect.protected boolean
isRemoteHost(String targetUrl)
Whether the given targetUrl has a host that is a "foreign" system in which caseHttpServletResponse.encodeRedirectURL(java.lang.String)
will not be applied.protected Map<String,Object>
queryProperties(Map<String,Object> model)
Determine name-value pairs for query strings, which will be stringified, URL-encoded and formatted byappendQueryProperties(java.lang.StringBuilder, java.util.Map<java.lang.String, java.lang.Object>, java.lang.String)
.protected void
renderMergedOutputModel(Map<String,Object> model, HttpServletRequest request, HttpServletResponse response)
Convert model to request parameters and redirect to the given URL.protected StringBuilder
replaceUriTemplateVariables(String targetUrl, Map<String,Object> model, Map<String,String> currentUriVariables, String encodingScheme)
Replace URI template variables in the target URL with encoded model attributes or URI variables from the current request.protected void
sendRedirect(HttpServletRequest request, HttpServletResponse response, String targetUrl, boolean http10Compatible)
Send a redirect back to the HTTP client.void
setContextRelative(boolean contextRelative)
Set whether to interpret a given URL that starts with a slash ("/") as relative to the current ServletContext, i.e. as relative to the web application root.void
setEncodingScheme(String encodingScheme)
Set the encoding scheme for this view.void
setExpandUriTemplateVariables(boolean expandUriTemplateVariables)
Whether to treat the redirect URL as a URI template.void
setExposeModelAttributes(boolean exposeModelAttributes)
Set theexposeModelAttributes
flag which denotes whether or not model attributes should be exposed as HTTP query parameters.void
setHosts(String... hosts)
Configure one or more hosts associated with the application.void
setHttp10Compatible(boolean http10Compatible)
Set whether to stay compatible with HTTP 1.0 clients.void
setPropagateQueryParams(boolean propagateQueryParams)
When set totrue
the query string of the current URL is appended and thus propagated through to the redirected URL.void
setStatusCode(HttpStatus statusCode)
Set the status code for this view.protected String
updateTargetUrl(String targetUrl, Map<String,Object> model, HttpServletRequest request, HttpServletResponse response)
Find the registeredRequestDataValueProcessor
, if any, and allow it to update the redirect target URL.protected String
urlEncode(String input, String encodingScheme)
URL-encode the given input String with the given encoding scheme.从类继承的方法 org.springframework.web.servlet.view.AbstractUrlBasedView
afterPropertiesSet, checkResource, getUrl, isUrlRequired, setUrl, toString
从类继承的方法 org.springframework.web.servlet.view.AbstractView
addStaticAttribute, createMergedOutputModel, createRequestContext, createTemporaryOutputStream, exposeModelAsRequestAttributes, generatesDownloadContent, getAttributesMap, getBeanName, getContentType, getRequestContextAttribute, getRequestToExpose, getStaticAttributes, isExposePathVariables, prepareResponse, render, setAttributes, setAttributesCSV, setAttributesMap, setBeanName, setContentType, setExposeContextBeansAsAttributes, setExposedContextBeanNames, setExposePathVariables, setRequestContextAttribute, setResponseContentType, writeToResponse
从类继承的方法 org.springframework.web.context.support.WebApplicationObjectSupport
getServletContext, getTempDir, getWebApplicationContext, initApplicationContext, initServletContext, setServletContext
从类继承的方法 org.springframework.context.support.ApplicationObjectSupport
getApplicationContext, getMessageSourceAccessor, initApplicationContext, requiredContextClass, setApplicationContext
从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
从接口继承的方法 org.springframework.web.servlet.View
getContentType, render
构造器详细资料
RedirectView
public RedirectView()
Constructor for use as a bean.
RedirectView
public RedirectView(String url)
Create a new RedirectView with the given URL.The given URL will be considered as relative to the web server, not as relative to the current ServletContext.
- 参数:
url
- the URL to redirect to- 另请参阅:
RedirectView(String, boolean)
RedirectView
public RedirectView(String url, boolean contextRelative)
Create a new RedirectView with the given URL.- 参数:
url
- the URL to redirect tocontextRelative
- whether to interpret the given URL as relative to the current ServletContext
RedirectView
public RedirectView(String url, boolean contextRelative, boolean http10Compatible)
Create a new RedirectView with the given URL.- 参数:
url
- the URL to redirect tocontextRelative
- whether to interpret the given URL as relative to the current ServletContexthttp10Compatible
- whether to stay compatible with HTTP 1.0 clients
RedirectView
public RedirectView(String url, boolean contextRelative, boolean http10Compatible, boolean exposeModelAttributes)
Create a new RedirectView with the given URL.- 参数:
url
- the URL to redirect tocontextRelative
- whether to interpret the given URL as relative to the current ServletContexthttp10Compatible
- whether to stay compatible with HTTP 1.0 clientsexposeModelAttributes
- whether or not model attributes should be exposed as query parameters
方法详细资料
setContextRelative
public void setContextRelative(boolean contextRelative)
Set whether to interpret a given URL that starts with a slash ("/") as relative to the current ServletContext, i.e. as relative to the web application root.Default is "false": A URL that starts with a slash will be interpreted as absolute, i.e. taken as-is. If "true", the context path will be prepended to the URL in such a case.
setHttp10Compatible
public void setHttp10Compatible(boolean http10Compatible)
Set whether to stay compatible with HTTP 1.0 clients.In the default implementation, this will enforce HTTP status code 302 in any case, i.e. delegate to
HttpServletResponse.sendRedirect
. Turning this off will send HTTP status code 303, which is the correct code for HTTP 1.1 clients, but not understood by HTTP 1.0 clients.Many HTTP 1.1 clients treat 302 just like 303, not making any difference. However, some clients depend on 303 when redirecting after a POST request; turn this flag off in such a scenario.
setExposeModelAttributes
public void setExposeModelAttributes(boolean exposeModelAttributes)
Set theexposeModelAttributes
flag which denotes whether or not model attributes should be exposed as HTTP query parameters.Defaults to
true
.
setEncodingScheme
public void setEncodingScheme(String encodingScheme)
Set the encoding scheme for this view.Default is the request's encoding scheme (which is ISO-8859-1 if not specified otherwise).
setStatusCode
public void setStatusCode(HttpStatus statusCode)
Set the status code for this view.Default is to send 302/303, depending on the value of the
http10Compatible
flag.
setExpandUriTemplateVariables
public void setExpandUriTemplateVariables(boolean expandUriTemplateVariables)
Whether to treat the redirect URL as a URI template. Set this flag tofalse
if the redirect URL contains open and close curly braces "{", "}" and you don't want them interpreted as URI variables.Defaults to
true
.
setPropagateQueryParams
public void setPropagateQueryParams(boolean propagateQueryParams)
When set totrue
the query string of the current URL is appended and thus propagated through to the redirected URL.Defaults to
false
.- 从以下版本开始:
- 4.1
isPropagateQueryProperties
public boolean isPropagateQueryProperties()
Whether to propagate the query params of the current URL.- 从以下版本开始:
- 4.1
setHosts
public void setHosts(String... hosts)
Configure one or more hosts associated with the application. All other hosts will be considered external hosts.In effect, this property provides a way turn off encoding via
HttpServletResponse.encodeRedirectURL(java.lang.String)
for URLs that have a host and that host is not listed as a known host.If not set (the default) all URLs are encoded through the response.
- 参数:
hosts
- one or more application hosts- 从以下版本开始:
- 4.3
isRedirectView
public boolean isRedirectView()
Returns "true" indicating this view performs a redirect.- 指定者:
isRedirectView
在接口中SmartView
isContextRequired
protected boolean isContextRequired()
An ApplicationContext is not strictly required for RedirectView.- 覆盖:
isContextRequired
在类中WebApplicationObjectSupport
- 另请参阅:
ApplicationObjectSupport.getApplicationContext()
,ApplicationObjectSupport.getMessageSourceAccessor()
,WebApplicationObjectSupport.getWebApplicationContext()
,WebApplicationObjectSupport.getServletContext()
,WebApplicationObjectSupport.getTempDir()
renderMergedOutputModel
protected void renderMergedOutputModel(Map<String,Object> model, HttpServletRequest request, HttpServletResponse response) throws IOException
Convert model to request parameters and redirect to the given URL.- 指定者:
renderMergedOutputModel
在类中AbstractView
- 参数:
model
- combined output Map (nevernull
), with dynamic values taking precedence over static attributesrequest
- current HTTP requestresponse
- current HTTP response- 抛出:
IOException
- 另请参阅:
appendQueryProperties(java.lang.StringBuilder, java.util.Map<java.lang.String, java.lang.Object>, java.lang.String)
,sendRedirect(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, java.lang.String, boolean)
createTargetUrl
protected final String createTargetUrl(Map<String,Object> model, HttpServletRequest request) throws UnsupportedEncodingException
Create the target URL by checking if the redirect string is a URI template first, expanding it with the given model, and then optionally appending simple type model attributes as query String parameters.
replaceUriTemplateVariables
protected StringBuilder replaceUriTemplateVariables(String targetUrl, Map<String,Object> model, Map<String,String> currentUriVariables, String encodingScheme) throws UnsupportedEncodingException
Replace URI template variables in the target URL with encoded model attributes or URI variables from the current request. Model attributes referenced in the URL are removed from the model.- 参数:
targetUrl
- the redirect URLmodel
- a Map that contains model attributescurrentUriVariables
- current request URI variables to useencodingScheme
- the encoding scheme to use- 抛出:
UnsupportedEncodingException
- if string encoding failed
appendCurrentQueryParams
protected void appendCurrentQueryParams(StringBuilder targetUrl, HttpServletRequest request)
Append the query string of the current request to the target redirect URL.- 参数:
targetUrl
- the StringBuilder to append the properties torequest
- the current request- 从以下版本开始:
- 4.1
appendQueryProperties
protected void appendQueryProperties(StringBuilder targetUrl, Map<String,Object> model, String encodingScheme) throws UnsupportedEncodingException
Append query properties to the redirect URL. Stringifies, URL-encodes and formats model attributes as query properties.- 参数:
targetUrl
- the StringBuilder to append the properties tomodel
- a Map that contains model attributesencodingScheme
- the encoding scheme to use- 抛出:
UnsupportedEncodingException
- if string encoding failed- 另请参阅:
queryProperties(java.util.Map<java.lang.String, java.lang.Object>)
queryProperties
protected Map<String,Object> queryProperties(Map<String,Object> model)
Determine name-value pairs for query strings, which will be stringified, URL-encoded and formatted byappendQueryProperties(java.lang.StringBuilder, java.util.Map<java.lang.String, java.lang.Object>, java.lang.String)
.This implementation filters the model through checking
isEligibleProperty(String, Object)
for each element, by default accepting Strings, primitives and primitive wrappers only.- 参数:
model
- the original model Map- 返回:
- the filtered Map of eligible query properties
- 另请参阅:
isEligibleProperty(String, Object)
isEligibleProperty
protected boolean isEligibleProperty(String key, Object value)
Determine whether the given model element should be exposed as a query property.The default implementation considers Strings and primitives as eligible, and also arrays and Collections/Iterables with corresponding elements. This can be overridden in subclasses.
- 参数:
key
- the key of the model elementvalue
- the value of the model element- 返回:
- whether the element is eligible as query property
isEligibleValue
protected boolean isEligibleValue(Object value)
Determine whether the given model element value is eligible for exposure.The default implementation considers primitives, strings, numbers, dates, URIs, URLs etc as eligible, according to
BeanUtils.isSimpleValueType(java.lang.Class<?>)
. This can be overridden in subclasses.- 参数:
value
- the model element value- 返回:
- whether the element value is eligible
- 另请参阅:
BeanUtils.isSimpleValueType(java.lang.Class<?>)
urlEncode
protected String urlEncode(String input, String encodingScheme) throws UnsupportedEncodingException
URL-encode the given input String with the given encoding scheme.The default implementation uses
URLEncoder.encode(input, enc)
.- 参数:
input
- the unencoded input StringencodingScheme
- the encoding scheme- 返回:
- the encoded output String
- 抛出:
UnsupportedEncodingException
- if thrown by the JDK URLEncoder- 另请参阅:
URLEncoder.encode(String, String)
updateTargetUrl
protected String updateTargetUrl(String targetUrl, Map<String,Object> model, HttpServletRequest request, HttpServletResponse response)
Find the registeredRequestDataValueProcessor
, if any, and allow it to update the redirect target URL.- 参数:
targetUrl
- the given redirect URL- 返回:
- the updated URL or the same as URL as the one passed in
sendRedirect
protected void sendRedirect(HttpServletRequest request, HttpServletResponse response, String targetUrl, boolean http10Compatible) throws IOException
Send a redirect back to the HTTP client.- 参数:
request
- current HTTP request (allows for reacting to request method)response
- current HTTP response (for sending response headers)targetUrl
- the target URL to redirect tohttp10Compatible
- whether to stay compatible with HTTP 1.0 clients- 抛出:
IOException
- if thrown by response methods
isRemoteHost
protected boolean isRemoteHost(String targetUrl)
Whether the given targetUrl has a host that is a "foreign" system in which caseHttpServletResponse.encodeRedirectURL(java.lang.String)
will not be applied. This method returnstrue
if thesetHosts(String[])
property is configured and the target URL has a host that does not match.- 参数:
targetUrl
- the target redirect URL- 返回:
true
the target URL has a remote host,false
if it the URL does not have a host or the "host" property is not configured.- 从以下版本开始:
- 4.3
getHttp11StatusCode
protected HttpStatus getHttp11StatusCode(HttpServletRequest request, HttpServletResponse response, String targetUrl)
Determines the status code to use for HTTP 1.1 compatible requests.The default implementation returns the
statusCode
property if set, or the value of theView.RESPONSE_STATUS_ATTRIBUTE
attribute. If neither are set, it defaults toHttpStatus.SEE_OTHER
(303).- 参数:
request
- the request to inspectresponse
- the servlet responsetargetUrl
- the target URL- 返回:
- the response status