root
/
spring-framework
mirror of https://github.com/spring-projects/spring-framework.git
1
0
Fork 0
Code Issues Actions Packages Projects Releases Wiki Activity

SPR-7103 - Added more detailed documentation on ordering of model attribute and BindingResult.

This commit is contained in:
Oliver Gierke 2010-06-07 20:57:55 +00:00
parent 5b420e20c7
commit 857faec1f3
1 changed files with 26 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
spring-framework-reference/src/mvc.xml
View File

@ -949,10 +949,8 @@ public class RelativePathUriTemplateController {
<para>Handler methods that are annotated with
<classname>@RequestMapping</classname> can have very flexible
signatures. They may have arguments of the following types, in
arbitrary order (except for validation results, which need to follow
right after the corresponding command object, if desired): <!--Reword preceding sentence to clarify, make it a complete sentence and no parentheses: first it says validation results *must*--><!--immediately follow command object, but then it says *if desired*. Clarify what must happen if what is desired. And are validation --><!-- results a type of argument? Relate to the sentence that precedes it.-->
<itemizedlist>
signatures. Most of them can be used in arbitrary order (see below for
more details). <itemizedlist>
<listitem>
<para>Request or response objects (Servlet API). Choose any
specific request or response type, for example
@ -1084,6 +1082,30 @@ public class RelativePathUriTemplateController {
</listitem>
</itemizedlist></para>
<para>The <interfacename>Errors</interfacename> or
<interfacename>BindingResult</interfacename> 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 <interfacename>BindingResult</interfacename> instance for
each of them so the following sample won't work:</para>
<example>
<title>Invalid ordering of BindingResult and @ModelAttribute</title>
<programlisting lang="java">@RequestMapping(method = RequestMethod.POST)
public String processSubmit(<emphasis role="bold">@ModelAttribute("pet") Pet pet</emphasis>,
Model model, <emphasis role="bold">BindingResult result</emphasis>) { … }</programlisting>
<para>Note, that there is a <interfacename>Model</interfacename>
parameter in between <classname>Pet</classname> and
<interfacename>BindingResult</interfacename>. To get this working
you have to reorder the parameters as follows:</para>
<programlisting lang="java">@RequestMapping(method = RequestMethod.POST)
public String processSubmit(<emphasis role="bold">@ModelAttribute("pet") Pet pet</emphasis>,
<emphasis role="bold">BindingResult result</emphasis>, Model model) { … }</programlisting>
</example>
<para>The following return types are supported for handler methods:
<itemizedlist>
<listitem>