2.3. First application based on Spring MVC¶

Index

Prerequisites
Create a New Project
Run on Server
Create an Echo Application

Before entering into the advanced usage of Spring MVC, it is better to understand Spring MVC by actually trying hands-on web application development using Spring MVC.

2.3.1. Prerequisites ¶

The description of this chapter has been verified on the following environment. (For other environments, replace the contents mentioned here appropriately)

Classification	Product
OS	Windows 7
JVM	Java 1.8
IDE	Spring Tool Suite 3.6.4.RELEASE (Hereafter referred as [STS])
Build Tool	Apache Maven 3.3.9 (Hereafter referred as [Maven])
Application Server	Pivotal tc Server Developer Edition v3.1 (enclosed in STS)
Web Browser	Google Chrome 46.0.2490.80 m

Note

To connect the internet via proxy server, STS Proxy settings and Maven Proxy settings are required for the following operations.

As stated earlier in [explanation of Controller (6)] the object (serverTime) set in Model is stored in HttpServletRequest. Therefore the value passed from Controller can be output by mentioning ${serverTime} in JSP.

However about ${XXX}, it is necessary to perform HTML escaping since there is possibility of XSS attack.

2.3.3. Run on Server ¶

Right click “helloworld” project in STS, and start helloworld project by executing “Run As” -> “Run On Server” -> “localhost” -> “Pivotal tc Server Developer Edition v3.0” -> “Finish”.

Enter “http://localhost:8080/helloworld/” in browser to display the following screen.

Note

Since tc Server internally uses the Tomcat, it is possible to choose below two versions in the STS.

tomcat-8.0.15.A.RELEASE (version used by default)
tomcat-7-0.57.A.RELEASE

If you want to switch the Tomcat to be used, change the [Version] field of ts Server by opening the [Edit Server Runtime Environment] dialog box. Java (JRE) version can also be changed from this dialog box.

2.3.4. Create an Echo Application ¶

Lets go ahead and create a simple application. It is a typical eco application in which message will be displayed if name is entered in the text field as given below.

2.3.4.1. Creating a form object ¶

First create a form object to accept the value of text field.

Create EchoForm class under com.example.helloworld.app.echo package. It is a simple JavaBean that has only one1 property.

package com.example.helloworld.app.echo;

import java.io.Serializable;

public class EchoForm implements Serializable {
    private static final long serialVersionUID = 2557725707095364445L;

    private String name;

    public void setName(String name) {
        this.name = name;
    }

    public String getName() {
        return name;
    }
}

2.3.4.2. Create a Controller ¶

Next, create the Controller class.

create the EchoController class under com.example.helloworld.app.echo package.

package com.example.helloworld.app.echo;

import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.ModelAttribute;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;

@Controller
@RequestMapping("echo")
public class EchoController {

    @ModelAttribute // (1)
    public EchoForm setUpEchoForm() {
        EchoForm form = new EchoForm();
        return form;
    }

    @RequestMapping // (2)
    public String index(Model model) {
        return "echo/index"; // (3)
    }

    @RequestMapping(value = "hello", method = RequestMethod.POST) // (4)
    public String hello(EchoForm form, Model model) {// (5)
        model.addAttribute("name", form.getName()); // (6)
        return "echo/hello";
    }
}

Sr. No.	Description
(1)	Add `@ModelAttribute` annotation to the method. Return value of such a method is automatically added to the Model. Attribute name of the Model can be specified in `@ModelAttribute`, but the class name with the first letter in lower case is the default attribute name. In this case it will be “echoForm”. This attribute name must match with the value of `modelAttribute` of `form:form tag`.
(2)	When nothing is specified in `value` attribute of `@RequestMapping` annotation at the method level, it is mapped to `@RequestMapping` added at class level. In this case, `index` method is called, if “<contextPath>/echo” is accessed. When nothing is set in `method` attribute, mapping is done for any HTTP method.
(3)	Since “echo/index” is returned as View name, “WEB-INF/views/echo/index.jsp” is rendered by the ViewResolver.
(4)	Since “hello” is specified in `value` attribute and `RequestMethod.POST` is specified in `method` attribute of the `@RequestMapping` annotation method, if “<contextPath>/echo/hello” is accessed with POST method, `hello` method is called.
(5)	EchoForm object added to the model in (1) is passed as argument.
(6)	`name` entered in form is passed as it is to the View.

Note

The value specified in the method attribute of @RequestMapping annotation is generally varied by how the data transmitted from the client.

POST method in case of storing data to the server (in case of updating process).
GET method or unspecified (any method) in case of not storing data to the server (in case of referring process).

In echo application,

index method is not going to save data to the server, it is unspecified (any method)
hello method is going to save data into Model object, it is POST method

etc are specified.

2.3.4.3. Create JSP Files ¶

Finally create JSP for input screen and output screen. Each file path must match with View name as follows.

Create input screen (src/main/webapp/WEB-INF/views/echo/index.jsp).

<!DOCTYPE html>
<html>
<head>
<title>Echo Application</title>
</head>
<body>
  <%-- (1) --%>
  <form:form modelAttribute="echoForm" action="${pageContext.request.contextPath}/echo/hello">
    <form:label path="name">Input Your Name:</form:label>
    <form:input path="name" />
    <input type="submit" />
  </form:form>
</body>
</html>

Sr. No.	Description
(1)	HTML form is constructed using tag library. Specify the name of form object created by Controller in `modelAttribute` attribute. Refer here for tag library.

Note

POST method is used if method attribute of <form:form> tag is omitted.

The generated HTML is as follows

<!DOCTYPE html>
<html>
<head>
<title>Echo Application</title>
</head>
<body>
  <form id="echoForm" action="/helloworld/echo/hello" method="post">
    <label for="name">Input Your Name:</label>
    <input id="name" name="name" type="text" value=""/>
    <input type="submit" />
  <input type="hidden" name="_csrf" value="43595f38-3edd-4c08-843b-3c31a00d2b15" />
</form>
</body>
</html>

Create output screen (src/main/webapp/WEB-INF/views/echo/hello.jsp).

<!DOCTYPE html>
<html>
<head>
<title>Echo Application</title>
</head>
<body>
  <p>
    Hello <c:out value="${name}" /> <%-- (2) --%>
  </p>
</body>
</html>

Sr. No.	Description
(2)	Output “name” passed from Controller. Take countermeasures for XSS using `c:out` tag.

Note

Here, XSS countermeasure taken using c:out standard tag, however, f:h() function provided in common library can be used easily. Refer to XSS Countermeasures for details.

Implementation of Eco application is completed here.

Start the server and form will be displayed by accessing “http://localhost:8080/helloworld/echo”.

2.3.4.4. Implement Input Validation ¶

Till this point Input validation is not implemented in this application. In Spring MVC, Bean Validation and annotation based input validation can be easily implemented. For example name input validation is performed in Eco Application.

Add annotation for Input check rule to the name of EchoForm.

package com.example.helloworld.app.echo;

import java.io.Serializable;

import javax.validation.constraints.NotNull;
import javax.validation.constraints.Size;

public class EchoForm implements Serializable {
    private static final long serialVersionUID = 2557725707095364445L;

    @NotNull // (1)
    @Size(min = 1, max = 5) // (2)
    private String name;

    public void setName(String name) {
        this.name = name;
    }

    public String getName() {
        return name;
    }
}

Sr. No.	Description
(1)	Whether `name` parameter exists in HTTP request or not can be checked by `@NotNull` annotation.
(2)	Whether the size of `name` is more than or equal to 1 and less than or equal to 5 can be checked by `@Size(min = 1, max = 5)`.

Implement the input check and the error handling when an error occurs in the input check.

package com.example.helloworld.app.echo;

import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.validation.BindingResult;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.ModelAttribute;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;

@Controller
@RequestMapping("echo")
public class EchoController {

    @ModelAttribute
    public EchoForm setUpEchoForm() {
        EchoForm form = new EchoForm();
        return form;
    }

    @RequestMapping
    public String index(Model model) {
        return "echo/index";
    }

    @RequestMapping(value = "hello", method = RequestMethod.POST)
    public String hello(@Validated EchoForm form, BindingResult result, Model model) { // (1)
        if (result.hasErrors()) { // (2)
            return "echo/index";
        }
        model.addAttribute("name", form.getName());
        return "echo/hello";
    }
}

Sr. No.	Description
(1)	In Controller, add `@Validated` annotation to the argument on which validation needs to be executed. Also add `BindingResult` object to the arguments. Input validation is automatically performed using Bean Validation and the result is stored in `BindingResult` object.
(2)	Error can be checked by executing `hasErrors` method. If there is an input error, it returns View name to display the input screen.

Add the implementation of displaying input error message on input screen (src/main/webapp/WEB-INF/views/echo/index.jsp).

<!DOCTYPE html>
<html>
<head>
<title>Echo Application</title>
</head>
<body>
  <form:form modelAttribute="echoForm" action="${pageContext.request.contextPath}/echo/hello">
    <form:label path="name">Input Your Name:</form:label>
    <form:input path="name" />
    <form:errors path="name" cssStyle="color:red" /><%-- (1) --%>
    <input type="submit" />
  </form:form>
</body>
</html>

Sr. No.	Description
(1)	Add `form:errors` tag for displaying error message when an error occurs on input screen.

Implementation of input validation is completed.

Error message is displayed in the following conditions:

When an empty name is sent
Size is more than 5 characters.

Validation Error (name's size is over 5)

The generated HTML is as follows.

<!DOCTYPE html>
<html>
<head>
<title>Echo Application</title>
</head>
<body>
  <form id="echoForm" action="/helloworld/echo/hello" method="post">
    <label for="name">Input Your Name:</label>
    <input id="name" name="name" type="text" value=""/>
    <span id="name.errors" style="color:red">size must be between 1 and 5</span>
    <input type="submit" />
  <input type="hidden" name="_csrf" value="6e94a78d-4a2c-4a41-a514-0a60f0dbedaf" />
</form>
</body>
</html>

2.3.4.5. Summary ¶

The following are the learnings from this chapter.

How to create blank project using mvn archetype:generate.
Basic Spring MVC configuration set-up
Simplified level screen transition
Way to pass values between screens
Simple input validation

If above points are still not understood, it is recommended to read this chapter again and start again from building the environment.

Table Of Contents

Previous topic

Next topic

This Page

2.3. First application based on Spring MVC¶

2.3.1. Prerequisites ¶

2.3.2. Create a New Project ¶

2.3.3. Run on Server ¶

2.3.4. Create an Echo Application ¶

2.3.4.1. Creating a form object ¶

2.3.4.2. Create a Controller ¶

2.3.4.3. Create JSP Files ¶

2.3.4.4. Implement Input Validation ¶

2.3.4.5. Summary ¶

Sr. No.	Description
(1)	Default settings of Spring MVC are configured by defining `<mvc:annotation-driven>`. Refer to the official website Enabling the MVC Java Config or the MVC XML Namespace for default configuration of Spring framework.
(2)	Define the package which will be target of searching components used in Spring MVC.
(3)	Define the location of the JSP by specifying `ViewResolver` for JSP. Tip `<mvc:view-resolvers>` element is a XML element that added from Spring Framework 4.1. By using `<mvc:view-resolvers>` element, it is possible to define `ViewResolver` simply. The definition example of using the conventional `<bean>` element is shown below. <bean id="viewResolver" class="org.springframework.web.servlet.view.InternalResourceViewResolver"> <property name="prefix" value="/WEB-INF/views/" /> <property name="suffix" value=".jsp" /> </bean>

Sr. No.	Description
(4)	It can be read automatically by DI container if `@Controller` annotation is used. As stated earlier in [explanation of Spring MVC configuration files (2)], it is the target of component-scan.
(5)	It gets executed when the HTTP method is GET or POST and the Resource is (or request URL) is “/”.
(6)	Set `Model` object to be delivered to View.
(7)	Return View name. “WEB-INF/views/welcome/home.jsp” is rendered as per the configuration [Explanation of Spring MVC configuration files (3)] .