在Spring Boot中,拦截器可以分为两种类型:

  • 一是WebMVC,负责拦截请求,类似于过滤器,对用户的请求在Controller接收前进行处理,在Controller处理完成后加工结果等。使用时需实现HandlerInterceptor接口。
  • 一是AOP,拦截指定类型的方法,通过动态代理模式实现,可以在方法的调用前和调用后添加功能处理。使用时需要实现MethodInterceptor接口。

拦截器(Interceptor)和过滤器(Filter)对比

相同点:

  • 都可以对请求进行提前处理和响应内容加工。
  • 都支持多个拦截器/过滤器的链路传递。

不同点:

  • 拦截器由Spring提供,过滤器由Servlet提供。

HandlerInterceptor

HandlerInterceptor接口属于顶级接口,里面一共有三个default方法(这是jdk8的新特性,用来在接口中编写带有方法体的方法。实现接口可以不重写default方法,默认调用的仍是接口中的default方法体)

public interface HandlerInterceptor {
default boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
return true;
} default void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, @Nullable ModelAndView modelAndView) throws Exception {
} default void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, @Nullable Exception ex) throws Exception {
}
}
boolean preHandle:会在controller处理前调用该方法,方法返回true则进入对应的controller。方法返回false则不会进入controller。可以用来编码,安全控制,权限校验等。
void postHandle:在controller处理完成返回ModelAndView后执行。此时还没有进行视图渲染,还可以修改ModelAndView。
void afterCompletion:整个请求已经处理完成了,可能返回了正常的请求结果,也可能返回一个异常。

下面我们来做一个简单的demo。

先定义一个controller:

@RestController
public class UserController { @GetMapping("users/{id}")
public String getUser(@PathVariable("id") String id) {
System.out.println("controller[url=users/" + id + "]");
return "testUser";
} @GetMapping("users/login")
public String test(User user, Model model) {
System.out.println("controller[url=users/login]");
model.addAttribute("id", user.getId());
model.addAttribute("name", user.getName());
model.addAttribute("password", user.getPassword());
model.addAttribute("mail", user.getMail());
return "index";
}
}

里面提供了两个请求链接:/users/{id}和/users/login,这里为了简单方便,我们均将请求方式设置为get。

定义一个拦截器UserInteceptor(这里先测试第一个方法preHandle):

@Component
public class UserInteceptor implements HandlerInterceptor { @Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
System.out.println("preHandle;");
Map<String, String[]> map = request.getParameterMap();
map.forEach((k, v) -> {
System.out.println("[Key=" + k + ";Value=" + StringUtils.join(v) + "];");
});
return true;
} @Override
public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
System.out.println("postHandle");
} @Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
System.out.println("afterCompletion");
}
}

然后将拦截器添加进容器中,设定它的拦截路径为/users/**:

@Configuration
public class InteceptorConfig implements WebMvcConfigurer { @Autowired
private UserInteceptor userInteceptor; @Override
public void addInterceptors(InterceptorRegistry registry) {
registry.addInterceptor(userInteceptor).addPathPatterns("/users/*");
}
}

就此一个简单的项目已经构成,我们启动程序,然后访问/users/login?id=1&username=yxf&password=123&mail=5@qq.com

可以看到访问结果:

preHandle; //----------------------------调用了preHandle方法
[Key=id;Value=]; //---------------------打印request中的id
[Key=name;Value=yxf]; //-----------------打印request中的name
[Key=password;Value=]; //-------------打印request中的password
[Key=mail;Value=@qq.com]; //------------打印request中的mail
controller[url=users/login] //-----------在preHandle之后,这里进入UserController的test方法。
postHandle //----------------------------controller处理完成后调用PostHandle方法。
//---------------在这中间其实还有dispatchServlet调用视图解析器对View的解析等------------------
afterCompletion //-----------------------postHandle处理完成后调用afterCompletion。

顺序是按照preHandle→Controller→postHandle→视图渲染器→afterCompletion的顺序执行。

MethodInterceptor

MethodInterceptor继承关系:

在MethodInterceptor接口中,只提供了一个方法

Object invoke(MethodInvocation invocation) throws Throwable;

首先分析方法的传入参数MethodInvocation

MethodInvocation对象继承关系如下

相关方法说明

Method getMethod(); //获取Java反射类Method

Object[] getArguments(); // 获取方法的传入参数

Object proceed() throws Throwable; // 继续执行方法

Object getThis(); // 获取方法所在的对象

AccessibleObject getStaticPart(); // 获取的也是Java反射类Method

测试Demo

为了方便一部分功能展示,我们这里定义一个注解用来后续操作

@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface DemoAnnotation { String value() default "test"; }

定义我们的方法过滤器,从参数对象获取到被拦截的方法的相关信息,这里为了简单直接将信息打印在控制台(实际情况因具体业务而异)。

public class DemoInterceptor implements MethodInterceptor {

    @Override
public Object invoke(MethodInvocation methodInvocation) throws Throwable {
System.out.println("--------------------------------------------------"); // 参数
Object[] object = methodInvocation.getArguments();
for (Object obj : object) {
System.out.println(obj.getClass().getName());
if (obj instanceof String) {
System.out.println("param = " + ((String) obj).toString());
}
} // 对象
Object obj = methodInvocation.getThis();
System.out.println(obj.getClass().getName()); // 方法
Method method = methodInvocation.getMethod(); // 继续执行
obj = methodInvocation.proceed();
System.out.println(obj.getClass().getName()); // 获取注解
DemoAnnotation d = method.getAnnotation(DemoAnnotation.class);
if (d == null) {
System.out.println("当前类没有DemoAnnotation注解");
} else {
System.out.println(d.value());
} System.out.println("--------------------------------------------------");
return null;
}
}

配置过滤器。(方法过滤器实际可以算是实现AOP的一种方式,我们需要定义一个切面,配置它的切点和增强)

    @Bean
public DefaultPointcutAdvisor defaultPointcutAdvisor() {
// 声明切点
// JdkRegexpMethodPointcut pointcut = new JdkRegexpMethodPointcut();
// pointcut.setPatterns("com.example.*");
AspectJExpressionPointcut pointcut =new AspectJExpressionPointcut();
pointcut.setExpression("execution(* com.example..*(*))"); // 拦截com.example包和子包下带一个参数的任何方法 // 声明增强
DemoInterceptor interceptor = new DemoInterceptor(); // 配置切面
DefaultPointcutAdvisor advisor = new DefaultPointcutAdvisor();
advisor.setPointcut(pointcut);
advisor.setAdvice(interceptor); return advisor;
}

定义调用类,这里为了简单,也没有写service层,直接在controller层调用了。

@RestController
public class DemoController { @GetMapping("/demo/{id}")
public String demo(@PathVariable("id") String id) {
return "test demo";
} @GetMapping("/demo2/{id}")
@DemoAnnotation
public String demo2(@PathVariable("id") String id) {
return "test demo";
} }

运行程序,分别访问上面的两个地址,打印如下

/demo/1

--------------------------------------------------
java.lang.String
param =
com.example.demo.controller.DemoController
java.lang.String
当前类没有DemoAnnotation注解
--------------------------------------------------

/demo2/2

--------------------------------------------------
java.lang.String
param =
com.example.demo.controller.DemoController
java.lang.String
test
--------------------------------------------------

结束

spring拦截器Interceptor的更多相关文章

  1. web 过滤器 Filter、 Spring 拦截器 interceptor

    1.过滤器(Filter)(在web.xml中注册过滤器) 首先说一下Filter的使用地方,我们在配置web.xml时,总会配置下面一段设置字符编码,不然会导致乱码问题: <filter> ...

  2. spring拦截器(interceptor)简介

    1. 拦截器用途 (1)拦截未登录用户直接访问某些链接 (2)拦截日志信息 (3)拦截非法攻击,比如sql注入 2. 涉及jar.类 (1)spring-webmvc.jar (2)HandlerIn ...

  3. Spring中过滤器(Filter)和拦截器(Interceptor)的区别和联系

    在我们日常的开发中,我们经常会用到Filter和Interceptor.有时同一个功能.Filter可以做,Interceptor也可以做.有时就需要考虑使用哪一个比较好.这篇文章主要介绍一下,二者的 ...

  4. Spring拦截器中通过request获取到该请求对应Controller中的method对象

    背景:项目使用Spring 3.1.0.RELEASE,从dao到Controller层全部是基于注解配置.我的需求是想在自定义的Spring拦截器中通过request获取到该请求对应于Control ...

  5. java之拦截器Interceptor

    1,拦截器的概念    java里的拦截器是动态拦截Action调用的对象,它提供了一种机制可以使开发者在一个Action执行的前后执行一段代码,也可以在一个Action执行前阻止其执行,同时也提供了 ...

  6. 过滤器(Filter)和拦截器(Interceptor)

    过滤器(Filter) Servlet中的过滤器Filter是实现了javax.servlet.Filter接口的服务器端程序.它依赖于servlet容器,在实现上,基于函数回调,它可以对几乎所有请求 ...

  7. spring拦截器中修改响应消息头

    问题描述 前后端分离的项目,前端使用Vue,后端使用Spring MVC. 显然,需要解决浏览器跨域访问数据限制的问题,在此使用CROS协议解决. 由于该项目我在中期加入的,主要负责集成shiro框架 ...

  8. Spring 拦截器实现+后台原理(HandlerInterceptor)

    过滤器跟拦截器的区别 spring mvc的拦截器是只拦截controller而不拦截jsp,html 页面文件的.这就用到过滤器filter了,filter是在servlet前执行的,你也可以理解成 ...

  9. 二十五、过滤器Filter,监听器Listener,拦截器Interceptor的区别

    1.Servlet:运行在服务器上可以动态生成web页面.servlet的声明周期从被装入到web服务器内存,到服务器关闭结束.一般启动web服务器时会加载servelt的实例进行装入,然后初始化工作 ...

随机推荐

  1. matlab 实现感知机线性二分类算法(Perceptron)

    感知机是简单的线性分类模型 ,是二分类模型.其间用到随机梯度下降方法进行权值更新.参考他人代码,用matlab实现总结下. 权值求解过程通过Perceptron.m函数完成 function W = ...

  2. Kafka在window上安装部署

    1.准备工作   ①jdk 具体自行百度安装jdk,配置好 JAVA_HOME和path, 下载地址:   http://www.oracle.com/technetwork/java/javase/ ...

  3. NVIDIA驱动安装、CUDA安装、cudnn安装

    1.禁用 nouveau 驱动 sudo vim /etc/modprobe.d/nvidia-installer-disable-nouveau.conf 或者 sudo vim /etc/modp ...

  4. D - Tree and Hamilton Path

    题意 给一棵树,问一个排列,使得按顺序走过这些点的路径最长. N<=100000 解法 为了能让每条边被经过的次数达到上界, 我们首先找出重心, 然后容易得出一种排列方案,使得答案为以重心为根的 ...

  5. redis学习笔记04-事务

    1.redis事务 事务实际上指的是一组命令的集合,执行时会按顺序串行的执行,中途不能加入其它命令.它用来解决批处理需求. 在redis中的基本使用如下: >multi ok >incr ...

  6. python-基础-函数-局部和全局变量

    1 函数的定义和调用 1.1 函数定义 1.2 函数的调用 2 函数参数 >>> def fun(a, b, *args, **kwargs): ... ""&q ...

  7. 文件内容操作命令 cat、more、less、head、tail、wc、grep 命令详情

      文件内容操作命令 cat.more.less.head.tail.wc.grep 命令详情 1)        cat命令   用途:显示出文件的全部内容   格式:cat 目标文件   例:   ...

  8. TZOJ 1503 Incredible Cows(折半搜索+二分)

    描述 Farmer John is well known for his great cows. Recently, the cows have decided to participate in t ...

  9. Leetcode151. Reverse Words in a String翻转字符串里的单词

    给定一个字符串,逐个翻转字符串中的每个单词. 示例: 输入: "the sky is blue", 输出: "blue is sky the". 说明: 无空格 ...

  10. 宝塔https

    登录宝塔论坛,然后申请免费的https,然后在域名控制面板添加解析并验证,最后宝塔强制https跳转