这里写目录标题基本概念HandlerInterceptor拦截器HandlerInterceptor讲解MethodInterceptor拦截器二者的区别基本概念

在web开发中拦截器是经常用到的功能。

它可以帮我们预先设置数据以及统计方法的执行效率等等。

Spring中拦截器主要分两种一个是HandlerInterceptor一个是MethodInterceptor。

HandlerInterceptor是SpringMVC项目中的拦截器它拦截的目标是请求的地址比MethodInterceptor先执行。

其工作原理是当请求来时先进行预处理如下

通过HandlerInterceptor实现打印请求开始和结束的日志代码如下

引入相关依赖

dependencygroupIdorg.springframework.boot/groupIdartifactIdspring-boot-starter/artifactId/dependencydependencygroupIdorg.springframework.boot/groupIdartifactIdspring-boot-starter-web/artifactId/dependency拦截器

import

org.springframework.stereotype.Component;

import

org.springframework.web.servlet.HandlerInterceptor;

import

org.springframework.web.servlet.ModelAndView;import

javax.servlet.http.HttpServletRequest;

import

javax.servlet.http.HttpServletResponse;Slf4j

Component

{log.info(request.getRequestURI()

开始执行);return

afterCompletion(HttpServletRequest

request,

{log.info(request.getRequestURI()

执行结束);}}controller

lombok.RequiredArgsConstructor;

import

org.springframework.context.annotation.Configuration;

import

org.springframework.web.servlet.config.annotation.InterceptorRegistry;

import

org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;

import

org.springframework.web.servlet.config.annotation.WebMvcConfigurer;Configuration

public

easyLogControllerInterceptor;Overridepublic

void

addInterceptors(InterceptorRegistry

registry)

{//addPathPatterns用于添加拦截路径//excludePathPatterns用于添加不拦截的路径registry.addInterceptor(easyLogControllerInterceptor).addPathPatterns(/test/user);}//此方法用于配置静态资源路径Overridepublic

void

addResourceHandlers(ResourceHandlerRegistry

registry)

{registry.addResourceHandler(/**).addResourceLocations(classpath:/my/);}

}输出结果

c.x.d.c.EasyLogControllerInterceptor

/test/user开始执行

c.xhy.demo01.controller.HelloController

test

c.x.d.c.EasyLogControllerInterceptor

/test/user执行结束HandlerInterceptor讲解

实现一个HandlerInterceptor拦截器可以直接实现HandlerInterceptor接口也可以继承HandlerInterceptorAdapter类。

这两种方法殊途同归其实HandlerInterceptorAdapter也就是声明了HandlerInterceptor接口中所有方法的默认实现而我们在继承他之后只需要重写必要的方法即可。

下面就是HandlerInterceptorAdapter的代码可以看到一个方法只是默认返回true另外两个是空方法

import

org.springframework.web.servlet.HandlerInterceptor;

import

org.springframework.web.servlet.ModelAndView;import

javax.servlet.http.HttpServletRequest;

import

javax.servlet.http.HttpServletResponse;public

abstract

afterCompletion(HttpServletRequest

request,

{}}这三个方法都是干什么的有什么作用什么时候调用不同的拦截器之间是怎样的调用顺序呢

这还得参考一下DispatcherServlet的doDispatch方法

代码有点长但是它封装了SpringMVC处理请求的整个过程。

首先根据请求找到对应的HandlerExecutionChain它包含了处理请求的handler和所有的HandlerInterceptor拦截器然后在调用hander之前分别调用每个HandlerInterceptor拦截器的preHandle方法若有一个拦截器返回false则会调用triggerAfterCompletion方法并且立即返回不再往下执行若所有的拦截器全部返回true并且没有出现异常则调用handler返回ModelAndView对象再然后分别调用每个拦截器的postHandle方法最后即使是之前的步骤抛出了异常也会执行triggerAfterCompletion方法。

MethodInterceptor拦截器

MethodInterceptor是AOP项目中的拦截器它拦截的目标是方法即使不是controller中的方法

上面的两种拦截器都能起到拦截的效果但是他们拦截的目标不一样实现的机制不同所以有的时候适用不同的场景。

HandlerInterceptoer拦截的是请求地址所以针对请求地址做一些验证、预处理等操作比较合适。

当你需要统计请求的响应时间时MethodInterceptor将不太容易做到因为它可能跨越很多方法或者只涉及到已经定义好的方法中一部分代码。

MethodInterceptor利用的是AOP的实现机制在本文中只说明了使用方式关于原理和机制方面介绍的比较少因为要说清楚这些需要讲出AOP的相当一部分内容。

在对一些普通的方法上的拦截HandlerInterceptoer就无能为力了这时候只能利用AOP的MethodInterceptor。

另外还有一个跟拦截器类似的东西----Filter。

Filter是Servlet规范规定的不属于Spring框架也是用于请求的拦截。

但是它适合更粗粒度的拦截在请求前后做一些编解码处理、日志记录等。

而拦截器则可以提供更细粒度的更加灵活的针对某些请求、某些方法的组合的解决方案。

另外用过人人网的ROSE框架的人都会非常喜欢它的拦截器功能。

因为它实现了全注解的方式只要在类的名字上加上拦截器的注解即表示这是一个拦截器。

而使用这个拦截器的方法或者controller也只需在方法或controller的上面加上这个拦截器的注解。

其实这是一个关注点的转变spring的切面控制在配置文件中配置文件关注哪些地方需要拦截。

而在ROSE中则是在需要拦截的地方关注我要被谁拦截。