如何注册interceptor、Servlet、Listener、Filter
一、拦截器interceptor
SpringMVC 中的Interceptor 拦截器也是相当重要和相当有用的，它的主要作用是拦截用户的请求并进行相应的处理。比如通过它来进行权限验证，或者是来判断用户是否登陆，或者是像12306 那样子判断当前时间是否是购票时间。
定义Interceptor实现类
SpringMVC 中的Interceptor 拦截请求是通过HandlerInterceptor 来实现的。
在SpringMVC 中定义一个Interceptor 非常简单，主要有两种方式：
- 实现HandlerInterceptor 接口或继承实现了HandlerInterceptor 接口的类，如抽象类HandlerInterceptorAdapter
- 实现WebRequestInterceptor接口或者是继承实现了WebRequestInterceptor的类
实现HandlerInterceptor接口
HandlerInterceptor 接口中定义了三个方法，我们就是通过这三个方法来对用户的请求进行拦截处理的。
preHandle (HttpServletRequest request, HttpServletResponse response, Object handle) 方法
该方法将在请求处理之前进行调用。SpringMVC 中的Interceptor 是链式的调用的，在一个应用中或者说是在一个请求中可以同时存在多个Interceptor 。每个Interceptor 的调用会依据它的声明顺序依次执行，而且最先执行的都是Interceptor 中的preHandle 方法，所以可以在这个方法中进行一些前置初始化操作或者是对当前请求的一个预处理，也可以在这个方法中进行一些判断来决定请求是否要继续进行下去。该方法的返回值是布尔值Boolean 类型的，当它返回为false 时，表示请求结束，后续的Interceptor 和Controller都不会再执行；当返回值为true 时就会继续调用下一个Interceptor 的preHandle 方法，如果已经是最后一个Interceptor 的时候就会是调用当前请求的Controller 方法。
postHandle (HttpServletRequest request, HttpServletResponse response, Object handle, ModelAndView modelAndView) 方法
该方法将在当前请求进行处理之后，也就是Controller 方法调用之后执行，但是它会在DispatcherServlet 进行视图返回渲染之前被调用，所以我们可以在这个方法中对Controller 处理之后的ModelAndView 对象进行操作。postHandle 方法被调用的方向跟preHandle 是相反的，也就是说先声明的Interceptor 的postHandle 方法反而会后执行
afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handle, Exception ex) 方法
该方法将在整个请求结束之后，也就是在DispatcherServlet 渲染了对应的视图之后执行。这个方法的主要作用是用于进行资源清理工作的。
import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; import org.springframework.web.servlet.HandlerInterceptor; import org.springframework.web.servlet.ModelAndView; public class SpringMVCInterceptor implements HandlerInterceptor { /** * preHandle方法是进行处理器拦截用的，顾名思义，该方法将在Controller处理之前进行调用，SpringMVC中的Interceptor拦截器是链式的，可以同时存在 * 多个Interceptor，然后SpringMVC会根据声明的前后顺序一个接一个的执行，而且所有的Interceptor中的preHandle方法都会在 * Controller方法调用之前调用。SpringMVC的这种Interceptor链式结构也是可以进行中断的，这种中断方式是令preHandle的返 * 回值为false，当preHandle的返回值为false的时候整个请求就结束了。 */ @Override public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception { // TODO Auto-generated method stub return false; } /** * 这个方法只会在当前这个Interceptor的preHandle方法返回值为true的时候才会执行。postHandle是进行处理器拦截用的，它的执行时间是在处理器进行处理之 * 后，也就是在Controller的方法调用之后执行，但是它会在DispatcherServlet进行视图的渲染之前执行，也就是说在这个方法中你可以对ModelAndView进行操 * 作。这个方法的链式结构跟正常访问的方向是相反的，也就是说先声明的Interceptor拦截器该方法反而会后调用，这跟Struts2里面的拦截器的执行过程有点像， * 只是Struts2里面的intercept方法中要手动的调用ActionInvocation的invoke方法，Struts2中调用ActionInvocation的invoke方法就是调用下一个Interceptor * 或者是调用action，然后要在Interceptor之前调用的内容都写在调用invoke之前，要在Interceptor之后调用的内容都写在调用invoke方法之后。 */ @Override public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception { // TODO Auto-generated method stub } /** * 该方法也是需要当前对应的Interceptor的preHandle方法的返回值为true时才会执行。该方法将在整个请求完成之后，也就是DispatcherServlet渲染了视图执行， * 这个方法的主要作用是用于清理资源的，当然这个方法也只能在当前这个Interceptor的preHandle方法的返回值为true时才会执行。 */ @Override public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception { // TODO Auto-generated method stub } }
实现WebRequestInterceptor 接口
WebRequestInterceptor 中也定义了三个方法，我们也是通过这三个方法来实现拦截的。这三个方法都传递了同一个参数WebRequest ，那么这个WebRequest 是什么呢？
这个WebRequest 是Spring 定义的一个接口，它里面的方法定义都基本跟HttpServletRequest 一样，在WebRequestInterceptor 中对WebRequest进行的所有操作都将同步到HttpServletRequest 中，然后在当前请求中一直传递。
preHandle(WebRequest request) 方法
该方法将在请求处理之前进行调用，也就是说会在Controller 方法调用之前被调用。这个方法跟HandlerInterceptor 中的preHandle 是不同的，主要区别在于该方法的返回值是void ，也就是没有返回值，所以我们一般主要用它来进行资源的准备工作，比如我们在使用Hibernate 的时候可以在这个方法中准备一个Hibernate 的Session 对象，然后利用WebRequest 的setAttribute(name, value, scope) 把它放到WebRequest 的属性中。
setAttribute 方法的第三个参数scope ，该参数是一个Integer 类型的。在WebRequest 的父层接口RequestAttributes 中对它定义了两个常量：
- SCOPE_REQUEST ：它的值是0 ，代表只有在request 中可以访问。
- SCOPE_SESSION ：它的值是1 ，如果环境允许的话它代表的是一个局部的隔离的session，否则就代表普通的session，并且在该session范围内可以访问。
postHandle(WebRequest request, ModelMap model) 方法
该方法将在请求处理之后，也就是在Controller 方法调用之后被调用，但是会在视图返回被渲染之前被调用，所以可以在这个方法里面通过改变数据模型ModelMap来改变数据的展示。
该方法有两个参数，WebRequest 对象是用于传递整个请求数据的，比如在preHandle 中准备的数据都可以通过WebRequest 来传递和访问；ModelMap 就是Controller 处理之后返回的Model 对象，我们可以通过改变它的属性来改变返回的Model 模型。
afterCompletion(WebRequest request, Exception ex) 方法
该方法会在整个请求处理完成，也就是在视图返回并被渲染之后执行。所以在该方法中可以进行资源的释放操作。而WebRequest 参数就可以把我们在preHandle 中准备的资源传递到这里进行释放。Exception 参数表示的是当前请求的异常对象，如果在Controller 中抛出的异常已经被Spring 的异常处理器给处理了的话，那么这个异常对象就是是null 。
import org.springframework.ui.ModelMap; import org.springframework.web.context.request.WebRequest; import org.springframework.web.context.request.WebRequestInterceptor; public class AllInterceptor implements WebRequestInterceptor { /** * 在请求处理之前执行，该方法主要是用于准备资源数据的，然后可以把它们当做请求属性放到WebRequest中 */ @Override public void preHandle(WebRequest request) throws Exception { // TODO Auto-generated method stub System.out.println("AllInterceptor..............................."); request.setAttribute("request", "request", WebRequest.SCOPE_REQUEST);//这个是放到request范围内的，所以只能在当前请求中的request中获取到 request.setAttribute("session", "session", WebRequest.SCOPE_SESSION);//这个是放到session范围内的，如果环境允许的话它只能在局部的隔离的会话中访问，否则就是在普通的当前会话中可以访问 } /** * 该方法将在Controller执行之后，返回视图之前执行，ModelMap表示请求Controller处理之后返回的Model对象，所以可以在 * 这个方法中修改ModelMap的属性，从而达到改变返回的模型的效果。 */ @Override public void postHandle(WebRequest request, ModelMap map) throws Exception { // TODO Auto-generated method stub for (String key:map.keySet()) System.out.println(key + "-------------------------");; map.put("name3", "value3"); map.put("name1", "name1"); } /** * 该方法将在整个请求完成之后，也就是说在视图渲染之后进行调用，主要用于进行一些资源的释放 */ @Override public void afterCompletion(WebRequest request, Exception exception) throws Exception { // TODO Auto-generated method stub System.out.println(exception + "-=-=--=--=-=-=-=-=-=-=-=-==-=--=-=-=-="); } }
把定义的拦截器类加到SpringMVC的拦截体系中
使用mvc:interceptors标签来声明需要加入到SpringMVC拦截器链中的拦截器。
重写WebMvcConfigurer的addInterceptors方法进行拦截器注册
/** 注册拦截器 **/ @Override public void addInterceptors(InterceptorRegistry registry) { AllInterceptor allInterceptor = new AllInterceptor(); // 注册拦截器及要拦截的请求，支持通配符** registry.addWebRequestInterceptor(allInterceptor).addPathPatterns("/fromIndex"); SpringMVCInterceptor mvcInterceptor = new SpringMVCInterceptor(); registry.addInterceptor(mvcInterceptor).addPathPatterns("/fromIndex/**"); }
二、Servlet、Listener、Filter
有两种方式：
- 实现WebApplicationInitializer接口，通过重写onStartup(ServletContext servletContext)方法添加其他的Servlet、Filter以及Listener（启动时就注册）。
- 通过为@WebServlet、@WebFilter、@WebListener添加其他的Servlet、Filter以及Listener。
第一种方式
import org.springframework.web.WebApplicationInitializer; import javax.servlet.DispatcherType; import javax.servlet.FilterRegistration; import javax.servlet.MultipartConfigElement; import javax.servlet.ServletContext; import javax.servlet.ServletException; import javax.servlet.ServletRegistration; import java.util.EnumSet; import java.util.HashMap; import java.util.Map; public class WebInitializer implements WebApplicationInitializer { private static final String LOCATION = "C:/temp/"; // Temporary location where files will be stored private static final long MAX_FILE_SIZE = 5242880; // 5MB : Max file size. // Beyond that size spring will throw exception. private static final long MAX_REQUEST_SIZE = 20971520; // 20MB : Total request size containing Multi part. private static final int FILE_SIZE_THRESHOLD = 0; // Size threshold after which files will be written to disk @Override public void onStartup(ServletContext servletContext) throws ServletException { System.out.println("启动服务......"); //注册Servlet this.registerServlet(servletContext); //注册Filter this.registerFilter(servletContext); //注册Listener this.registerListener(servletContext); } private void registerServlet(ServletContext servletContext){ //创建继承HttpServlet的类, 如：ServletTest ServletRegistration.Dynamic servletBean = servletContext.addServlet("ServletTest", ServletTest.class); //容器是否应该在启动的时候加载这个servlet，(实例化并调用其init()方法) //必须是一个整数 //如果该元素不存在或者这个数为负时，则容器会当该Servlet被请求时，再加载 //当值为0或者大于0时，表示容器在应用启动时就加载并初始化这个servlet //正数的值越小，该servlet的优先级越高，应用启动时就越先加载 //当值相同时，容器就会自己选择顺序来加载 servletBean.setLoadOnStartup(0); //设置初始化参数 Map<String, String> initParams = new HashMap<String, String>(); servletBean.setInitParameters(initParams); //异步支持 servletBean.setAsyncSupported(true); //文件上传配置 MultipartConfigElement multipartConfigElement = new MultipartConfigElement( LOCATION, MAX_FILE_SIZE, MAX_REQUEST_SIZE, FILE_SIZE_THRESHOLD); servletBean.setMultipartConfig(multipartConfigElement); } private void registerFilter(ServletContext servletContext){ //创建实现Filter接口的类， 如： FilterTest FilterRegistration.Dynamic druidStatFilter = servletContext.addFilter("FilterTest", FilterTest.class); Map<String, String> initParams = new HashMap<String, String>(); druidStatFilter.setInitParameters(initParams); druidStatFilter.addMappingForUrlPatterns( EnumSet.of(DispatcherType.REQUEST, DispatcherType.FORWARD, DispatcherType.INCLUDE), false, "/*"); } private void registerListener(ServletContext servletContext){ //创建实现以下接口的类，重写接口方法 //监听器的种类很多, 如: //HttpSessionListener //ServletRequestListener //ServletContextListener //HttpSessionAttributeListener //ServletRequestAttributeListener //ServletContextAttributeListener servletContext.addListener(HttpSessionListenerTest.class); servletContext.addListener(ServletRequestListenerTest.class); servletContext.addListener(ServletContextListenerTest.class); } }
第二种方式
其实这种方式并不是Spring才有的。
@WebServlet
在servlet3.0以后，只需要加上@WebServlet注解就可以修改该servlet的属性了。web.xml可以配置的servlet属性，在@WebServlet中都可以配置。
有以下属性可以配置：
- name：字符串指定Servlet 的 name 属性，等价于 <servlet-name>。如果没有显式指定，则该 Servlet 的取值即为类的全限定名。
- value：数组，等价于 urlPatterns 属性。两个属性不能同时使用。
- urlPatterns：数组，指定一组 Servlet 的 URL 匹配模式。等价于<url-pattern>标签。
- loadOnStartup：数字，指定 Servlet 的加载顺序，等价于 <load-on-startup>标签。
- initParams：WebInitParam[]，指定一组 Servlet 初始化参数，等价于<init-param>标签。
- asyncSupported：布尔型，声明 Servlet 是否支持异步操作模式，等价于<async-supported> 标签。
import javax.servlet.ServletException; import javax.servlet.annotation.WebInitParam; import javax.servlet.annotation.WebServlet; import javax.servlet.http.HttpServlet; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; import java.io.IOException; @WebServlet(urlPatterns = "/servletTest",asyncSupported = true, loadOnStartup = 0, initParams = { @WebInitParam(name = "userName", value = "COOKIE"), @WebInitParam(name = "password", value = "123456"), }) public class ServletTest extends HttpServlet { @Override protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException { this.doPost(req, resp); } @Override protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException { System.out.println("ServletTest-doPost"); } }
@WebFilter
@WebFilter 用于将一个类声明为过滤器，该注解将会在部署时被容器处理，容器将根据具体的属性配置将相应的类部署为过滤器。该注解具有下表给出的一些常用属性 ( 以下所有属性均为可选属性，但是 value、urlPatterns、servletNames 三者必需至少包含一个，且 value 和 urlPatterns 不能共存，如果同时指定，通常忽略 value 的取值 )
- filterName：过滤器名称，等价于<filter-name></filter-name>
- urlPatterns/value：数组，两个属性作用相同，指定拦截的路径。
- dispatcherTypes：DispatcherType[]，指定Filter对哪种方式的请求进行过滤。支持的属性：ASYNC、ERROR、FORWARD、INCLUDE、REQUEST；默认过滤所有方式的请求。
- initParams：WebInitParam[]，配置参数。
- servletNames：数组，指定对哪些Servlet进行过滤。
- asyncSupported：指定Filter是否支持异步模式。
import javax.servlet.DispatcherType; import javax.servlet.Filter; import javax.servlet.FilterChain; import javax.servlet.FilterConfig; import javax.servlet.ServletException; import javax.servlet.ServletRequest; import javax.servlet.ServletResponse; import javax.servlet.annotation.WebFilter; import javax.servlet.annotation.WebInitParam; import java.io.IOException; @WebFilter(urlPatterns = "/*", asyncSupported = true, dispatcherTypes = {DispatcherType.FORWARD, DispatcherType.REQUEST}, initParams = { @WebInitParam(name = "userName", value = "Cookie"), @WebInitParam(name = "password", value = "123456") }) public class FilterTest implements Filter { @Override public void init(FilterConfig filterConfig) throws ServletException { System.out.println("filter 初始化...."); } @Override public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException { System.out.println("Filter----------"); filterChain.doFilter(servletRequest, servletResponse); } @Override public void destroy() { } }
@WebListener
用来监听特定对象的创建或销毁、属性的变化。
监听器接口的分类：
ServletRequestListener 监听request对象的创建或销毁
HttpSessionListener 监听session对象的创建或销毁
ServletContextListener 监听servletContext对象的创建或销毁
ServletRequestAttributeListener 监听request对象属性变化: 添加、移除、修改
HttpSessionAttributeListener 监听session对象属性变化: 添加、移除、修改
ServletContextAttributeListener 监听servletContext对象属性变化
HttpSessionBindingListener 监听对象绑定到session上的事件
HttpSessionActivationListener(了解) 监听session序列化及反序列化的事件
import javax.servlet.ServletRequestEvent; import javax.servlet.ServletRequestListener; import javax.servlet.annotation.WebListener; @WebListener public class ServletRequestListenerTest implements ServletRequestListener { @Override public void requestDestroyed(ServletRequestEvent servletRequestEvent) { // 获取request中存放的数据 Object obj = servletRequestEvent.getServletRequest().getAttribute("cn"); System.out.println(obj); System.out.println("ServletRequestListener.requestDestroyed()"); } @Override public void requestInitialized(ServletRequestEvent servletRequestEvent) { System.out.println("ServletRequestListener.requestInitialized()"); } }
