java – Where exactly is a model object created in Spring MVC?

java – Where exactly is a model object created in Spring MVC?

If not present in the model, the argument should be instantiated first and then added to the model.

The paragraph describes the following piece of code:

if (mavContainer.containsAttribute(name)) {
    attribute = mavContainer.getModel().get(name);
} else {
    // Create attribute instance
    try {
        attribute = createAttribute(name, parameter, binderFactory, webRequest);
    }
    catch (BindException ex) {
        ...
    }
}
...
mavContainer.addAllAttributes(attribute);

(taken from ModelAttributeMethodProcessor#resolveArgument)

For every request, Spring initialises a ModelAndViewContainer instance which records model and view-related decisions made by HandlerMethodArgumentResolvers and HandlerMethodReturnValueHandlers during the course of invocation of a controller method.

A newly-created ModelAndViewContainer object is initially populated with flash attributes (if any):

ModelAndViewContainer mavContainer = new ModelAndViewContainer();
mavContainer.addAllAttributes(RequestContextUtils.getInputFlashMap(request));

It means that the argument wont be initialised if it already exists in the model.

To prove it, lets move to a practical example.

The Pet class:

public class Pet {
    private String petId;
    private String ownerId;
    private String hiddenField;

    public Pet() {
         System.out.println(A new Pet instance was created!);
    }

    // setters and toString
}

The PetController class:

@RestController
public class PetController {

    @GetMapping(value = /internal)
    public void invokeInternal(@ModelAttribute Pet pet) {
        System.out.println(pet);
    }

    @PostMapping(value = /owners/{ownerId}/pets/{petId}/edit)
    public RedirectView editPet(@ModelAttribute Pet pet, RedirectAttributes attributes) {
        System.out.println(pet);
        pet.setHiddenField(XXX);

        attributes.addFlashAttribute(pet, pet);
        return new RedirectView(/internal);
    }

}

Lets make a POST request to the URI /owners/123/pets/456/edit and see the results:

A new Pet instance was created!
Pet[456,123,null]
Pet[456,123,XXX]

A new Pet instance was created!

Spring created a ModelAndViewContainer and didnt find anything to fill the instance with (its a request from a client; there werent any redirects). Since the model is empty, Spring had to create a new Pet object by invoking the default constructor which printed the line.

Pet[456,123,null]

Once present in the model, the arguments fields should be populated from all request parameters that have matching names.

We printed the given Pet to make sure all the fields petId and ownerId had been bound correctly.

Pet[456,123,XXX]

We set hiddenField to check our theory and redirected to the method invokeInternal which also expects a @ModelAttribute. As we see, the second method received the instance (with own hidden value) which was created for the first method.

To answer the question i found few snippets of code with the help of @andrew answer. Which justify a ModelMap instance[a model object] is created well before our controller/handler is called for specific URL

 public class ModelAndViewContainer {

    private boolean ignoreDefaultModelOnRedirect = false;

    @Nullable
    private Object view;

    private final ModelMap defaultModel = new BindingAwareModelMap();
      ....
      .....
   }

If we see the above snippet code (taken from spring-webmvc-5.0.8 jar). BindingAwareModelMap model object is created well before.

For better Understanding adding the comments for the class BindingAwareModelMap

   /**
     * Subclass of {@link org.springframework.ui.ExtendedModelMap} that automatically removes
     * a {@link org.springframework.validation.BindingResult} object if the corresponding
     * target attribute gets replaced through regular {@link Map} operations.
     *
     * <p>This is the class exposed to handler methods by Spring MVC, typically consumed through
     * a declaration of the {@link org.springframework.ui.Model} interface. There is no need to
     * build it within user code; a plain {@link org.springframework.ui.ModelMap} or even a just
     * a regular {@link Map} with String keys will be good enough to return a user model.
     *
     @SuppressWarnings(serial)
      public class BindingAwareModelMap extends ExtendedModelMap {
      ....
      ....
     }

java – Where exactly is a model object created in Spring MVC?

Leave a Reply

Your email address will not be published. Required fields are marked *