P/S: I created a Maven Archetype project to create a Spring MVC project easier. You can see more here.
In this tutorial, I will show you the basic steps to create a Spring web application by using Spring Legacy Project in Spring Tool Suite IDE. These are the basic steps that I usually did, you can apply it as a reference.
Create a new project using Spring Legacy Project
I am using Spring Tool Suite IDE version 3.9.16.RELEASE. Currently, you can download the latest version of Spring Tool Suite 3 at https://github.com/spring-projects/toolsuite-distribution/wiki/Spring-Tool-Suite-3.
To create a new Spring web project, let go to File, choose New and select Spring Legacy Project. A new window will appear as below:
In the Project name field, let enter your project name and in the Templates field, let choose Spring MVC Project as below:
Now, let press Next button.
Spring Tool Suite will download the template for Spring MVC Project, so choose Yes button if you see following window:
After downloading, Spring Tool Suite will appear new window.
In this new window, let enter the package name for your project. For example, I enter com.huongdanjava.springmvc.
After that, let press Finish button to Spring Tool Suite create new project for us.
Result:
Revise the project to suit your needs
Expand project nodes to see what we have.
Here, we have a Controller in the package com.huongdanjava.springmvc named HomeController. This controller by default will handle the welcome page when we run the web application. This is not needed for editing yet.
Next, we have a log4j.xml file in the main resource and similarly a log4j.xml file in test resource. This is not needed for editing yet.
Inside the WEB-INF directory of the src/main/webapp/ directory, we have the spring directory containing all Spring configurations. We also do not need to change this.
Also in the src/main/webapp directory, we have a views directory. Inside the views folder, we have the home.jsp file to display the welcome page.
And finally what I want to say here is the Maven pom.xml file. We will need to edit the pom.xml file to upgrade the version of the libraries to the latest. The current version of dependencies is evident in:
|
1 2 3 4 5 6 |
<properties> <java-version>1.6</java-version> <org.springframework-version>3.1.1.RELEASE</org.springframework-version> <org.aspectj-version>1.6.10</org.aspectj-version> <org.slf4j-version>1.6.6</org.slf4j-version> </properties> |
The declaration of “java-version” property here, according to me, is not necessary. We should declare the “maven.compiler.source” and “maven.compiler.target” properties so that Maven knows the Java version we need to use for our project with Maven Compiler Plugin. In the plugin declaration section in pom.xml file, the Maven Compiler Plugin plugin is also declared, please upgrade it to the latest version and remove config source and target!
|
1 2 3 4 5 6 7 8 9 10 |
<plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-compiler-plugin</artifactId> <version>3.8.1</version> <configuration> <compilerArgument>-Xlint:all</compilerArgument> <showWarnings>true</showWarnings> <showDeprecation>true</showDeprecation> </configuration> </plugin> |
Spring framework is now 5.3.6.
AspectJ and slf4j if you use it in your project, you should upgrade to latest version.
|
1 2 3 4 5 6 7 |
<properties> <maven.compiler.source>1.8</maven.compiler.source> <maven.compiler.target>1.8</maven.compiler.target> <org.springframework-version>5.3.6</org.springframework-version> <org.aspectj-version>1.9.6</org.aspectj-version> <org.slf4j-version>1.7.30</org.slf4j-version> </properties> |
Result:
