SpringMVC基础
虽然Spring Boot近几年发展迅猛,但是Spring MVC在Web开发领域仍然占有重要的地位。本章主要讲解Spring MVC的核心:DispatcherServlet类、拦截器及控制器的相关知识。
SpringMVC简介
Spring MVC是一种将业务、视图、数据分离的设计模式。它不仅出现在Java后端开发中,在前端开发中也经常使用这种设计模式。
Spring MVC提供了高度可配置的Web框架和多种视图解决方案,并且提供了基于Servlet的接口,可以灵活地处理请求。
Spring MVC的工作流程
Spring MVC框架主要由核心Servlet(DispatcherServlet)、处理器映射(Handler-Mapping)、控制器(Controller)、视图解析器(ViewResolver)、模型(Model)及视图(View)等几部分组成,其主要的工作流程如图2.1所示。
从图2.1中可以看到,Spring MVC框架的主要工作流程可以分为以下几步:
(1)在浏览器中输入URL地址后,所有的请求都被DispatcherServlet拦截。
(2)DispatcherServlet通过HandlerMapping解析URL地址,找到匹配的能处理该请求的Controller,然后请求被Controller处理。
(3)Controller通过调用具体的业务逻辑,返回ModelAndView。
(4)DispatcherServlet通过ViewResolver(视图解析器),组装Model数据与对应的视图,如某个JSP页面等。
(5)将视图结果展现在浏览器页面上。
Spring MVC框架提供了很多重要的接口,用于完成一个HTTP请求的处理,主要的接口如表2.1所示。
DispatcherServlet类
DispatcherServlet类是Servlet的一种实现,置于Controller前,对所有的请求提供统一的处理逻辑。DispatcherServlet类需要提前声明,可以采用Java配置或web.xml方式进行声明。它通过请求映射、视图解析及统一异常处理等Spring配置发现真正的请求处理组件,从而完成对请求的处理。
DispatcherServlet类处理请求的步骤如下:
(1)DispatcherServlet类将WebApplicationContext绑定到请求中,WebApplication-Context会持有Controller、ViewResolver、HandlerMapping、Service及Repository等。
(2)HandlerMapping通过匹配规则授权给一个Handler来处理具体的逻辑,此处的Handler是一个处理链,整个处理过程会通过拦截器(Interceptor)和控制器(Controller)等来处理。
(3)返回Model数据并渲染视图。
DispatcherServlet类通过web.xml方式可以声明,代码如下:
<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
xmlns:xsi="http://www.w3.org/2001/XMLSchema
instance"
xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee
http://
xmlns.jcp.org/xml/ns/javaee/web-app_4_0.xsd"
version="4.0">
<context-param>
<param-name>contextConfigLocation</param-name>
<param-value>/WEB-INF/dispatcher-servlet.xml</param
value>
</context-param>
<listener>
<listener
class>org.springframework.web.context.Context
LoaderListener</listener-class>
</listener>
<servlet>
<servlet-name>dispatcher</servlet-name>
<servlet
class>org.springframework.web.servlet.Dispatcher
Servlet</servlet-class>
<load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
<servlet-name>dispatcher</servlet-name>
<url-pattern>/</url-pattern>
</servlet-mapping>
</web-app>
DispatcherServlet类也可以通过实现WebApplicationInitializer接口来声明。以下是摘自Spring官网的一段示例代码:
public class MyWebApplicationInitializer implements
WebApplication
Initializer {
@Override
public void onStartup(ServletContext servletCxt) {
//加载Spring Web应用上下文
AnnotationConfigWebApplicationContext ac = new
Annotation
ConfigWebApplicationContext();
ac.register(AppConfig.class);
ac.refresh();
//创建DispatcherServlet
DispatcherServlet servlet = new
DispatcherServlet(ac);
//注册DispatcherServlet
ServletRegistration.Dynamic registration =
servletCxt.
addServlet("app", servlet);
registration.setLoadOnStartup(1);
registration.addMapping("/app/*");
}
}
HandlerInterceptor拦截器
为了实现一些特殊功能,如在请求处理之前进行用户校验或日志记录等,Spring MVC提供了灵活的处理方式,即定义拦截器。自定义拦截器实现HandlerInterceptor接口,然后实现对应的抽象方法,这样可以做一些预处理或请求之后的处理。Handler-Interceptor接口提供了3个方法:
preHandle(HttpServletRequest request,
HttpServletResponseresponse, Object handler):默认返回true。该方法是在处理器执行之前调用,通过返回true或false,判断是否继续执行后面的处理链。返回true表示继续向后执行,返回false表示中断后续处理。
postHandle(HttpServletRequest request,HttpServletResponse response, Object handler, @NullableModelAndView modelAndView):该方法是在处理器处理请求之后及解析视图之前调用,可以通过该方法对请求后的模型和视图进行修改。
afterCompletion(HttpServletRequest request,HttpServletResponse response, Object handler, @NullableException ex):该方法是在处理器处理完请求之后,即视图渲染结束后执行。
下面展示一个简单的Interceptor登录拦截器的例子:
//自定义拦截器
public class LogInterceptor implements HandlerInterceptor {
//处理器处理请求之后且视图渲染结束执行
@Override
public void afterCompletion(HttpServletRequest request,
HttpServletResponse response,
Object handler,
Exception ex)
throws Exception {
System.out.println("afterCompletion方法是在处理器处理完请
求之
后,即视图渲染结束后执行");
}
//处理器处理请求之后,即解析视图之前调用
@Override
public void postHandle(HttpServletRequest request,
HttpServletResponse response,
Object handler,
ModelAndView modelAndView) throws
Exception {
System.out.println("postHandle方法是在处理器处理请求之后解
析视图之前调用");
}
//处理器处理请求之前执行
@Override
public boolean preHandle(HttpServletRequest request,
HttpServletResponse response,
Object handler)
throws Exception {
System.out.println("preHandle方法是在处理器执行之前调
用");
return true;
}
}
如果想让Interceptor生效,还需要声明一下,代码如下:
<mvc:interceptors>
<!--配置一个全局拦截器,拦截所有请求 -->
<bean class="com.cn.springmvc.LogInterceptor" />
</mvc:interceptors>
注意:postHandle()方法很少与@ResponseBody和ResponseEntity配合使用,因为@ResponseBody和ResponseEntity已经提交了响应,无法再修改。