深入理解SpringMVC

Love The Way You Lie 2022-01-15 12:47 253阅读 0赞

参考博客： [https://www.cnblogs.com/baiduligang/p/4247164.html][https_www.cnblogs.com_baiduligang_p_4247164.html]

1.  先来了解一下几个重要的类和接口：  
    DispatcherServlet – 前置控制器  
    HandlerMapping接口 – 处理请求的映射
    
    HandlerMapping接口的实现类：  
    SimpleUrlHandlerMapping 通过配置文件，把一个URL映射到Controller  
    DefaultAnnotationHandlerMapping 通过注解，把一个URL映射到Controller类上
    
    HandlerAdapter接口 – 处理请求的映射  
    AnnotationMethodHandlerAdapter类，通过注解，把一个URL映射到Controller类的方法上
    
    Controller接口 – 控制器  
    由于我们使用了@Controller注解，添加了@Controller注解注解的类就可以担任控制器（Action）的职责
    
    HandlerInterceptor 接口–拦截器，我们自己实现这个接口，来完成拦截的器的工作
    
    ViewResolver接口的实现类  
    UrlBasedViewResolver类 通过配置文件，把一个视图名交给到一个View来处理  
    InternalResourceViewResolver类，比上面的类，加入了JSTL的支持
    
    LocalResolver接口
    
    HandlerExceptionResolver接口 --异常处理  
    SimpleMappingExceptionResolver实现类
    
    ModelAndView类
2.  核心流程图  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3RocXR6cQ_size_16_color_FFFFFF_t_70]
3.  DispatcherServlet说明  
    使用SpringMVC,DispatcherServlet是第一步；DispatcherServlet是一个Servlet,所以可以配置多个DispatcherServlet；DispatcherServlet是前置控制器，配置在web.xml文件中，拦截匹配的请求，Servlet拦截匹配规则要自己定义，把拦截下来的请求安装某种规则分发到Controller中进行处理。  
    如下例子：

<web-app>  
        <servlet>  
            <servlet-name>example</servlet-name>  
            <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>  
            <load-on-startup>1</load-on-startup>  
        </servlet>  
        <servlet-mapping>  
            <servlet-name>example</servlet-name>  
            <url-pattern>*.do</url-pattern>  
        </servlet-mapping>  
    </web-app>

1是启动顺序，让这个Servlet随Servlet容器一起启动。  
*.do* 会拦截.do结尾的请求。  
example这个Servlet的名字是example，可以有多个DispatcherServlet，是通过名字来区分的。每一个DispatcherServlet有自己的WebApplicationContext上下文对象.  
在DispatcherServlet的初始化过程中，框架会在web应用的WEB-INF文件夹下寻找名为\[servlet-name\]-servlet.xml的配置文件，生成文件中定义的bean。

第二个例子：

<servlet>  
        <servlet-name>springMVC</servlet-name>  
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>  
        <init-param>  
            <param-name>contextConfigLocation</param-name>  
            <param-value>classpath*:/springMVC.xml</param-value>  
        </init-param>  
        <load-on-startup>1</load-on-startup>  
    </servlet>  
    <servlet-mapping>  
        <servlet-name>springMVC</servlet-name>  
        <url-pattern>/</url-pattern>  
    </servlet-mapping>

**指明了配置文件的文件名，不使用默认配置文件名，而使用springMVC.xml配置文件。**  
其中\*\*.xml 这里可以使用多种写法  
1、不写,使用默认值:/WEB-INF/-servlet.xml  
2、/WEB-INF/classes/springMVC.xml  
3、classpath\*:springMVC-mvc.xml  
4、多个值用逗号分隔

1.  Servlet拦截匹配规则可以自己定义：  
    1，拦截\*.do，*.html; 例如：/user/add.do; 这是最传统的方式，最简单也是最实用的，不会导致静态文件（jpg, js, css)被拦截。  
    2，拦截/，例如：/user/add  
    可以实现现在很流行的REST风格。  
    弊端：会导致静态文件（jpg,js,css）被拦截后不能正常显示。想实现REST风格，事情就是麻烦一些。后面有解决办法还算简单。  
    3，拦截/*，这是一个错误的方式，请求可以走到Action中，但是转到jsp时再次被拦截，不能访问到jsp。
2.  父子上下文（WebApplicationContext）  
    使用listener监听器来加载配置

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

Spring会创建一个WebApplicationContext上下文，称为父上下文（父容器），保存在ServletContext中，key是WebApplicationContext.ROOT\_WEB\_APPLICATION\_CONTEXT\_ATTRIBUTE的值。可以使用Spring提供的工具类取出上下文对象：  
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);

父上下文容器中保存数据源，服务层，dao层，事物的Bean；子上下文容器中保存MVC相关的Controller的Bean；事物控制在服务层。由于父上下文容器不能访问子上下文容器中的内容，事务的Bean在父上下文容器中，无法访问子上下文容器中的内容，就无法对子上下文容器中的Controller进行AOP(事物）。

1.  springMVC-mvc.xml配置文件片段讲解

context:component-scan/扫描指定的包中的类上的注解，常用的注解有：  
@Controller 声明Controller组件  
@Service 声明Service组件 @Service(“myMovieLister”)  
@Repository 声明Dao组件  
@Component 泛指组件, 当不好归类时.  
@RequestMapping("/menu") 请求映射  
@Resource 用于注入，( j2ee提供的 ) 默认按名称装配，@Resource(name=“beanName”)  
@Autowired 用于注入，(spring提供的) 默认按类型装配  
@Transactional( rollbackFor=\{Exception.class\}) 事务管理  
@ResponseBody 指定json格式的返回值  
@Scope(“prototype”) 设定bean的作用域

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

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

mvc:default-servlet-handler/ 使用默认的Servlet来响应静态文件。  
<mvc:resources mapping="/images/**" location="/images/" cache-period=“31556926”/> 匹配URL /images/** 的URL被当做静态资源，由Spring读出到内存中再响应http。

1.  如何访问到静态文件，如JPG，js, css？  
    如果你的DispatcherServlet拦截"*.do"这样的有后缀的URL，就不存在访问不到静态资源的问题。如果你的DispatcherServlet拦截"/"，为了实现REST风格，拦截了所有的请求，那么同时对*.js,\*.jpg等静态文件的访问也就被拦截了。  
    方案一：激活Tomcat的defaultServlet来处理静态文件：

<servlet-mapping>    
        <servlet-name>default</servlet-name>  
        <url-pattern>*.jpg</url-pattern>      
    </servlet-mapping>     
    <servlet-mapping>        
        <servlet-name>default</servlet-name>     
        <url-pattern>*.js</url-pattern>     
    </servlet-mapping>     
    <servlet-mapping>         
        <servlet-name>default</servlet-name>        
        <url-pattern>*.css</url-pattern>       
    </servlet-mapping>

要写在DispatcherServlet的前面， 让 defaultServlet先拦截请求，这样请求就不会进入Spring了。  
Tomcat, Jetty, JBoss, and GlassFish 自带的默认Servlet的名字 – “default”  
方案二：在spring3.0.4以后版本提供了mvc:resources, 使用方式如下：

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

/images/\*\*映射到ResourceHttpRequestHandler进行处理，location指定静态资源的位置.可以是web application根目录下、jar包里面，这样可以把静态资源压缩到jar包中。cache-period 可以使得静态资源进行web cache 。  
使用mvc:resources/元素,把mapping的URI注册到SimpleUrlHandlerMapping的urlMap中,  
key为mapping的URI pattern值,而value为ResourceHttpRequestHandler,这样就巧妙的把对静态资源的访问由HandlerMapping转到ResourceHttpRequestHandler处理并返回,所以就支持classpath目录,jar包内静态资源的访问;另外需要注意的一点是,不要对SimpleUrlHandlerMapping设置defaultHandler.因为对静态的url的defaultHandler就是ResourceHttpRequestHandler；否则无法处理static resources request。

方案三：使用mvc:default-servlet-handler/

<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的Controller。然后再按order值升序找，由于最后一个 SimpleUrlHandlerMapping 是匹配 "/\*\*"的，所以一定会匹配上，就可以响应图片。

1.  请求如何映射到具体的Controller中的方法？  
    基于注解映射，可以使用DefaultAnnotationHandlerMapping

但前面我们配置了<mvc:annotation-driven />，他会自动注册这个bean,就不须要我们显示的注册这个bean了。  
如何替换 <mvc:annotation-driven />？他到底做了什么工作，请看，最后面的 十九节 <mvc:annotation-driven /> 到底做了什么工作。

1.  Spring中的拦截器  
    Spring为我们提供了org.springframework.web.servlet.HandlerInterceptor接口，  
    org.springframework.web.servlet.handler.HandlerInterceptorAdapter适配器，  
    实现这个接口或继承此类，可以非常方便的实现自己的拦截器。  
    有以下三个方法：  
    Controller之前执行:  
    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判断是否发生了异常，进行日志记录。 参数中的Object handler是下一个拦截器

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

public class MyInteceptor implements HandlerInterceptor {      
        略。。。   
    }

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

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

为什么叫”近似“，前面说了，spring没有总的拦截器。  
mvc:interceptors/会为每一个HandlerMapping，注入一个拦截器。总有一个HandlerMapping是可以找到处理器的，最多也只找到一个处理器，所以这个拦截器总会被执行的。起到了总拦截器的作用。  
2，方案二：（近似） 总拦截器， 拦截匹配的URL。  
就是比方案一多了一个URL匹配

<mvc:interceptors >     
      <mvc:interceptor>     
            <mvc:mapping path="/user/*" />      
            <bean class="com.mvc.MyInteceptor"></bean>     
        </mvc:interceptor>     
    </mvc:interceptors>

3，方案三：HandlerMapping上的拦截器。  
如果是REST风格的URL，静态资源就不会被拦截。因为我们精准的注入了拦截器。

如果使用了<mvc:annotation-driven />， 它会自动注册DefaultAnnotationHandlerMapping 与AnnotationMethodHandlerAdapter 这两个bean,所以就没有机会再给它注入interceptors属性，就无法指定拦截器。当然我们可以通过人工配置上面的两个Bean，不使用 <mvc:annotation-driven />，就可以 给interceptors属性 注入拦截器了。

1.  如何实现全局的异常处理？  
    在spring MVC的配置文件中加上如下配置：

<bean id="exceptionResolver" class="org.springframework.web.servlet.handler.SimpleMappingExceptionResolver">  
        <property name="defaultErrorView">     
           		 <value>/error/error</value>  
        </property>  
        <property name="defaultStatusCode">     
            	<value>500</value>  
        </property>      
    	<property name="warnLogCategory">     
          		 <value>org.springframework.web.servlet.handler.SimpleMappingExceptionResolver</value>  
        </property>      
    </bean>

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

通过SimpleMappingExceptionResolver我们可以将不同的异常映射到不同的jsp页面（通过exceptionMappings属性的配置）。**同时我们也可以为所有的异常指定一个默认的异常提示页面（通过defaultErrorView属性的配置）**，如果所抛出的异常在exceptionMappings中没有对应的映射，则Spring将用此默认配置显示异常信息。注意这里配置的异常显示界面均仅包括主文件名，至于文件路径和后缀已经在viewResolver中指定。如/error/error示/error/error.jsp  
显示错误的jsp页面：

<%@ page language="java" contentType="text/html; charset=GBK"  
        pageEncoding="GBK"%>  
    <%@ page import="java.lang.Exception"%>  
    <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">  
    <html>  
    	<head>  
    		<meta http-equiv="Content-Type" content="text/html; charset=GBK">  
    		<title>错误页面</title>  
    	</head>  
    	<body>  
    		<h1>出错了</h1>  
    		<%  Exception e = (Exception)request.getAttribute("exception");   
    		out.print(e.getMessage());   
    		%>  
    	</body>  
    </html>

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

1.  关于几个配置文件的说明  
    我看到有人把配置文件写成2份，一个是applicationContext.xml，这个文件从spring2.0-2.5时一直在使用。另一个是spring MVC的配置文件。其实这两个可以写成一个，springmvc的相关配置，数据源，事务相关的配置都写在一个配置文件中。  
    web.xml文件中也不要再配置org.springframework.web.context.ContextLoaderListener的listener了；写两个配置文件一般就会导致扫描两次，一定要精确控制扫描的包名，做到不重复扫描。
2.  如何取得spring管理的bean（请用第3种方法）  
    1，servlet方式加载：web.xml

spring容器放在ServletContext中的key是org.springframework.web.servlet.FrameworkServlet.CONTEXT.springMVC注意后面的springMVC，是你的servlet-name配置的值，注意适时修改。

ServletContext sc=略  
    WebApplicationContext attr = (WebApplicationContext)sc.getAttribute("org.springframework.web.servlet.FrameworkServlet.CONTEXT.springMVC");

2,listener方式加载时：web.xml

<context-param>  
    	  <param-name>contextConfigLocation</param-name>  
    	  <param-value>/WEB-INF/applicationContext</param-value>  
    </context-param>  
      
    <listener>  
     	 <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>  
    </listener>

jsp/servlet可以这样获取：

ServletContext context = getServletContext();   
    WebApplicationContext applicationContext  = WebApplicationContextUtils .getWebApplicationContext(context);

3，通用的方式：在配置文件中加入：

<bean class="com.xxxxx.SpringContextHolder" lazy-init="false" />

java代码：

package com.dalingjia.test;
    
    import org.springframework.context.ApplicationContext;
    import org.springframework.context.ApplicationContextAware;
    
    /**
     1. 以静态变量保存Spring ApplicationContext, 可在任何代码任何地方任何时候中取出ApplicaitonContext.
     */
    public class SpringContextHolder implements ApplicationContextAware {
        private static ApplicationContext applicationContext;
    
        /**
         * 实现ApplicationContextAware接口的context注入函数, 将其存入静态变量.
         */
        public void setApplicationContext(ApplicationContext applicationContext) {
            SpringContextHolder.applicationContext = applicationContext; // NOSONAR   
        }
    
        /**
         * 取得存储在静态变量中的ApplicationContext.
         */
        public static ApplicationContext getApplicationContext() {
            checkApplicationContext();
            return applicationContext;
        }
    
        /**
         * 从静态变量ApplicationContext中取得Bean, 自动转型为所赋值对象的类型.
         */
        @SuppressWarnings("unchecked")
        public static <T> T getBean(String name) {
            checkApplicationContext();
            return (T) applicationContext.getBean(name);
        }
    
        /**
         * 从静态变量ApplicationContext中取得Bean, 自动转型为所赋值对象的类型.
         */
        @SuppressWarnings("unchecked")
        public static <T> T getBean(Class<T> clazz) {
            checkApplicationContext();
            return (T) applicationContext.getBeansOfType(clazz);
        }
    
        /**
         * 清除applicationContext静态变量.
         */
        public static void cleanApplicationContext() {
            applicationContext = null;
        }
    
        private static void checkApplicationContext() {
            if (applicationContext == null) {
                throw new IllegalStateException("applicaitonContext未注入,请在applicationContext.xml中定义SpringContextHolder");
            }
        }
    }

1.  <mvc:annotation-driven />到底做了什么工作

<mvc:annotation-driven />实际做了以下工作：（不包括添加自己定义的拦截器）；我们了解这些之后，对Spring3 MVC的控制力就更强大了，想改哪就改哪里。

<bean class="org.springframework.web.servlet.mvc.annotation.DefaultAnnotationHandlerMapping">           
        <property name="interceptors">  
            <list>     
                <ref bean="logNDCInteceptor"/>     
                <ref bean="myRequestHelperInteceptor"/>       
                <ref bean="myPermissionsInteceptor"/>      
                <ref bean="myUserInfoInteceptor"/>      
            </list>           
        </property>           
    </bean>      
    <bean class="org.springframework.web.servlet.mvc.annotation.AnnotationMethodHandlerAdapter">  
        <property name="messageConverters">     
            <list>     
                <ref bean="byteArray_hmc" />     
                <ref bean="string_hmc" />     
                <ref bean="resource_hmc" />     
                <ref bean="source_hmc" />     
                <ref bean="xmlAwareForm_hmc" />     
                <ref bean="jaxb2RootElement_hmc" />     
                <ref bean="jackson_hmc" />     
            </list>     
        </property>     
    </bean>     
    <bean id="byteArray_hmc" class="org.springframework.http.converter.ByteArrayHttpMessageConverter" />  
    <bean id="string_hmc" class="org.springframework.http.converter.StringHttpMessageConverter" />  
    <bean id="resource_hmc" class="org.springframework.http.converter.ResourceHttpMessageConverter" />  
    <bean id="source_hmc" class="org.springframework.http.converter.xml.SourceHttpMessageConverter" />  
    <bean id="xmlAwareForm_hmc" class="org.springframework.http.converter.xml.XmlAwareFormHttpMessageConverter" />  
    <bean id="jaxb2RootElement_hmc" class="org.springframework.http.converter.xml.Jaxb2RootElementHttpMessageConverter" />  
    <bean id="jackson_hmc" class="org.springframework.http.converter.json.MappingJacksonHttpMessageConverter" />

[https_www.cnblogs.com_baiduligang_p_4247164.html]: https://www.cnblogs.com/baiduligang/p/4247164.html
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3RocXR6cQ_size_16_color_FFFFFF_t_70]: /images/20220115/71e8841fec20403695f07600364922b4.png