写在前面
生活就像海洋,只有意志坚强的人才能到达彼岸。
已经很久没有发文章了呀,想必大家都挂念我了,哈哈。
温故而知新,今天一起来复习一下spring mvc
的内容吧。
首先我们看下一个MVC的完整的思维导图
spring mvc简介与运行原理
Spring
的模型-视图-控制器(MVC)
框架是围绕一个DispatcherServlet
来设计的,这个Servlet
会把请求分发给各个处理器,并支持可配置的处理器映射、视图渲染、本地化、时区与主题渲染等,甚至还能支持文件上传。
-
(1)
Http
请求:客户端请求提交到DispatcherServlet
。 -
(2) 寻找处理器:由
DispatcherServlet
控制器查询一个或多个HandlerMapping
,找到处理请求的Controller
。 -
(3) 调用处理器:
DispatcherServlet
将请求提交到Controller
。 -
(4)(5)调用业务处理和返回结果:
Controller
调用业务逻辑处理后,返回ModelAndView
。 -
(6)(7)处理视图映射并返回模型:
DispatcherServlet
查询一个或多个ViewResoler
视图解析器,找到ModelAndView
指定的视图。 -
(8)
Http
响应:视图负责将结果显示到客户端。
主要注解
ContextLoaderListener
在讲ContextLoaderListener
之前,首先来了解一下web.xml
的作用。
-
一个
web
中可以没有web.xml
文件,也就是说,web.xml
文件并不是web
工程必须的。web.xml
文件是用来初始化配置信息:比如Welcome
页面、servlet
、servlet-mapping
、filter
、listener
、启动加载级别等。当你的web
工程没用到这些时,你可以不用web.xml
文件来配置你的Application
。 -
当要启动某个
web
项目时,服务器软件或容器如(tomcat)
会第一步加载项目中的web.xml
文件,通过其中的各种配置来启动项目,只有其中配置的各项均无误时,项目才能正确启动。web.xml有多项标签,在其加载的过程中顺序依次为:context-param >> listener >> fileter >> servlet
。(同类多个节点以出现顺序依次加载)
而spring mvc
启动过程大致分为两个过程:
-
ContextLoaderListener
初始化,实例化IoC
容器,并将此容器实例注册到ServletContext
中。 -
DispatcherServlet
初始化。
其中ContextLoaderListener
监听器它实现了ServletContextListener
这个接口,在web.xml
配置这个监听器,启动容器时,就会默认执行它实现的方法。在ContextLoaderListener
中关联了ContextLoader
这个类,所以整个加载配置过程由ContextLoader
来完成。
ContextLoaderListener
在web.xml
中的配置
<pre class="hljs xml" style="box-sizing: border-box; overflow: auto; font-family: Menlo, Monaco, Consolas, "Courier New", monospace; font-size: 13px; padding: 15px; margin-top: 0px; margin-bottom: 20px; line-height: 1.42857; word-wrap: normal; color: rgb(101, 123, 131); background-color: rgb(246, 246, 246); border: 1px solid rgb(204, 204, 204); border-radius: 0px; text-size-adjust: none; word-break: break-word !important;">
<!-- 配置contextConfigLocation初始化参数 -->
<context-param>
<param-name>contextConfigLocation</param-name>
<param-value>/WEB-INF/applicationContext.xml</param-value></context-param>
<!-- 配置ContextLoaderListerner -->
<listener>
<listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
</listener>
</pre>
ServletContextListener
接口有两个方法:contextInitialized,contextDestroyed
DispatcherServlet
Spring MVC
框架,与其他很多web
的MVC
框架一样:请求驱动;所有设计都围绕着一个中央Servlet
来展开,它负责把所有请求分发到控制器;同时提供其他web
应用开发所需要的功能。不过Spring
的中央处理器,DispatcherServlet
,能做的比这更多。
下图展示了Spring Web MVC
的DispatcherServlet
处理请求的工作流。熟悉设计模式的朋友会发现,DispatcherServlet
应用的其实就是一个“前端控制器”的设计模式(其他很多优秀的web
框架也都使用了这个设计模式)。
- 流程图
- 在
web.xml
中的配置
<pre class="hljs xml" style="box-sizing: border-box; overflow: auto; font-family: Menlo, Monaco, Consolas, "Courier New", monospace; font-size: 13px; padding: 15px; margin-top: 0px; margin-bottom: 20px; line-height: 1.42857; word-wrap: normal; color: rgb(101, 123, 131); background-color: rgb(246, 246, 246); border: 1px solid rgb(204, 204, 204); border-radius: 0px; text-size-adjust: none; word-break: break-word !important;">
<!-- servlet定义 -->
<servlet>
<servlet-name>dispatcher</servlet-name>
<servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
<load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
<servlet-name>dispatcher</servlet-name>
<url-pattern>/</url-pattern>
</servlet-mapping>
</pre>
其中
-
load-on-startup
:表示启动容器时初始化该Servlet
; -
url-pattern
:表示哪些请求交给Spring Web MVC
处理,“/”
是用来定义默认servlet
映射的。也可以如“*.html”
表示拦截所有以html
为扩展名的请求。
在Spring MVC
中,每个DispatcherServlet
都持有一个自己的上下文对象WebApplicationContext
,它又继承了根(root)WebApplicationContext
对象中已经定义的所有bean
。这些继承的bean
可以在具体的Servlet
实例中被重载,在每个Servlet
实例中你也可以定义其scope
下的新bean
。
WebApplicationContext
继承自ApplicationContext
,它提供了一些web
应用经常需要用到的特性。它与普通的ApplicationContext
不同的地方在于,它支持主题的解析,并且知道它关联到的是哪个servlet
(它持有一个该ServletContext
的引用)
spring mvc
同时提供了很多特殊的注解,用于处理请求和渲染视图等。DispatcherServlet
初始化的过程中会默认使用这些特殊bean
进行配置。如果你想指定使用哪个特定的bean
,你可以在web
应用上下文WebApplicationContext
中简单地配置它们。
其中,常用的ViewResolver
的配置。以jsp
作为视图为例
<pre class="hljs xml" style="box-sizing: border-box; overflow: auto; font-family: Menlo, Monaco, Consolas, "Courier New", monospace; font-size: 13px; padding: 15px; margin-top: 0px; margin-bottom: 20px; line-height: 1.42857; word-wrap: normal; color: rgb(101, 123, 131); background-color: rgb(246, 246, 246); border: 1px solid rgb(204, 204, 204); border-radius: 0px; text-size-adjust: none; word-break: break-word !important;">
<!-- 对模型视图名称的解析,即在模型视图名称添加前后缀 -->
<bean class="org.springframework.web.servlet.view.InternalResourceViewResolver">
<property name="prefix" value="/WEB-INF/jsp/" />
<property name="suffix" value=".jsp" /></bean>
</pre>
配置上传文件限制MultipartResolver
<pre class="hljs xml" style="box-sizing: border-box; overflow: auto; font-family: Menlo, Monaco, Consolas, "Courier New", monospace; font-size: 13px; padding: 15px; margin-top: 0px; margin-bottom: 20px; line-height: 1.42857; word-wrap: normal; color: rgb(101, 123, 131); background-color: rgb(246, 246, 246); border: 1px solid rgb(204, 204, 204); border-radius: 0px; text-size-adjust: none; word-break: break-word !important;">
<!-- 上传限制 -->
<bean id="multipartResolver" class="org.springframework.web.multipart.commons.CommonsMultipartResolver">
<!-- 上传文件大小限制为31M,31*1024*1024 -->
<property name="maxUploadSize" value="32505856"/></bean>
</pre>
applicationContext.xml中的标签
文件上传
前面说到DispatcherServlet
中有个特殊的Bean叫MultipartResolver
,可用于限制文件的上传大小等。当解析器MultipartResolver
完成处理时,请求便会像其他请求一样被正常流程处理。
- 表单
<pre class="hljs xml" style="box-sizing: border-box; overflow: auto; font-family: Menlo, Monaco, Consolas, "Courier New", monospace; font-size: 13px; padding: 15px; margin-top: 0px; margin-bottom: 20px; line-height: 1.42857; word-wrap: normal; color: rgb(101, 123, 131); background-color: rgb(246, 246, 246); border: 1px solid rgb(204, 204, 204); border-radius: 0px; text-size-adjust: none; word-break: break-word !important;">
<form method="post" action="/form" enctype="multipart/form-data">
<input type="text" name="name"/>
<input type="file" name="file"/>
<input type="submit"/></form>
</pre>
- 控制器
<pre class="hljs java" style="box-sizing: border-box; overflow: auto; font-family: Menlo, Monaco, Consolas, "Courier New", monospace; font-size: 13px; padding: 15px; margin-top: 0px; margin-bottom: 20px; line-height: 1.42857; word-wrap: normal; color: rgb(101, 123, 131); background-color: rgb(246, 246, 246); border: 1px solid rgb(204, 204, 204); border-radius: 0px; text-size-adjust: none; word-break: break-word !important;">
@RequestMapping(path = "/form", method = RequestMethod.POST)
public String handleFormUpload(
@RequestParam("name") String name,
@RequestParam("file") MultipartFile file) {
if (!file.isEmpty()){
byte[] bytes = file.getBytes(); // store the bytes somewhere
return "redirect:uploadSuccess";
}
return "redirect:uploadFailure";
}
</pre>
异常处理
先来说下常见的异常处理有几种方式,如下图:
Spring
的处理器异常解析器HandlerExceptionResolver
接口的实现负责处理各类控制器执行过程中出现的异常。也是上面提到的,是DispatcherServlet
中的特殊bean
,可以自定义配置处理。
某种程度上讲,HandlerExceptionResolver
与你在web
应用描述符web.xml
文件中能定义的异常映射(exception mapping)
很相像,不过它比后者提供了更灵活的方式。比如它能提供异常被抛出时正在执行的是哪个处理器这样的信息。
- HandlerExceptionResolver 提供resolveException接口
<pre class="hljs java" style="box-sizing: border-box; overflow: auto; font-family: Menlo, Monaco, Consolas, "Courier New", monospace; font-size: 13px; padding: 15px; margin-top: 0px; margin-bottom: 20px; line-height: 1.42857; word-wrap: normal; color: rgb(101, 123, 131); background-color: rgb(246, 246, 246); border: 1px solid rgb(204, 204, 204); border-radius: 0px; text-size-adjust: none; word-break: break-word !important;">
public interface HandlerExceptionResolver {
ModelAndView resolveException( HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex);
}
</pre>
- 在BaseController中使用 @ExceptionHandler注解处理异常
<pre class="hljs php" style="box-sizing: border-box; overflow: auto; font-family: Menlo, Monaco, Consolas, "Courier New", monospace; font-size: 13px; padding: 15px; margin-top: 0px; margin-bottom: 20px; line-height: 1.42857; word-wrap: normal; color: rgb(101, 123, 131); background-color: rgb(246, 246, 246); border: 1px solid rgb(204, 204, 204); border-radius: 0px; text-size-adjust: none; word-break: break-word !important;"> @ExceptionHandler(Exception.class) public Object exceptionHandler(Exception ex, HttpServletResponse response,
HttpServletRequest request) throws IOException {
String url = "";
String msg = ex.getMessage();
Object resultModel = null; try { if (ex.getClass() == HttpRequestMethodNotSupportedException.class) {
url = "admin/common/500";
System.out.println("--------毛有找到对应方法---------");
} else if (ex.getClass() == ParameterException.class) {//自定义的异常
} else if (ex.getClass() == UnauthorizedException.class) {
url = "admin/common/unauth";
System.out.println("--------毛有权限---------");
}
String header = req.getHeader("X-Requested-With");
boolean isAjax = "XMLHttpRequest".equalsIgnoreCase(header);
String method = req.getMethod();
boolean isPost = "POST".equalsIgnoreCase(method); if (isAjax || isPost) { return Message.error(msg);
} else {
ModelAndView view = new ModelAndView(url);
view.addObject("error", msg);
view.addObject("class", ex.getClass());
view.addObject("method", request.getRequestURI()); return view;
}
} catch (Exception exception) {
logger.error(exception.getMessage(), exception); return resultModel;
} finally {
logger.error(msg, ex);
ex.printStackTrace();
}
}</pre>
- *在web.xml中处理异常 *
<pre class="hljs xml" style="box-sizing: border-box; overflow: auto; font-family: Menlo, Monaco, Consolas, "Courier New", monospace; font-size: 13px; padding: 15px; margin-top: 0px; margin-bottom: 20px; line-height: 1.42857; word-wrap: normal; color: rgb(101, 123, 131); background-color: rgb(246, 246, 246); border: 1px solid rgb(204, 204, 204); border-radius: 0px; text-size-adjust: none; word-break: break-word !important;">
<!-- 默认的错误处理页面 -->
<error-page>
<error-code>403</error-code>
<location>/403.html</location></error-page><error-page>
<error-code>404</error-code>
<location>/404.html</location>
</error-page>
<!-- 仅仅在调试的时候注视掉,在正式部署的时候不能注释 --><!-- 这样配置也是可以的,表示发生500错误的时候,转到500.jsp页面处理。 -->
<error-page>
<error-code>500</error-code>
<location>/500.html</location>
</error-page>
<!-- 这样的配置表示如果jsp页面或者servlet发生java.lang.Exception类型(当然包含子类)的异常就会转到500.jsp页面处理。 -->
<error-page>
<exception-type>java.lang.Exception</exception-type>
<location>/500.jsp</location> </error-page> <error-page>
<exception-type>java.lang.Throwable</exception-type>
<location>/500.jsp</location>
</error-page>
<!-- 当error-code和exception-type都配置时,exception-type配置的页面优先级高及出现500错误,发生异常Exception时会跳转到500.jsp-->
</pre>
- 来一个问题:HandlerExceptionResolver和web.xml中配置的error-page会有冲突吗?
解答:如果resolveException
返回了ModelAndView
,会优先根据返回值中的页面来显示。不过,resolveException
可以返回null
,此时则展示web.xml
中的error-page
的500
状态码配置的页面。
当web.xml
中有相应的error-page
配置,则可以在实现resolveException
方法时返回null
。API
文档中对返回值的解释: