Configuring SpringMVC with Maven in Eclipse
Creating a Maven Project in Eclipse
To begin, create a new Maven project in Eclipse by selecting File → New → Maven Project. Choose the maven-archetype-webapp archetype to set up a web application structure.
Provide the project coordinates including GroupId, ArtifactId, and Version. These identifiers help in uniquely identifying your project and managing dependencies.
After project creation, right-click on the project and navigate to Properties → Build Path. Resolve any missing files by adding the required JARs to the build path.
Configuring Maven Repository
When adding Spring dependencies, you might encounter repository access issues. To resolve this, configure Maven to use a local repository and set up a mirror for faster downloads.
In your Maven installation directory, edit the conf/settings.xml file to specify your local repository path:
<localRepository>D:\Maven\repository</localRepository>
Add the following mirror configuration within the
<mirror>
<id>nexus-aliyun</id>
<mirrorOf>*</mirrorOf>
<name>Nexus aliyun</name>
<url>http://maven.aliyun.com/nexus/content/groups/public</url>
</mirror>
Execute the following command in your terminal to download required JARs:
mvn help:system
Adding SpringMVC Dependencies
Configure the necessary Spring dependencies in your pom.xml file. Pay attention to version consistency between dependencies and your project configuration.
If you encounter version compatibility issues with web.xml (configured for Servlet 3.0), ensure your project facet version matches. This can be adjusted in the .settings/org.eclipse.wst.common.project.facet.core.xml file.
When working with Spring 5.0, avoid adding version numbers to XSD namespaces in configuration files as this can cause parsing errors.
Ensure proper resource loading by configuring the correct classpath locations in your Spring configuration files. Duplicate or incorrect path configurations can lead to 404 errors.
Code Implementation
pom.xml Configuration
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.example.web</groupId>
<artifactId>WebAppDemo</artifactId>
<packaging>war</packaging>
<version>1.0.0-SNAPSHOT</version>
<name>WebAppDemo Maven Webapp</name>
<url>http://maven.apache.org</url>
<properties>
5.0.0.RELEASE
1.1.3
3.0.1
2.2
3.8.1
1.8
1.2
1.1.2
2.3.2
</properties>
<dependencies>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-core</artifactId>
<version>${spring.version}</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-beans</artifactId>
<version>${spring.version}</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-context</artifactId>
<version>${spring.version}</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-jdbc</artifactId>
<version>${spring.version}</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-expression</artifactId>
<version>${spring.version}</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-web</artifactId>
<version>${spring.version}</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-webmvc</artifactId>
<version>${spring.version}</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-tx</artifactId>
<version>${spring.version}</version>
</dependency>
<dependency>
<groupId>javax.servlet</groupId>
<artifactId>jstl</artifactId>
<version>${jstl.version}</version>
</dependency>
<dependency>
<groupId>taglibs</groupId>
<artifactId>standard</artifactId>
<version>${standard.version}</version>
</dependency>
<dependency>
<groupId>javax.servlet</groupId>
<artifactId>javax.servlet-api</artifactId>
<version>${servlet.version}</version>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>javax.servlet.jsp</groupId>
<artifactId>jsp-api</artifactId>
<version>${jsp-api.version}</version>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>${junit.version}</version>
<scope>test</scope>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<version>${maven.compiler.plugin.version}</version>
<configuration>
<source>${jdk.version}</source>
<target>${jdk.version}</target>
</configuration>
</plugin>
</plugins>
<finalName>WebAppDemo</finalName>
</build>
</project>
web.xml Configuration
spring-mvc-demo
contextConfigLocation
classpath:spring-context.xml
<listener>
org.springframework.web.context.ContextLoaderListener
</listener>
<servlet>
dispatcher
org.springframework.web.servlet.DispatcherServlet
contextConfigLocation
classpath:spring-mvc.xml
1
</servlet>
dispatcher
*.do
<filter>
CharacterEncodingFilter
org.springframework.web.filter.CharacterEncodingFilter
encoding
UTF-8
forceEncoding
true
</filter>
CharacterEncodingFilter
/*
index.jsp
Spring MVC Configuration
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:context="http://www.springframework.org/schema/context"
xmlns:aop="http://www.springframework.org/schema/aop"
xmlns:mvc="http://www.springframework.org/schema/mvc"
xmlns:p="http://www.springframework.org/schema/p"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
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
http://www.springframework.org/schema/aop
http://www.springframework.org/schema/aop/spring-aop.xsd">
<bean class="org.springframework.http.converter.StringHttpMessageConverter" />
<bean class="org.springframework.http.converter.ResourceHttpMessageConverter" />
<bean id="viewResolver"
class="org.springframework.web.servlet.view.InternalResourceViewResolver">
<property name="viewClass"
value="org.springframework.web.servlet.view.JstlView" />
<property name="prefix" value="/WEB-INF/views/" />
<property name="suffix" value=".jsp" />
</bean>
</beans>
Spring Context Configuration
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:mvc="http://www.springframework.org/schema/mvc"
xmlns:context="http://www.springframework.org/schema/context"
xmlns:tx="http://www.springframework.org/schema/tx"
xmlns:util="http://www.springframework.org/schema/util"
xmlns:aop="http://www.springframework.org/schema/aop"
xsi:schemaLocation="http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans.xsd
http://www.springframework.org/schema/mvc
http://www.springframework.org/schema/mvc/spring-mvc.xsd
http://www.springframework.org/schema/context
http://www.springframework.org/schema/context/spring-context.xsd
http://www.springframework.org/schema/util
http://www.springframework.org/schema/util/spring-util.xsd
http://www.springframework.org/schema/tx
http://www.springframework.org/schema/tx/spring-tx.xsd
http://www.springframework.org/schema/aop
http://www.springframework.org/schema/aop/spring-aop.xsd">
</beans>
Controller Implementation
package com.example.web.controller;
import javax.servlet.http.HttpServletRequest;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.servlet.ModelAndView;
@Controller
@RequestMapping("/home")
public class HomeController {
@RequestMapping(value="/welcome.do")
public ModelAndView getWelcome(HttpServletRequest request){
ModelAndView modelAndView = new ModelAndView("welcome");
modelAndView.addObject("message", "Welcome to Spring MVC with Maven");
return modelAndView;
}
}
JSP View
Create a folder named "views" in the WEB-INF directory and add a welcome.jsp file:
<%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%>
<%@ taglib uri="http://java.sun.com/jsp/jstl/core" prefix="c" %>
<html>
<head>
<meta charset="UTF-8">
<title>Spring MVC Demo</title>
</head>
<body>
<h1>${message}</h1>
<p>This is a Spring MVC application configured with Maven.</p>
</body>
</html>
Project Structure
Your final project structure should look like this:
- src/main/java
- com/example/web/controller
- HomeController.java
- com/example/web/controller
- src/main/resources
- spring-context.xml
- spring-mvc.xml
- src/main/webapp
- WEB-INF
- views
- welcome.jsp
- web.xml
- views
- index.jsp
- WEB-INF