spring boot 拦截器

来源:互联网 发布:知乎海贼王回答集锦 编辑:程序博客网 时间:2024/04/30 05:00

紧接着上一篇,我们来了解一下spring boot 中的拦截器。

实现自定义拦截器只需要3步:
1、创建我们自己的拦截器类并实现 HandlerInterceptor 接口。
2、创建一个Java类继承WebMvcConfigurerAdapter,并重写 addInterceptors 方法。
3、实例化我们自定义的拦截器,然后将对像手动添加到拦截器链中(在addInterceptors方法中添加)。

首先我们先来创建两个拦截器测试类TestInterceptorFirst和TestInterceptorSec类,代码如下:

package com.god.servlet;import org.springframework.web.servlet.HandlerInterceptor;import org.springframework.web.servlet.ModelAndView;import javax.servlet.http.HttpServletRequest;import javax.servlet.http.HttpServletResponse;/** * Created by wujiaqi on 17/10/11. */public class TestInterceptorFirst implements HandlerInterceptor {    @Override    public boolean preHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o) throws Exception {        System.out.println("-------------TestInterceptorFirst在请求处理之前进行调用(Controller方法调用之前)");        return true; //true则继续向下执行,false则取消当前请求    }    @Override    public void postHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, ModelAndView modelAndView) throws Exception {        System.out.println("-------------TestInterceptorFirst在请求处理之后视图渲染之前进行调用(Controller方法调用之后)");    }    @Override    public void afterCompletion(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, Exception e) throws Exception {        System.out.println("-------------TestInterceptorFirst在请求完成之后被调用,也就是在DispatcherServlet 渲染了对应的视图之后执行(主要是用于进行资源清理工作)");    }}
package com.god.servlet;import org.springframework.web.servlet.HandlerInterceptor;import org.springframework.web.servlet.ModelAndView;import javax.servlet.http.HttpServletRequest;import javax.servlet.http.HttpServletResponse;/** * Created by wujiaqi on 17/10/11. */public class TestInterceptorSec implements HandlerInterceptor {    @Override    public boolean preHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o) throws Exception {        System.out.println("-------------TestInterceptorSec在请求处理之前进行调用(Controller方法调用之前)");        return true; //true则继续向下执行,false则取消当前请求    }    @Override    public void postHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, ModelAndView modelAndView) throws Exception {        System.out.println("-------------TestInterceptorSec在请求处理之后视图渲染之前进行调用(Controller方法调用之后)");    }    @Override    public void afterCompletion(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, Exception e) throws Exception {        System.out.println("-------------TestInterceptorSec在请求完成之后被调用,也就是在DispatcherServlet 渲染了对应的视图之后执行(主要是用于进行资源清理工作)");    }}

接着根据步骤二创建继承了WebMvcConfigurerAdapter的配置类,同时重写addInterceptors方法。代码如下:

@Configurationpublic class MyWebMvcConfigurerAdapte extends WebMvcConfigurerAdapter {    @Override    public void addInterceptors(InterceptorRegistry registry) {        registry.addInterceptor(new TestInterceptorFirst()).addPathPatterns("/**");        registry.addInterceptor(new TestInterceptorSec()).addPathPatterns("/**");        registry.addWebRequestInterceptor(new TestWebInterceptor()).addPathPatterns("/**");        super.addInterceptors(registry);    }}

好了,接下来让我们运行一下并看一下执行结果。
————-TestWebInterceptor在请求处理之前进行调用(Controller方法调用之前)
————-TestInterceptorSec在请求处理之后视图渲染之前进行调用(Controller方法调用之后)
————-TestInterceptorFirst在请求处理之后视图渲染之前进行调用(Controller方法调用之后)
————-TestWebInterceptor在请求处理之前进行调用(Controller方法调用之前)
————-TestInterceptorSec在请求完成之后被调用,也就是在DispatcherServlet 渲染了对应的视图之后执行(主要是用于进行资源清理工作)
————-TestInterceptorFirst在请求完成之后被调用,也就是在DispatcherServlet 渲染了对应的视图之后执行(主要是用于进行资源清理工作)
我们可以看到调用的顺序依次是addWebRequestInterceptor、TestInterceptorSec、TestInterceptorFirst。那我们再把注册顺序换一下改成:

@Configurationpublic class MyWebMvcConfigurerAdapte extends WebMvcConfigurerAdapter {    @Override    public void addInterceptors(InterceptorRegistry registry) {        registry.addInterceptor(new TestInterceptorSec()).addPathPatterns("/**");        registry.addWebRequestInterceptor(new TestWebInterceptor()).addPathPatterns("/**");        registry.addInterceptor(new TestInterceptorFirst()).addPathPatterns("/**");        super.addInterceptors(registry);    }}

来看一下执行结果:
————-TestInterceptorFirst在请求处理之后视图渲染之前进行调用(Controller方法调用之后)
————-TestWebInterceptor在请求处理之前进行调用(Controller方法调用之前)
————-TestInterceptorSec在请求处理之后视图渲染之前进行调用(Controller方法调用之后)
————-TestInterceptorFirst在请求完成之后被调用,也就是在DispatcherServlet 渲染了对应的视图之后执行(主要是用于进行资源清理工作)
————-TestWebInterceptor在请求处理之前进行调用(Controller方法调用之前)
————-TestInterceptorSec在请求完成之后被调用,也就是在DispatcherServlet 渲染了对应的视图之后执行(主要是用于进行资源清理工作)
可以看出来执行结果是由注册时候的倒序执行的。
最后强调一点:只有经过DispatcherServlet 的请求,才会走拦截器链,我们自定义的Servlet 请求是不会被拦截的。并且不管是属于哪个Servlet 只要复合过滤器的过滤规则,过滤器都会拦截。还有一点是以上拦截器并不适用Jersey风格的spring boot接口,并不会出发拦截器。

原创粉丝点击