Spring MVC Flash Attribute tutorial with example

Spring MVC 3.1 version has added a very useful feature Flash attribute which it lacked and is now solving a long time problem of POST/Redirect/GET pattern. In a normal Web based MVC application each form submitted POST the data to the server. A normal spring controller (tagged with annotation @Controller) fetches the data from request and process it further (save or update in database). Once the operation is successful, user is forwarded to page showing success of operation. Traditionally if we handle this via POST/Forward/GET, then it may cause sometime multiple form submission issue. User might press F5 and the same data is posted again.

To overcome this problem, POST/Redirect/GET pattern is used in MVC applcations. Once user form is posted successfully, we redirect the request to another success page. This causes browser to perform a new GET request and load the page. Thus is user presses F5, the GET request gets loaded instead of submitting form again.


Image credit: Wikipedia 

While this approach looks perfect and solve the problem of multiple form submission, it add one more issue of retrieving request parameters and attributes. Normally when we generate an http redirect request, the data stored in request is lost making it impossible for next GET request to access some of the useful information from request. Flash attributes comes handy in such cases. Flash attributes provide a way for one request to store attributes intended for use in another. Flash attributes are saved temporarily (typically in the session) before the redirect to be made available to the request after the redirect and removed immediately.


In order to do this, Flash feature uses two collections. FlashMap is used to hold flash attributes while FlashMapManager is used to store, retrieve, and manage FlashMap instances. For each request an “input” flash map is created which stores flash attribute from any previous request and an “output” flash map is created which stores any subsequent attributes that we store in this request.


In order to use Flash attribute in your Spring MVC application make sure you using version 3.1 or above. Also add mvc:annotation-driven to spring-servlet.xml file.

<mvc:annotation-driven />
Code language: HTML, XML (xml)

Once this is done, Flash attribute is automatically set “on” for usage. Just add attribute RedirectAttributes redirectAttributes to your Spring controller’s method.

import org.springframework.web.servlet.mvc.support.RedirectAttributes; //... @RequestMapping(value = "addcustomer", method = RequestMethod.POST) public String addCustomer(@ModelAttribute("customer") Customer customer, final RedirectAttributes redirectAttributes) { //... redirectAttributes.addFlashAttribute("message", "Successfully added.."); //... return "redirect:some_other_request_name"; }
Code language: Java (java)

The addFlashAttribute method automatically add the given parameter to the output flash map and pass it to the subsequent requests. Let us see a complete demo application which uses Flash attribute to perform POST/Redirect/GET and passes some information.

Flash Attribute Example

The following application displays a form to user. Once the user inputs data and submits form, the page is redirected to another page where success message is displayed. On this new redirected page, the user input is displayed.

Step 1: Required JAR and Project Structure

If you using Maven as dependency management, use below dependencies to add Spring 3.1 MVC support.

<dependencies> <!-- Spring 3.1 MVC --> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-webmvc</artifactId> <version>3.1.2.RELEASE</version> </dependency> <!-- JSTL for c: tag --> <dependency> <groupId>jstl</groupId> <artifactId>jstl</artifactId> <version>1.2</version> </dependency> </dependencies>
Code language: HTML, XML (xml)

Alternatively, you can also download following JAR files and place them under /WEB-INF/lib folder.


Step 2: Spring Configuration

Add Spring support to web project by adding DispatcherServlet to web.xml. web.xml

<?xml version="1.0" encoding="UTF-8"?> <web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://java.sun.com/xml/ns/javaee" xmlns:web="http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd" xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd" id="WebApp_ID" version="2.5"> <display-name>Spring MVC Flash attribute example</display-name> <servlet> <servlet-name>spring</servlet-name> <servlet-class> org.springframework.web.servlet.DispatcherServlet </servlet-class> <load-on-startup>1</load-on-startup> </servlet> <servlet-mapping> <servlet-name>default</servlet-name> <url-pattern>/index.html</url-pattern> </servlet-mapping> <servlet-mapping> <servlet-name>spring</servlet-name> <url-pattern>*.html</url-pattern> </servlet-mapping> </web-app>
Code language: HTML, XML (xml)

Also the spring-servlet uses mvc:annotation-driven to enable mvc and also scans the project with context:component-scan tag. spring-servlet.xml

<?xml version="1.0" encoding="UTF-8"?> <beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:context="http://www.springframework.org/schema/context" xmlns:mvc="http://www.springframework.org/schema/mvc" xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc.xsd"> <bean id="jspViewResolver" class="org.springframework.web.servlet.view.InternalResourceViewResolver"> <property name="viewClass" value="org.springframework.web.servlet.view.JstlView" /> <property name="prefix" value="/WEB-INF/jsp/" /> <property name="suffix" value=".jsp" /> </bean> <context:component-scan base-package="net.viralpatel.controller" /> <mvc:annotation-driven /> </beans>
Code language: HTML, XML (xml)

Step 3: Spring Controller – RedirectAttributes

The Controller code uses Customer.java object as bean (command) to holds customer information. Customer.java

package net.viralpatel.spring; public class Customer { private String firstname; private String lastname; private int age; private String email; //getter, setter methods }
Code language: Java (java)

The CustomerController class has 3 methods. Method showForm is mapped with /form URL and is used to display Add New Customer form. Th method addCustomer is mapped with URL /addcustomer and is used on POST request. CustomerController.java

package net.viralpatel.controller; import net.viralpatel.spring.Customer; import org.springframework.stereotype.Controller; import org.springframework.web.bind.annotation.ModelAttribute; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RequestMethod; import org.springframework.web.servlet.mvc.support.RedirectAttributes; @Controller public class CustomerController { @RequestMapping(value="showform", method=RequestMethod.GET) public String showForm(@ModelAttribute("customer") Customer customer) { return "add_customer"; } @RequestMapping(value="addcustomer", method=RequestMethod.POST) public String addCustomer(@ModelAttribute("customer") Customer customer, final RedirectAttributes redirectAttributes) { redirectAttributes.addFlashAttribute("customer", customer); redirectAttributes.addFlashAttribute("message","Added successfully."); return "redirect:showcustomer.html"; } @RequestMapping(value="showcustomer", method=RequestMethod.GET) public String showCustomer(@ModelAttribute("customer") Customer customer) { System.out.println("cust:" + customer.getFirstname()); return "show_customer"; } }
Code language: Java (java)

Note how we used redirectAttributes parameter on method addCustomer to map flash attributes. Also we used addFlashAttribute method to set new parameters to flash attribute.

Step 4: Views

The add customer JSP displays Add New Customer form. add_customer.jsp

<%@taglib uri="http://www.springframework.org/tags/form" prefix="form"%> <html> <body> <h1>Add New Customer</h1> <form:form action="addcustomer.html" method="post" commandName="customer"> <table> <tr> <td><form:label path="firstname">Firstname</form:label></td> <td><form:input path="firstname" /> </td> </tr> <tr> <td><form:label path="lastname">Lastname</form:label></td> <td><form:input path="lastname" /> </td> </tr> <tr> <td><form:label path="age">Age</form:label></td> <td><form:input path="age" /> </td> </tr> <tr> <td><form:label path="email">Email</form:label> <td><form:input path="email" /> </td> </tr> <tr> <td colspan="2"><input type="submit" value="Add Customer" /> </td> </tr> </table> </form:form> </body> </html>
Code language: HTML, XML (xml)

Show customer JSP simply shows the customer’s first and last name and a success message set as flash attributes. show_customer.jsp

<%@taglib uri="http://www.springframework.org/tags/form" prefix="form"%> <html> <body> <h1>${message}</h1> ${customer.lastname}, ${customer.firstname} added successfully.. </body> </html>
Code language: HTML, XML (xml)


Execute the web project. 

URL: http://localhost:8080/SpringMVC_Flash_Attribute_Maven_example/form.html


Download Source Code

SpringMVC_Flash_Attribute_example.zip (3.5 MB)

Get our Articles via Email. Enter your email address.

You may also like...


  1. I am pretty sure your example is wrong. You should only add the flash message before the redirect, not the customer object. When redirecting you should add the id of the customer to the query string of the redirect.

    I suspect your example, if you press F5 on the success page, will either crash or it won’t show the customer name. I think you are forgetting the “GET” part of the PRG pattern.

    • Noma says:

      It seems attributes have added before redirect, what’s your point here???

      • Michael says:

        Hmmm… I think [email protected] is right. When you perform F5 on your result success page with customer name you will get some error. Your app example needed @SessionAttribute(“customer”) to be added on Controller.

        • Jana says:

          Michael, if you put @SessionAttribute(“customer”), you don’t need flash attributes at all :)
          there has to be another solution…

    • Chris says:

      Flash Attributes are intentionally implemented like that. On refresh you should redirect to another page. If you want to support refreshes, don’t use Flash Attributes.

  2. I was about to ask how did you created that image, it just awesome and explains concept wonderfully before I saw that wikipedia credit. Anyway I would love to know , let me know if you come to know about it.

  3. gramana says:

    i want to total meterial of mvc and

  4. explain
    Abstract controller example in spring

  5. Yo Yehudi says:


    I’d been trying to use the http referer to conditionally set a certain variable, but the solution wasn’t quite as robust as I needed, since the user could manually navigate from page A to page B and get the same result, without a POST between page A and B. This resolved my problems easily. Thanks!

  6. ArunM says:

    Thanks. That was very informative.

  7. vick says:

    HTML Attributes are property of the elements which may have values and these attribute values are always enclosed in quotes. It’s providing to the browser with some additional information about an elements how the elements should appear or behave. HTML elements can contain one or more attributes, attribute names and attribute values are case-insensitive and separated by an equals (=) sign.

    [HTML Attributes](http://www.willvick.com/HTML/HTMLAttribute.aspx)

    [HTML Attributes Examples](http://www.willvick.com/HTML/HTMLExampleAttribute.aspx)

    [Youtube – HTML Tutorial – Attributes](http://www.youtube.com/watch?v=ucOXvaCEZgg)

  8. Noma says:

    Its very good and complete article. Keep it up mate…

  9. King says:

    Hi Viral, when i reach to display info on redirected page its showing me proper info, but as soon as i press refresh button data does not persist in that object, so what to do for that, coz flashMap are meant for that.

  10. Varun says:

    I love the way you write your articles explaining the stuff quite well. But I don’t understand the point of publishing an article when you cannot answer the queries!

  11. Jana says:

    [email protected] is right. After F5 object ‘customer’ becomes null. Does anyone have a solution for this?

    • akash says:

      You need to put a condition while displaying e.g. in thymeleaf you can put it like:

  12. Param says:

    I am using SessionAttributeStore and overriding storeAttribute(), but this method not getting called. Also I am using . Pls share your idea.

  13. Spring says:

    I v found the solution somewhere for the problem of Flash Object full when f5 is hit after redirect…

    We can check first if inputMap exists or not… if exists, it is part or PRG flow and if not we will redirect user to other or ??

    @RequestMapping(value=&quot;/success.html&quot;, method=RequestMethod.GET) public String successView(HttpServletRequest request){ Map&lt;String,?&gt; map = RequestContextUtils.getInputFlashMap(request); if (map!=null) return &quot;success&quot;; else return &quot;redirect:someOtherView&quot;;

  14. Navaeet says:

    Thanks for this example its very useful in some cases…

Leave a Reply

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