Spring RequestMapping Supported Method Arguments
28-06-2014The following are the supported method arguments:
- Request or response objects (Servlet API) Choose any specific request or response type, for example
ServletRequestorHttpServletRequest.
-
Session object (Servlet API) of type
HttpSession. An argument of this type enforces the presence of a corresponding session. As a consequence, such an argument is nevernull.
![[Note]](http://docs.spring.io/spring/docs/current/spring-framework-reference/html/images/note.png) | Note |
|---|---|
|
Session access may not be thread-safe, in particular in a Servlet environment. Consider
setting the |
-
org.springframework.web.context.request.WebRequestororg.springframework.web.context.request.NativeWebRequest. Allows for generic request parameter access as well as request/session attribute access, without ties to the native Servlet/Portlet API.
-
java.util.Localefor the current request locale, determined by the most specific locale resolver available, in effect, the configuredLocaleResolverin a Servlet
environment.
-
java.io.InputStream/java.io.Readerfor access to the request’s content. This value is the raw InputStream/Reader as exposed by the Servlet API.
-
java.io.OutputStream/java.io.Writerfor generating the response’s content. This value is the raw OutputStream/Writer as exposed by the Servlet API.
-
org.springframework.http.HttpMethodfor the HTTP request method.
-
java.security.Principalcontaining the currently authenticated user.
-
@PathVariableannotated parameters for access to URI template variables. See the section called “URI Template Patterns”.
-
@MatrixVariableannotated parameters for access to name-value pairs located in URI path segments. See the section called “Matrix Variables”.
-
@RequestParamannotated parameters for access to specific Servlet request parameters. Parameter values are converted to the declared method argument type. See the section called “Binding request parameters to method parameters with @RequestParam”.
-
@RequestHeaderannotated parameters for access to specific Servlet request HTTP headers. Parameter values are converted to the declared method argument type.
-
@RequestBodyannotated parameters for access to the HTTP request body. Parameter values are converted to the declared method argument type using
HttpMessageConverters. See the section called “Mapping the request body with the @RequestBody annotation”.
-
@RequestPartannotated parameters for access to the content of a "multipart/form-data" request part. See Section 16.11.5, “Handling a file upload request from programmatic clients” and Section 16.11, “Spring’s multipart (file upload) support”.
-
HttpEntity<?>parameters for access to the Servlet request HTTP headers and contents. The request stream will be converted to the entity body using
HttpMessageConverters. See HttpEntity">the section called “Using HttpEntity”.
-
java.util.Map/org.springframework.ui.Model/org.springframework.ui.ModelMapfor enriching the implicit model that is exposed to the web view.
-
org.springframework.web.servlet.mvc.support.RedirectAttributesto specify the exact set of attributes to use in case of a redirect and also to add flash attributes (attributes stored temporarily on the server-side to make them available to the request after the redirect).RedirectAttributesis used instead of the implicit model if the method returns a "redirect:" prefixed view name orRedirectView.
-
Command or form objects to bind request parameters to bean properties (via setters) or directly to fields, with customizable type conversion, depending on
@InitBindermethods and/or the HandlerAdapter configuration. See thewebBindingInitializerproperty onRequestMappingHandlerAdapter. Such command objects along with their validation results will be exposed as model attributes by default, using the command class class name - e.g. model attribute "orderAddress" for a command object of type "some.package.OrderAddress". TheModelAttributeannotation can be used on a method argument to customize the model attribute name used.
-
org.springframework.validation.Errors/org.springframework.validation.BindingResultvalidation results for a preceding command or form object (the immediately preceding method argument).
-
org.springframework.web.bind.support.SessionStatusstatus handle for marking form processing as complete, which triggers the cleanup of session attributes that have been indicated by the@SessionAttributesannotation at the handler type level.
-
org.springframework.web.util.UriComponentsBuildera builder for preparing a URL relative to the current request’s host, port, scheme, context path, and the literal part of the servlet mapping.
The Errors or BindingResult parameters have to follow the model object that is being bound immediately as the method signature might have more that one model object and Spring will create a separate BindingResult instance for each of them so the following
sample won’t work:
BindingResult and @ModelAttribute"
Invalid ordering of BindingResult and @ModelAttribute.
@RequestMapping(method = RequestMethod.POST) public String processSubmit(@ModelAttribute("pet") Pet pet, Model model, BindingResult result) { ... }
Note, that there is a Model parameter in between Pet and BindingResult. To get
this working you have to reorder the parameters as follows:
@RequestMapping(method = RequestMethod.POST) public String processSubmit(@ModelAttribute("pet") Pet pet, BindingResult result, Model model) { ... }
