Spring-DispatcherServlet说明

最新推荐文章于 2023-12-05 10:28:30 发布

Young4Dream

最新推荐文章于 2023-12-05 10:28:30 发布

阅读量691

点赞数

分类专栏： Spring

Spring 专栏收录该内容

16 篇文章 0 订阅

订阅专栏

DispatcherServlet说明

使用Spring MVC,配置DispatcherServlet是第一步。

DispatcherServlet是一个Servlet,所以可以配置多个DispatcherServlet。

DispatcherServlet是前置控制器，配置在web.xml文件中的。拦截匹配的请求，Servlet拦截匹配规则要自已定义，把拦截下来的请求，依据某某规则分发到目标Controller(我们写的Action)来处理。

“某某规则”：是根据你使用了哪个HandlerMapping接口的实现类的不同而不同。

先来看第一个例子：

Xml代码

1. <web-app>

2. <servlet>

3. <servlet-name>example</servlet-name>

4. <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>

5. <load-on-startup>1</load-on-startup>

6. </servlet>

7. <servlet-mapping>

8. <servlet-name>example</servlet-name>

9. <url-pattern>*.form</url-pattern>

10. </servlet-mapping>

11. </web-app>

<load-on-startup>1</load-on-startup>是启动顺序，让这个Servlet随Servletp容器一起启动。

<url-pattern>*.form</url-pattern>会拦截*.form结尾的请求。

<servlet-name>example</servlet-name>这个Servlet的名字是example，可以有多个DispatcherServlet，是通过名字来区分的。每一个DispatcherServlet有自己的WebApplicationContext上下文对象。同时保存的ServletContext中和Request对象中，关于key，以后说明。

在DispatcherServlet的初始化过程中，框架会在web应用的WEB-INF文件夹下寻找名为[servlet-name]-servlet.xml的配置文件，生成文件中定义的bean。

第二个例子：

Xml代码

1. <servlet>

2. <servlet-name>springMVC</servlet-name>

3. <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>

4. <init-param>

5. <param-name>contextConfigLocation</param-name>

6. <param-value>classpath*:/springMVC.xml</param-value>

7. </init-param>

8. <load-on-startup>1</load-on-startup>

9. </servlet>

10. <servlet-mapping>

11. <servlet-name>springMVC</servlet-name>

12. <url-pattern>/</url-pattern>

13. </servlet-mapping>

指明了配置文件的文件名，不使用默认配置文件名，而使用springMVC.xml配置文件。

其中<param-value>**.xml</param-value>这里可以使用多种写法
1、不写,使用默认值:/WEB-INF/<servlet-name>-servlet.xml
2、<param-value>/WEB-INF/classes/springMVC.xml</param-value>
3、<param-value>classpath*:springMVC-mvc.xml</param-value>
4、多个值用逗号分隔

Servlet拦截匹配规则可以自已定义，Servlet拦截哪种URL合适？

当映射为@RequestMapping("/user/add")时：
1、拦截*.do，例如：/user/add.do，弊端：所有的url都要以.do结尾。不会影响访问静态文件。
2、拦截/app/*，例如：/app/user/add，弊端：请求的url都要包含/app，@RequestMapping("/user/add")中不须要包含/app。
3、拦截/，例如：/user/add，弊端：对jpg,js,css静态文件的访问也被拦截不能正常显示。后面有解决办法。
4、拦截/*，可以走到Action中，但转发到jsp时再次被拦截，不能访问到jsp。

五、双亲上下文的说明

如果你使用了listener监听器来加载配置，一般在Struts+Spring+Hibernate的项目中都是使用listener监听器的。如下

Java代码

1. <listener>

2. <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>

3. </listener>

Spring会创建一个全局的WebApplicationContext上下文，称为根上下文 ，保存在 ServletContext中，key是WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE属性的值。可以使用工具类取出上下文：WebApplicationContextUtils.getWebApplicationContext(ServletContext);

DispatcherServlet是一个Servlet,可以同时配置多个，每个 DispatcherServlet有一个自己的 WebApplicationContext上下文，这个上下文继承了 根上下文 中所有东西。保存在 ServletContext中，key是"org.springframework.web.servlet.FrameworkServlet.CONTEXT"+Servlet名称。当一个Request对象产生时，会把这个WebApplicationContext上下文保存在Request对象中，key是DispatcherServlet.class.getName() + ".CONTEXT"。可以使用工具类取出上下文：RequestContextUtils.getWebApplicationContext(request);

Spring中的 ApplicationContext实例可以被限制在不同的作用域（scope）中。
在web MVC框架中，每个DispatcherServlet有它自己的WebApplicationContext ，这个context继承了根 WebApplicationContext 的所有bean定义。
这些继承的bean也可以在每个serlvet自己的所属的域中被覆盖（override），覆盖后的bean 可以被设置上只有这个servlet实例自己使用的属性。

总结：不使用listener监听器来加载spring的配置，改用DispatcherServlet来加载spring的配置，不要双亲上下文，只使用一个DispatcherServlet，事情就简单了，什么麻烦事儿也没有了。

六、springMVC-mvc.xml配置文件片段讲解 （未使用默认配置文件名）

Xml代码

1.

2. <context:component-scan base-package="com.app,com.core,JUnit4" ></context:component-scan>

4.

5. <mvc:annotation-driven />

7.

8. <bean class="org.springframework.web.servlet.view.InternalResourceViewResolver">

9. <property name="prefix" value="/WEB-INF/jsp/"/>

10. <property name="suffix" value=".jsp"/>

11. <property name="viewClass" value="org.springframework.web.servlet.view.JstlView" />

12. </bean>

13.

14.

15. <mvc:interceptors>

16. <bean class="com.core.mvc.MyInteceptor" />

17. </mvc:interceptors>

18.

19.

20. <mvc:default-servlet-handler/>

21.

22.

23. <mvc:resources mapping="/images/**" location="/images/" cache-period="31556926"/>

24. <mvc:resources mapping="/js/**" location="/js/" cache-period="31556926"/>

25. <mvc:resources mapping="/css/**" location="/css/" cache-period="31556926"/>

<context:component-scan/> 扫描指定的包中的类上的注解，常用的注解有：

@Controller 声明Action组件
@Service    声明Service组件   @Service("myMovieLister")
@Repository 声明Dao组件
@Component   泛指组件, 当不好归类时.
@RequestMapping("/menu") 请求映射
@Resource 用于注入，( j2ee提供的 ) 默认按名称装配，@Resource(name="beanName")
@Autowired 用于注入，(srping提供的) 默认按类型装配
@Transactional( rollbackFor={Exception.class}) 事务管理
@ResponseBody
@Scope("prototype")   设定bean的作用域

<mvc:annotation-driven /> 是一种简写形式，完全可以手动配置替代这种简写形式，简写形式可以让初学都快速应用默认配置方案。<mvc:annotation-driven /> 会自动注册DefaultAnnotationHandlerMapping与AnnotationMethodHandlerAdapter两个bean,是spring MVC为@Controllers分发请求所必须的。
并提供了：数据绑定支持，@NumberFormatannotation支持，@DateTimeFormat支持，@Valid支持，读写XML的支持（JAXB），读写JSON的支持（Jackson）。
后面，我们处理响应ajax请求时，就使用到了对json的支持。
后面，对action写JUnit单元测试时，要从springIOC容器中取DefaultAnnotationHandlerMapping与AnnotationMethodHandlerAdapter两个bean，来完成测试，取的时候要知道是<mvc:annotation-driven/>这一句注册的这两个bean。

<mvc:interceptors/> 是一种简写形式。通过看前面的大图，知道，我们可以配置多个HandlerMapping。<mvc:interceptors/>会为每一个HandlerMapping，注入一个拦截器。其实我们也可以手动配置为每个HandlerMapping注入一个拦截器。

<mvc:default-servlet-handler/> 使用默认的Servlet来响应静态文件。

<mvc:resourcesmapping="/images/**" location="/images/"cache-period="31556926"/> 匹配URL /images/** 的URL被当做静态资源，由Spring读出到内存中再响应http。

七、如何访问到静态的文件，如jpg,js,css？

如何你的DispatcherServlet拦截 *.do这样的URL，就不存在访问不到静态资源的问题。如果你的DispatcherServlet拦截“/”，拦截了所有的请求，同时对*.js,*.jpg的访问也就被拦截了。

目的：可以正常访问静态文件，不要找不到静态文件报404。

方案一：激活Tomcat的defaultServlet来处理静态文件

Xml代码

1. <servlet-mapping>

2. <servlet-name>default</servlet-name>

3. <url-pattern>*.jpg</url-pattern>

4. </servlet-mapping>

5. <servlet-mapping>

6. <servlet-name>default</servlet-name>

7. <url-pattern>*.js</url-pattern>

8. </servlet-mapping>

9. <servlet-mapping>

10. <servlet-name>default</servlet-name>

11. <url-pattern>*.css</url-pattern>

12. </servlet-mapping>

13. 要配置多个，每种文件配置一个

要写在DispatcherServlet的前面，让 defaultServlet先拦截，这个就不会进入Spring了，我想性能是最好的吧。

Tomcat, Jetty, JBoss, and GlassFish 默认 Servlet的名字 -- "default"
Google App Engine 默认 Servlet的名字 -- "_ah_default"
Resin 默认 Servlet的名字 -- "resin-file"
WebLogic 默认 Servlet的名字 -- "FileServlet"
WebSphere 默认 Servlet的名字 -- "SimpleFileServlet"

方案二：在spring3.0.4以后版本提供了mvc:resources
mvc:resources 的使用方法：

Xml代码

1.

2. <mvc:resources mapping="/images/**" location="/images/" />

/images/**映射到ResourceHttpRequestHandler进行处理，location指定静态资源的位置.可以是web application根目录下、jar包里面，这样可以把静态资源压缩到jar包中。cache-period 可以使得静态资源进行web cache

如果出现下面的错误，可能是没有配置<mvc:annotation-driven />的原因。
报错WARNING: Nomapping found for HTTP request with URI [/mvc/user/findUser/lisi/770] inDispatcherServlet with name 'springMVC'

使用<mvc:resources/>元素,把mapping的URI注册到SimpleUrlHandlerMapping的urlMap中,
key为mapping的URI pattern值,而value为ResourceHttpRequestHandler,
这样就巧妙的把对静态资源的访问由HandlerMapping转到ResourceHttpRequestHandler处理并返回,所以就支持classpath目录,jar包内静态资源的访问.
另外需要注意的一点是,不要对SimpleUrlHandlerMapping设置defaultHandler.因为对static uri的defaultHandler就是ResourceHttpRequestHandler,
否则无法处理staticresources request.

方案三，使用<mvc:default-servlet-handler/>

Xml代码

1. <mvc:default-servlet-handler/>

会把"/**"url,注册到SimpleUrlHandlerMapping的urlMap中,把对静态资源的访问由HandlerMapping转到org.springframework.web.servlet.resource.DefaultServletHttpRequestHandler处理并返回.
DefaultServletHttpRequestHandler使用就是各个Servlet容器自己的默认Servlet.

补充说明：多个HandlerMapping的执行顺序问题：

DefaultAnnotationHandlerMapping的order属性值是：0

<mvc:resources/ >自动注册的 SimpleUrlHandlerMapping的order属性值是： 2147483646

<mvc:default-servlet-handler/>自动注册的SimpleUrlHandlerMapping 的order属性值是： 2147483647

spring会先执行order值比较小的。当访问一个a.jpg图片文件时，先通过 DefaultAnnotationHandlerMapping 来找处理器，一定是找不到的，我们没有叫a.jpg的Action。再按order值升序找，由于最后一个 SimpleUrlHandlerMapping 是匹配 "/**"的，所以一定会匹配上，再响应图片。

访问一个图片，还要走层层匹配。真不知性能如何？改天做一下压力测试，与Apache比一比。

最后再说明一下，如何你的DispatcherServlet拦截 *.do这样的URL，就不存上述问题了。

八、请求如何映射到具体的Action中的方法？
方案一：基于xml配置映射，可以利用SimpleUrlHandlerMapping、BeanNameUrlHandlerMapping进行Url映射和拦截请求。
配置方法略。

方案二：基于注解映射，可以使用DefaultAnnotationHandlerMapping。

Xml代码

1. <bean class="org.springframework.web.servlet.mvc.annotation.DefaultAnnotationHandlerMapping"> </bean>

但前面我们配置了<mvc:annotation-driven/>，他会自动注册这个bean,就不须要我们显示的注册这个bean了。

以上都可以注入interceptors，实现权限控制等前置工作。
我们使用第2种，基于注解来使用springMVC

并在action类上使用：
@Controller
@RequestMapping("/user")

九、Spring中的拦截器：
Spring为我们提供了：
org.springframework.web.servlet.HandlerInterceptor接口，

org.springframework.web.servlet.handler.HandlerInterceptorAdapter适配器，
实现这个接口或继承此类，可以非常方便的实现自己的拦截器。

有以下三个方法：

Action之前执行:
public boolean preHandle(HttpServletRequest request,
   HttpServletResponse response, Object handler);

生成视图之前执行
public void postHandle(HttpServletRequest request,
   HttpServletResponse response, Object handler,
   ModelAndView modelAndView);

最后执行，可用于释放资源
public void afterCompletion(HttpServletRequest request,
   HttpServletResponse response, Object handler, Exception ex)

分别实现预处理、后处理（调用了Service并返回ModelAndView，但未进行页面渲染）、返回处理（已经渲染了页面）
在preHandle中，可以进行编码、安全控制等处理；
在postHandle中，有机会修改ModelAndView；
在afterCompletion中，可以根据ex是否为null判断是否发生了异常，进行日志记录。
参数中的Objecthandler是下一个拦截器。

十、如何使用拦截器？
自定义一个拦截器，要实现HandlerInterceptor接口：

Java代码

1. public class MyInteceptor implements HandlerInterceptor {

2. 略。。。

3. }

Spring MVC并没有总的拦截器，不能对所有的请求进行前后拦截。
Spring MVC的拦截器，是属于HandlerMapping级别的，可以有多个HandlerMapping ，每个HandlerMapping可以有自己的拦截器。
当一个请求按Order值从小到大，顺序执行HandlerMapping接口的实现类时，哪一个先有返回，那就可以结束了，后面的HandlerMapping就不走了，本道工序就完成了。就转到下一道工序了。
拦截器会在什么时候执行呢？一个请求交给一个HandlerMapping时，这个HandlerMapping先找有没有处理器来处理这个请求，如何找到了，就执行拦截器，执行完拦截后，交给目标处理器。
如果没有找到处理器，那么这个拦截器就不会被执行。

在spring MVC的配置文件中配置有三种方法：

方案一，（近似）总拦截器，拦截所有url

Java代码

1. <mvc:interceptors>

2. <bean class="com.app.mvc.MyInteceptor" />

3. </mvc:interceptors>

为什么叫“近似”，前面说了，Spring没有总的拦截器。

<mvc:interceptors/>会为每一个HandlerMapping，注入一个拦截器。总有一个HandlerMapping是可以找到处理器的，最多也只找到一个处理器，所以这个拦截器总会被执行的。起到了总拦截器的作用。

方案二，（近似）总拦截器，拦截匹配的URL。

Xml代码

1. <mvc:interceptors >

2. <mvc:interceptor>

3. <mvc:mapping path="/user/*" />

4. <bean class="com.mvc.MyInteceptor"></bean>

5. </mvc:interceptor>

6. </mvc:interceptors>

就是比方案一多了一个URL匹配。

方案三,HandlerMappint上的拦截器

Xml代码

1. <bean class="org.springframework.web.servlet.mvc.annotation.DefaultAnnotationHandlerMapping">

2. <property name="interceptors">

3. <list>

4. <bean class="com.mvc.MyInteceptor"></bean>

5. </list>

6. </property>

7. </bean>

如果使用了<mvc:annotation-driven />，它会自动注册DefaultAnnotationHandlerMapping 与AnnotationMethodHandlerAdapter 这两个bean,所以就没有机会再给它注入interceptors属性，就无法指定拦截器。

当然我们可以通过人工配置上面的两个Bean，不使用 <mvc:annotation-driven/>，就可以给interceptors属性注入拦截器了。

其实我也不建议使用<mvc:annotation-driven/>，而建议手动写配置文件，来替代 <mvc:annotation-driven />，这就控制力就强了。

十一、如何实现全局的异常处理？

在spring MVC的配置文件中：

Xml代码

1.

2. <bean id="exceptionResolver" class="org.springframework.web.servlet.handler.SimpleMappingExceptionResolver">

3. <property name="defaultErrorView">

4. <value>/error/error</value>

5. </property>

6. <property name="defaultStatusCode">

7. <value>500</value>

8. </property>

9. <property name="warnLogCategory">

10. <value>org.springframework.web.servlet.handler.SimpleMappingExceptionResolver</value>

11. </property>

12. </bean>

这里主要的类是SimpleMappingExceptionResolver类，和他的父类AbstractHandlerExceptionResolver类。

具体可以配置哪些属性，我是通过查看源码知道的。

你也可以实现HandlerExceptionResolver接口，写一个自己的异常处理程序。spring的扩展性是很好的。

通过SimpleMappingExceptionResolver我们可以将不同的异常映射到不同的jsp页面（通过exceptionMappings属性的配置）。

同时我们也可以为所有的异常指定一个默认的异常提示页面（通过defaultErrorView属性的配置），如果所抛出的异常在exceptionMappings中没有对应的映射，则Spring将用此默认配置显示异常信息。

注意这里配置的异常显示界面均仅包括主文件名，至于文件路径和后缀已经在viewResolver中指定。如/error/error表示/error/error.jsp

显示错误的jsp页面：

Html代码

1. <%@ page language="java" contentType="text/html; charset=GBK"

2. pageEncoding="GBK"%>

3. <%@ page import="java.lang.Exception"%>

4. <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">

5. <html>

6. <head>

7. <meta http-equiv="Content-Type" content="text/html; charset=GBK">

8. <title>错误页面</title>

9. </head>

10. <body>

11. <h1>出错了</h1>

12. <%

13. Exception e = (Exception)request.getAttribute("exception");

14. out.print(e.getMessage());

15. %>

16. </body>

17. </html>

其中一句：request.getAttribute("exception")，key是exception，也是在SimpleMappingExceptionResolver类默认指定的，是可能通过配置文件修改这个值的，大家可以去看源码。

参考文章：

http://www.blogjava.net/wuxufeng8080/articles/191150.html

http://fangjunai.blog.163.com/blog/static/1124970520108102013839/

十二、如何把全局异常记录到日志中？

在前的配置中，其中有一个属性warnLogCategory，值是“SimpleMappingExceptionResolver类的全限定名”。我是在SimpleMappingExceptionResolver类父类AbstractHandlerExceptionResolver类中找到这个属性的。查看源码后得知：如果warnLogCategory不为空，spring就会使用apache的org.apache.commons.logging.Log日志工具，记录这个异常，级别是warn。

值：“org.springframework.web.servlet.handler.SimpleMappingExceptionResolver”，是“SimpleMappingExceptionResolver类的全限定名”。这个值不是随便写的。因为我在log4j的配置文件中还要加入log4j.logger.org.springframework.web.servlet.handler.SimpleMappingExceptionResolver=WARN，保证这个级别是warn的日志一定会被记录，即使log4j的根日志级别是ERROR。

十三、如何给spring3 MVC中的Action做JUnit单元测试？

使用了spring3 MVC后，给action做单元测试也很方便，我以前从来不给action写单元测试的，再在不同了，方便了，所以一定要写。

JUnitActionBase类是所有JUnit的测试类的父类

Java代码

1. package test;

2. import javax.servlet.http.HttpServletRequest;

3. import javax.servlet.http.HttpServletResponse;

4. import org.junit.BeforeClass;

5. import org.springframework.mock.web.MockServletContext;

6. import org.springframework.web.context.WebApplicationContext;

7. import org.springframework.web.context.support.XmlWebApplicationContext;

8. import org.springframework.web.servlet.HandlerAdapter;

9. import org.springframework.web.servlet.HandlerExecutionChain;

10. import org.springframework.web.servlet.HandlerMapping;

11. import org.springframework.web.servlet.ModelAndView;

12. import org.springframework.web.servlet.mvc.annotation.AnnotationMethodHandlerAdapter;

13. import org.springframework.web.servlet.mvc.annotation.DefaultAnnotationHandlerMapping;

14. /**

15. * 说明： JUnit测试action时使用的基类

16. *

17. * @author 赵磊

18. * @version 创建时间：2011-2-2 下午10:27:03

19. */

20. public class JUnitActionBase {

21. private static HandlerMapping handlerMapping;

22. private static HandlerAdapter handlerAdapter;

23. /**

24. * 读取spring3 MVC配置文件

25. */

26. @BeforeClass

27. public static void setUp() {

28. if (handlerMapping == null) {

29. String[] configs = { "file:src/springConfig/springMVC.xml" };

30. XmlWebApplicationContext context = new XmlWebApplicationContext();

31. context.setConfigLocations(configs);

32. MockServletContext msc = new MockServletContext();

33. context.setServletContext(msc); context.refresh();

34. msc.setAttribute(WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE, context);

35. handlerMapping = (HandlerMapping) context

36. .getBean(DefaultAnnotationHandlerMapping.class);

37. handlerAdapter = (HandlerAdapter) context.getBean(context.getBeanNamesForType(AnnotationMethodHandlerAdapter.class)[0]);

38. }

39. }

40.

41. /**

42. * 执行request对象请求的action

43. *

44. * @param request

45. * @param response

46. * @return

47. * @throws Exception

48. */

49. public ModelAndView excuteAction(HttpServletRequest request, HttpServletResponse response)

50. throws Exception {

51. HandlerExecutionChain chain = handlerMapping.getHandler(request);

52. final ModelAndView model = handlerAdapter.handle(request, response,

53. chain.getHandler());

54. return model;

55. }

56. }

这是个JUnit测试类，我们可以new Request对象，来参与测试，太方便了。给request指定访问的URL，就可以请求目标Action了。

Java代码

1. package test.com.app.user;

2. import org.junit.Assert;

3. import org.junit.Test;

4. import org.springframework.mock.web.MockHttpServletRequest;

5. import org.springframework.mock.web.MockHttpServletResponse;

6. import org.springframework.web.servlet.ModelAndView;

8. import test.JUnitActionBase;

10. /**

11. * 说明：测试OrderAction的例子

12. *

13. * @author 赵磊

14. * @version 创建时间：2011-2-2 下午10:26:55

15. */

16.

17. public class TestOrderAction extends JUnitActionBase {

18. @Test

19. public void testAdd() throws Exception {

20. MockHttpServletRequest request = new MockHttpServletRequest();

21. MockHttpServletResponse response = new MockHttpServletResponse();

22. request.setRequestURI("/order/add");

23. request.addParameter("id", "1002");

24. request.addParameter("date", "2010-12-30");

25. request.setMethod("POST");

26. // 执行URI对应的action

27. final ModelAndView mav = this.excuteAction(request, response);

28. // Assert logic

29. Assert.assertEquals("order/add", mav.getViewName());

30. String msg=(String)request.getAttribute("msg");

31. System.out.println(msg);

32. }

33. }

需要说明一下 ：由于当前最想版本的Spring(Test) 3.0.5还不支持@ContextConfiguration的注解式context file注入，所以还需要写个setUp处理下，否则类似于Tiles的加载过程会有错误，因为没有ServletContext。3.1的版本应该有更好的解决方案，参见： https://jira.springsource.org/browse/SPR-5243 。