What causes "java.lang.IllegalStateException: Neither BindingResult nor plain target object for bean name 'command' available as request attribute"?
You're trying to use Spring MVC's form tag.
This tag renders an HTML
form
tag and exposes a binding path to inner tags for binding. It puts the command object in thePageContext
so that the command object can be accessed by inner tags. [..]Let’s assume we have a domain object called
User
. It is a JavaBean with properties such asfirstName
andlastName
. We will use it as the form backing object of our form controller which returnsform.jsp
.
In other words, Spring MVC will extract a command object and use its type as a blueprint for binding path
expressions for form
's inner tags, like input
or checkbox
, to render an HTML form
element.
This command object is also called a model attribute and its name is specified in the form
tag's modelAttribute
or commandName
attributes. You've omitted it in your JSP
<form:form>
You could've specified a name explicitly. Both of these are equivalent.
<form:form modelAttribute="some-example-name">
<form:form commandName="some-example-name">
The default attribute name is command
(what you see in error message). A model attribute is an object, typically a POJO or collection of POJOs, that your application supplies to the Spring MVC stack and which the Spring MVC stack exposes to your view (ie. the M to the V in MVC).
Spring MVC collects all model attributes in a ModelMap
(they all have names) and, in the case of JSPs, transfers them to the HttpServletRequest
attributes, where JSP tags and EL expressions have access to them.
In your example, your @Controller
handler method which handles a GET
to the path /movies
adds a single model attribute
model.addAttribute("movies", movies); // not named 'command'
and then forwards to the index.jsp
. This JSP then tries to render
<form:form>
...
<form:input path="name" type="text" id="name" />
...
</form:form>
While rendering this, FormTag
(in reality, the InputTag
) tries to find a model attribute named command
(the default attribute name) so that it can produce an HTML <input>
element with a name
attribute constructed from the path
expression and the corresponding property value, ie. the result of Movie#getFilmName()
.
Since it cannot find it, it throws the exception you see
java.lang.IllegalStateException: Neither BindingResult nor plain target object for bean name 'command' available as request attribute
The JSP engine catches it and responds with a 500 status code. If you want to take advantage of a Movie
POJO to simply construct your form correctly, you can add a model attribute explicitly with
model.addAttribute("movie", new Movie());
or have Spring MVC create and add one for you (must have an accessible parameterless constructor)
@RequestMapping(path = "/movies", method = RequestMethod.GET)
public String homePage(@ModelAttribute("command") Movie movie, Model model) {...}
Alternatively, include a @ModelAttribute
annotated method in your @Controller
class
@ModelAttribute("command")
public Movie defaultInstance() {
Movie movie = new Movie();
movie.setFilmName("Rocky II");
return movie;
}
Note that Spring MVC will call this method and implicitly add the object returned to its model attributes for each request handled by the enclosing @Controller
.
You may have guessed from this description that Spring's form
tag is more suited for rendering an HTML <form>
from an existing object, with actual values. If you want to simply create a blank <form>
, it may be more appropriate to construct it yourself and not rely on any model attributes.
<form method="post" action="${pageContext.request.contextPath}/movies">
<input name="filmName" type="text" />
<input type="submit" value="Upload" />
</form>
On the receiving side, your POST
handler method, will still be able to extract the filmName
input value and use it to initialize a Movie
object.
Common Errors
As we've seen, FormTag
looks for a model attribute named command
by default or with the name specified in either modelAttribute
or commandName
. Make sure you're using the right name.
ModelMap
has a addAttribute(Object)
method which adds
the supplied attribute to this
Map
using a generated name.
where the general convention is to
return the uncapitalized short name of the [attribute's]
Class
, according to JavaBeans property naming rules: So,com.myapp.Product
becomesproduct
;com.myapp.MyProduct
becomesmyProduct
;com.myapp.UKProduct
becomesUKProduct
If you're using this (or a similar) method or if you're using one of the @RequestMapping
supported return types that represents a model attribute, make sure the generated name is what you expect.
Another common error is to bypass your @Controller
method altogether. A typical Spring MVC application follows this pattern:
- Send HTTP GET request
DispatcherServlet
selects@RequestMapping
method to handle request- Handler method generates some model attributes and returns view name
DispatcherServlet
adds model attributes toHttpServletRequest
and forwards request to JSP corresponding to view name- JSP renders response
If, by some misconfiguration, you skip the @RequestMapping
method altogether, the attributes will not have been added. This can happen
- if your HTTP request URI accesses your JSP resources directly, eg. because they are accessible, ie. outside
WEB-INF
, or - if the
welcome-list
of yourweb.xml
contains your JSP resource, the Servlet container will render it directly, bypassing the Spring MVC stack entirely
One way or another, you want your @Controller
to be invoked so that the model attributes are added appropriately.
What does BindingResult
have to do with this?
A BindingResult
is a container for initialization or validation of model attributes. The Spring MVC documentation states
The
Errors
orBindingResult
parameters have to follow the model object that is being bound immediately as the method signature might have more than one model object and Spring will create a separateBindingResult
instance for each of them [...]
In other words, if you want to use BindingResult
, it has to follow the corresponding model attribute parameter in a @RequestMapping
method
@RequestMapping(path = "/movies", method = RequestMethod.POST)
public String upload(@ModelAttribute("movie") Movie movie, BindingResult errors) {
BindingResult
objects are also considered model attributes. Spring MVC uses a simple naming convention to manage them, making it easy to find a corresponding regular model attribute. Since the BindingResult
contains more data about the model attribute (eg. validation errors), the FormTag
attempts to bind to it first. However, since they go hand in hand, it's unlikely one will exist without the other.