程序包 cn.taketoday.web.view

类 RedirectView

java.lang.Object
cn.taketoday.context.support.ApplicationObjectSupport
cn.taketoday.web.view.AbstractView
cn.taketoday.web.view.AbstractUrlBasedView
cn.taketoday.web.view.RedirectView
所有已实现的接口:
cn.taketoday.beans.factory.Aware, cn.taketoday.beans.factory.BeanNameAware, cn.taketoday.beans.factory.InitializingBean, cn.taketoday.context.ApplicationContextAware, 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 the isEligibleProperty(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.

从以下版本开始:
4.0
作者:
Rod Johnson, Juergen Hoeller, Colin Sampaleanu, Sam Brannen, Arjen Poutsma, Rossen Stoyanchev, Harry Yang
另请参阅:

  • 字段详细资料

    • URI_TEMPLATE_VARIABLE_PATTERN

      private static final Pattern URI_TEMPLATE_VARIABLE_PATTERN

    • contextRelative

      private boolean contextRelative

    • http10Compatible

      private boolean http10Compatible

    • exposeModelAttributes

      private boolean exposeModelAttributes

    • encoding

      @Nullable private Charset encoding

    • statusCode

      @Nullable private HttpStatusCode statusCode

    • expandUriTemplateVariables

      private boolean expandUriTemplateVariables

    • propagateQueryParams

      private boolean propagateQueryParams

  • 构造器详细资料

    • 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

      public RedirectView(String url, boolean contextRelative)
      Create a new RedirectView with the given URL.
      参数:
      url - the URL to redirect to
      contextRelative - 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 to
      contextRelative - whether to interpret the given URL as relative to the current ServletContext
      http10Compatible - 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 to
      contextRelative - whether to interpret the given URL as relative to the current ServletContext
      http10Compatible - whether to stay compatible with HTTP 1.0 clients
      exposeModelAttributes - 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 the exposeModelAttributes 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 UTF-8 if not specified otherwise).

      抛出:
      IllegalCharsetNameException - If the given charset name is illegal
      IllegalArgumentException - If the given charsetName is null
      UnsupportedCharsetException - If no support for the named charset is available in this instance of the Java virtual machine

    • setEncoding

      public void setEncoding(@Nullable Charset charset)
      Set the encoding scheme for this view.

      Default is the request's encoding scheme (which is UTF-8 if not specified otherwise).

    • setStatusCode

      public void setStatusCode(HttpStatusCode 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 to false 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 to true the query string of the current URL is appended and thus propagated through to the redirected URL.

      Defaults to false.

    • isPropagateQueryProperties

      public boolean isPropagateQueryProperties()
      Whether to propagate the query params of the current URL.

    • 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 在类中 cn.taketoday.context.support.ApplicationObjectSupport

    • renderMergedOutputModel

      protected void renderMergedOutputModel(Map<String,Object> model, RequestContext request) throws IOException
      Convert model to request parameters and redirect to the given URL.
      指定者:
      renderMergedOutputModel 在类中 AbstractView
      参数:
      model - combined output Map (never null), with dynamic values taking precedence over static attributes
      request - current HTTP request context
      抛出:
      IOException
      另请参阅:

    • createTargetUrl

      protected final String createTargetUrl(Map<String,Object> model, RequestContext 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.

    • getContextPath

      private String getContextPath(RequestContext request)

    • replaceUriTemplateVariables

      protected StringBuilder replaceUriTemplateVariables(String targetUrl, Map<String,Object> model, Map<String,String> currentUriVariables, Charset encodingScheme)
      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 URL
      model - a Map that contains model attributes
      currentUriVariables - current request URI variables to use
      encodingScheme - the encoding scheme to use

    • getCurrentRequestUriVariables

      private Map<String,String> getCurrentRequestUriVariables(RequestContext request)

    • appendCurrentQueryParams

      protected void appendCurrentQueryParams(StringBuilder targetUrl, RequestContext request)
      Append the query string of the current request to the target redirect URL.
      参数:
      targetUrl - the StringBuilder to append the properties to
      request - the current request

    • appendQueryProperties

      protected void appendQueryProperties(StringBuilder targetUrl, Map<String,Object> model, Charset encodingScheme)
      Append query properties to the redirect URL. Stringifies, URL-encodes and formats model attributes as query properties.
      参数:
      targetUrl - the StringBuilder to append the properties to
      model - a Map that contains model attributes
      encodingScheme - the encoding scheme to use
      另请参阅:

    • 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 by appendQueryProperties(java.lang.StringBuilder, java.util.Map<java.lang.String, java.lang.Object>, java.nio.charset.Charset).

      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

      protected boolean isEligibleProperty(String key, @Nullable 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 element
      value - the value of the model element
      返回:
      whether the element is eligible as query property

    • isEligibleValue

      protected boolean isEligibleValue(@Nullable 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, Charset encodingScheme)
      URL-encode the given input String with the given encoding scheme.

      The default implementation uses URLEncoder.encode(input, enc).

      参数:
      input - the unencoded input String
      encodingScheme - the encoding scheme
      返回:
      the encoded output String
      另请参阅:

    • sendRedirect

      protected void sendRedirect(RequestContext context, String targetUrl) throws IOException
      Send a redirect back to the HTTP client.
      参数:
      context - current HTTP request (allows for reacting to request method)
      targetUrl - the target URL to redirect to
      抛出:
      IOException - if thrown by response methods

    • getHttpStatus

      @Nullable protected HttpStatusCode getHttpStatus(RequestContext context, String targetUrl)
      Determines the status code to use for HTTP compatible requests.

      The default implementation returns the statusCode property if set, or the value of the View.RESPONSE_STATUS_ATTRIBUTE attribute. If neither are set, it defaults to HttpStatus.SEE_OTHER (303) or null when http10Compatible is true.

      参数:
      context - the request to inspect
      targetUrl - the target URL
      返回:
      the response status