Spring MVC基本配置
前言
原创文章转载请注明出处,文中错误欢迎指正。
使用Spring MVC已经有很长一段时间了,但在使用中还有存在一些模棱两可的细节,趁这次机会争取将所有的这些问题一一解决,以便今后更加熟练地使用这个框架来解决问题。
创建一个基于Maven的Web项目
使用的IDE是IDEA,简单介绍一下步骤:
- 新建一个空的maven类型的module;
- 为这个module添加web支持(本质上是在
src/main/
下面添加了一个webapp
目录,其中webapp
目录包含WEB-INF/web.xml
目录和文件)。事实上,webapp这个目录的名字可以随便取,但是需要在IDEA中配置这个目录的路径,以便于在打包的时候,IDEA可以帮你将该目录中的内容复制到项目的根目录下;
添加Spring MVC的maven依赖
使用maven管理jar包依赖非常的方便。对于Spring MVC而言,只需要引入一个依赖。在项目的pom.xml
文件中添加spring-webmvc
的依赖:
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-webmvc</artifactId>
<version>3.2.3.RELEASE</version>
</dependency>
之后,maven会自动解决依赖,并把其依赖的所有jar包引入,如下图所示:
maven自动引入了所有依赖的jar包由上图可见,在Spring3.2.3中,Spring MVC依赖了如下几个包:
- spring-beans:
- spring-context:
- spring-aop:
- spring-core:
- spring-web:
- spring-expression:
- commons-logging:
- aopalliance:
配置Spring MVC
首先,在resources目录
下面添加一个config目录
,在config目录
中创建一个名为spring-mvc-config.xml
的文件(resouces/config/spring-mvc-config.xml)来作为Spring MVC的配置文件。这个文件的名字可以随便取,因为之后我们可以在web.xml
文件中自定义指定这个文件的位置和名称。
配置web.xml
文件
Spring MVC之所以可以整合到web应用中,是通过名为一个由框架提供的名为DispatcherServlet
的servlet拦截请求实现的。因此,在web.xml
中添加这个servlet,如下:
<?xml version="1.0" encoding="UTF-8"?>
<web-app version="2.5" xmlns="http://java.sun.com/xml/ns/javaee"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd">
<servlet>
<servlet-name>springmvc-app</servlet-name>
<servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
<init-param>
<param-name>contextConfigLocation</param-name>
<param-value>classpath:config/spring-mvc-config.xml</param-value>
</init-param>
<load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
<servlet-name>springmvc-app</servlet-name>
<url-pattern>/</url-pattern>
</servlet-mapping>
</web-app>
需要注意两点:
-
<init-param>
中指定了该servlet启动时的参数contextConfigLocation
,这个参数的值用来指定Spring MVC的配置文件的位置。 -
<load-on-startup>
通常应为正整数,指定启动顺序,值越小优先级越高。此处设置为1
表示第一个启动。
<url-pattern>
写成/
和/*
的区别
注意到,<servlet-mapping>
中的<url-pattern>
参数为/
,而如果写成/*
又有什么区别呢?
先看结论:
-
<url-pattern>/</url-pattern>
:会匹配到/springmvc
这样的路径型url,不会匹配到模式为*.jsp
这样的后缀型url。 -
<url-pattern>/*</url-pattern>
:会匹配所有的url:路径型的和后缀型的url(包括/springmvc,.jsp,.js和*.html等)。
下面是关于这个问题在stack overflow上的解释:
原文链接:http://stackoverflow.com/questions/4140448/difference-between-and-in-servlet-mapping-url-pattern
简单的翻译如下:
<url-pattern>/*</url-pattern>
这种形式将会覆盖所有其它的servlet。不管你发出了什么样的请求,最终都会在这个servlet中结束。因此,对于servlet来说,这是一个很糟糕的URL模式。通常来讲,你只会想要在一个Filter中使用这种模式。它可以通过调用doFilter()方法来使请求继续。
<url-pattern>/</url-pattern>
这种形式不会覆盖任何其它的servlet。它仅仅替换了servlet容器中内建的默认servlet。这种形式通常只用来请求静态资源(CSS/JS/image等)和展示目录的列表。servlet容器内建的默认servlet同样可以处理HTTP cache请求、媒体(声音/视频)流以及文件的下载。通常来说,你不会想要覆盖这个默认的servlet,否则,你将不得不自己处理一些琐碎的任务。因此,对于sevlet来说,这同样是一个糟糕的URL模式。说到为什么JSP页面的请求并不会命中这个servlet,那是因为servlet容器内建的JSP servlet将会被调用,而这个容器内建的JSP servlet已经默认地映射在了*.jsp
上。
<url-pattern></url-pattern>
这种空串的形式。当上下文的根被请求的时候,它将被调用。这与<welcome-file>
的方式是不同的,因为这种形式在当任何子目录被请求的时候不会被调用。当你期望一个“首页servlet”的时候,这种URL模式就是适合你的。
配置spring-mvc-config.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"
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">
<context:component-scan base-package="me.johnshen.springmvc.controller"/>
<bean id="viewResolver"
class="org.springframework.web.servlet.view.InternalResourceViewResolver">
<property name="prefix" value="/WEB-INF/views/jsp/"/>
<property name="suffix" value=".jsp"/>
</bean>
</beans>
使用注解标识Controller类
package me.johnshen.springmvc.controller;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
@Controller
@RequestMapping("/springmvc")
public class HelloWorldController {
@RequestMapping("/helloworld")
public String sayHello(){
System.out.println("Hello World!");
return "helloworld";
}
}
@Controller
表示该类作为项目的控制器组件;
类级别的@RequestMapping
表示所有该类中方法级别的@RequestMapping
都要相对于这个类级别的@RequestMapping
的值;
方法级别的@RequestMapping
相对于类级别@RequestMapping
的映射路径。
请求的处理过程
当有请求http://localhost:8080/springmvc/helloworld
时,请求会被Spring MVC的DispatcherServlet
拦截,并映射到HelloWorldController
的sayHello()
方法上处理。
返回的helloworld
将被交给配置在spring-mvc-config.xml
文件中的InternalResourceViewResolver
视图处理器处理。
这个处理器的配置将controller中返回的字符串"success",加上前缀"/WEB-INF/views/jsp/",加上后缀".jsp",拼成资源的完整路径"/WEB-INF/views/jsp/helloworld.jsp",最后返回该jsp视图。