作为一名Java开发者,第一次接触SpringMVC框架时总会遇到各种配置问题。记得我刚开始学习时,光是搭建一个最简单的Hello World程序就花了整整一天时间。本文将带你从零开始,在IntelliJ IDEA中快速搭建一个SpringMVC入门项目,避开那些新手常踩的坑。
这个入门程序虽然简单,但包含了SpringMVC最核心的配置要素:DispatcherServlet配置、视图解析器设置、控制器编写和JSP页面渲染。通过这个案例,你不仅能快速上手SpringMVC开发,还能理解MVC模式在Spring框架中的具体实现方式。
我强烈推荐使用IntelliJ IDEA Ultimate版进行Spring开发,社区版虽然免费但缺少对Spring框架的原生支持。最新版本的IDEA(2023.2+)已经内置了Spring Initializr,可以快速生成项目骨架。
注意:如果你使用的是社区版,需要手动添加Spring插件。在File > Settings > Plugins中搜索"Spring Boot"并安装。
创建完成后,我们需要手动添加Spring MVC依赖。打开pom.xml文件,在
xml复制<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-webmvc</artifactId>
<version>5.3.23</version>
</dependency>
<dependency>
<groupId>javax.servlet</groupId>
<artifactId>javax.servlet-api</artifactId>
<version>4.0.1</version>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>javax.servlet.jsp</groupId>
<artifactId>javax.servlet.jsp-api</artifactId>
<version>2.3.3</version>
<scope>provided</scope>
</dependency>
由于我们创建的是普通Maven项目,需要手动添加Web支持:
这会在src/main下创建webapp目录,其中包含WEB-INF/web.xml文件。这是传统的Java Web应用配置方式,虽然Spring Boot已经很少使用这种方式,但对于理解SpringMVC原理很有帮助。
DispatcherServlet是SpringMVC的核心,所有请求都会先经过它。我们需要在web.xml中配置:
xml复制<servlet>
<servlet-name>dispatcher</servlet-name>
<servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
<init-param>
<param-name>contextConfigLocation</param-name>
<param-value>/WEB-INF/spring-mvc.xml</param-value>
</init-param>
<load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
<servlet-name>dispatcher</servlet-name>
<url-pattern>/</url-pattern>
</servlet-mapping>
这里有几个关键点:
在WEB-INF目录下创建spring-mvc.xml文件,添加基本配置:
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">
<!-- 启用注解驱动 -->
<mvc:annotation-driven/>
<!-- 组件扫描 -->
<context:component-scan base-package="com.example.controller"/>
<!-- 视图解析器 -->
<bean class="org.springframework.web.servlet.view.InternalResourceViewResolver">
<property name="prefix" value="/WEB-INF/views/"/>
<property name="suffix" value=".jsp"/>
</bean>
</beans>
这个配置做了三件事:
经验之谈:在实际项目中,我建议将配置文件拆分为多个,比如单独的数据源配置、安全配置等。但对于入门项目,一个配置文件更简单明了。
在src/main/java下创建com.example.controller包,然后新建HelloController.java:
java复制package com.example.controller;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.GetMapping;
@Controller
public class HelloController {
@GetMapping("/hello")
public String sayHello(Model model) {
model.addAttribute("message", "Hello, Spring MVC!");
return "hello";
}
}
这个简单的控制器:
在webapp/WEB-INF下创建views目录,然后新建hello.jsp:
jsp复制<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
<title>Spring MVC Demo</title>
</head>
<body>
<h1>${message}</h1>
</body>
</html>
这个JSP页面非常简单,只是显示控制器传递过来的message属性。注意我们使用了EL表达式${message}来获取模型数据。
现在我们需要配置一个Servlet容器来运行应用:
避坑指南:确保选择的是"war exploded"而不是普通的war,这样修改代码后可以热部署,无需重新启动服务器。
点击IDEA右上角的绿色运行按钮启动Tomcat。如果一切正常,你将在控制台看到Spring初始化日志,最后显示"Initialization completed in X ms"。
打开浏览器,访问http://localhost:8080/hello(如果你的Application context不是"/",需要加上相应前缀,如http://localhost:8080/your-context/hello)
你应该能看到页面显示"Hello, Spring MVC!",这说明你的第一个SpringMVC程序运行成功了!
404错误:
500错误:
JSP不渲染:
虽然我们的入门项目已经可以运行,但从工程化角度还有一些改进空间:
日志配置:
添加Logback或Log4j2依赖,在resources目录下添加日志配置文件
静态资源处理:
在spring-mvc.xml中添加:
xml复制<mvc:resources mapping="/resources/**" location="/resources/"/>
这样可以把JS/CSS/images放在webapp/resources目录下
异常处理:
创建@ControllerAdvice类统一处理异常
多环境配置:
使用Spring的Profile功能区分dev/test/prod环境
测试支持:
添加spring-test依赖,编写单元测试和集成测试
现代Spring开发更推荐使用Java配置而非XML。我们可以创建一个配置类替代spring-mvc.xml:
java复制@Configuration
@EnableWebMvc
@ComponentScan("com.example.controller")
public class WebConfig implements WebMvcConfigurer {
@Bean
public ViewResolver viewResolver() {
InternalResourceViewResolver resolver = new InternalResourceViewResolver();
resolver.setPrefix("/WEB-INF/views/");
resolver.setSuffix(".jsp");
return resolver;
}
@Override
public void configureDefaultServletHandling(
DefaultServletHandlerConfigurer configurer) {
configurer.enable();
}
}
然后在web.xml中改为:
xml复制<servlet>
<servlet-name>dispatcher</servlet-name>
<servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
<init-param>
<param-name>contextClass</param-name>
<param-value>org.springframework.web.context.support.AnnotationConfigWebApplicationContext</param-value>
</init-param>
<init-param>
<param-name>contextConfigLocation</param-name>
<param-value>com.example.config.WebConfig</param-value>
</init-param>
</servlet>
这种配置方式更加类型安全,也便于维护。不过对于初学者,理解XML配置有助于掌握SpringMVC的工作原理。