拦截器
要了解Spring拦截器的作用,我们需要先解释一下HTTP请求的执行链。DispatcherServlet捕获每个请求。调度员做的第一件事就是将接收到的URL和相应的controller进行映射(controller必须恰到好处地处理当前的请求)。但是,在到达对应的controller之前,请求可以被拦截器处理。这些拦截器就像过滤器。只有当URL找到对应于它们的映射时才调用它们。在通过拦截器(拦截器预处理,其实也可以说前置处理)进行前置处理后,请求最终到达controller。之后,发送请求生成视图。但是在这之前,拦截器还是有可能来再次处理它(拦截器后置处理)。只有在最后一次操作之后,视图解析器才能捕获数据并输出视图。
在Spring Boot中,拦截器分为两类:
一种是对请求进来的url进行拦截,HandlerInterceptor接口;
一种是对发送出去的请求进行拦截,ClientHttpRequestInterceptor。
处理程序映射拦截器基于org.springframework.web.servlet.HandlerInterceptor接口。和之前简要描述的那样,它们可以在将其发送到控制器(方法前使用preHandle)之前或之后(方法后使用postHandle)拦截请求。preHandle方法返回一个布尔值,如果返回false,则可以在执行链中执行中断请求处理。此接口中还有一个方法afterCompletion,只有在preHandler方法发送为true时才会在渲染视图后调用它(完成请求处理后的回调,即渲染视图后)。
拦截器也可以在新线程中启动。在这种情况下,拦截器必须实现org.springframework.web.servlet.AsyncHandlerInterceptor接口。它继承HandlerInterceptor并提供一个方法afterConcurrentHandlingStarted。每次处理程序得到正确执行时,都会调用此方法而不是调用postHandler()和afterCompletion()。它也可以对发送请求进行异步处理。通过Spring源码此方法注释可以知道,这个方法的典型的应用是可以用来清理本地线程变量。
public class LotteryInterceptor implements HandlerInterceptor {
public static final String ATTR_NAME = "lottery_winner";
private static final Logger LOGGER = LoggerFactory.getLogger(LotteryInterceptor.class);
@Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception exception) throws Exception {
LOGGER.debug("[LotteryInterceptor] afterCompletion");
}
@Override
public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView view) throws Exception {
LOGGER.debug("[LotteryInterceptor] postHandle");
}
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
LOGGER.debug("[LotteryInterceptor] preHandle");
if (request.getSession().getAttribute(ATTR_NAME) == null) {
Random random = new Random();
int i = random.nextInt(10);
request.getSession().setAttribute(ATTR_NAME, i%2 == 0);
}
return true;
}
}
关于相应controller中要展示的信息:
@Controller
public class TestController {
private static final Logger LOGGER = LoggerFactory.getLogger(TestController.class);
@RequestMapping(value = "/test", method = RequestMethod.GET)
public String test(HttpServletRequest request) {
LOGGER.debug("Controller asks, are you a lottery winner ? "+request.getSession().getAttribute(LotteryInterceptor.ATTR_NAME));
return "test";
}
}
结果:
[LotteryInterceptor] preHandle
Controller asks, are you a lottery winner ? false
[LotteryInterceptor] postHandle
[LotteryInterceptor] afterCompletion
HandlerInterceptor和ClientHttpRequestInterceptor的区别
HandlerInterceptor 和 ClientHttpRequestInterceptor 都是 Spring 框架中的拦截器,但它们的作用和使用场景不同。下面是它们之间的主要区别:
作用范围:
HandlerInterceptor 主要用于拦截处理 Spring 应用中接收到的 HTTP 请求。它允许你在请求处理之前、处理之后、以及视图渲染完成后执行自定义逻辑。
ClientHttpRequestInterceptor 主要用于拦截和处理 Spring 应用中使用 RestTemplate 或 WebClient 发送的 HTTP 请求。它让你在请求发送之前,对请求头、请求体等进行自定义处理。
使用场景:
HandlerInterceptor 通常用于身份验证、授权、日志记录、跨域资源共享(CORS)等应用内请求处理相关的功能。
ClientHttpRequestInterceptor 通常用于处理服务间通信,例如在请求头中添加认证信息、自定义请求头、请求数据处理、重试策略等。
过滤器
在 Spring Boot 中,过滤器(Filter)是用于在 Servlet 容器级别拦截和处理 HTTP 请求的组件。它们通常用于实现诸如身份验证、授权、日志记录、请求和响应的数据转换等功能。过滤器位于整个请求处理链的最前端,因此在请求到达 Spring 应用的任何其他组件之前,都会先经过过滤器处理。
过滤器和拦截器各自优势与区别?
过滤器(Filter)和拦截器(Interceptor)在某些方面的功能确实相似,但它们在使用场景、处理层级和实现方式上有所不同。以下是过滤器和拦截器之间的主要区别和各自的优势:
处理层级:
过滤器(Filter)基于 Java Servlet 规范,在 Servlet 容器级别处理请求。过滤器在整个请求处理链的最前端,因此在请求到达 Spring 应用的任何其他组件之前,都会先经过过滤器处理。
拦截器(Interceptor)是 Spring MVC 的一部分,用于处理 Spring 应用中接收到的请求。拦截器在 Spring 处理请求的过程中起作用,位于过滤器之后。
使用场景:
过滤器(Filter)通常用于实现通用的、与框架无关的功能,如身份验证、授权、日志记录、请求和响应的数据转换等。
拦截器(Interceptor)通常用于实现与 Spring 框架相关的功能,如验证用户身份、授权、请求参数处理、异常处理等。
优势:
过滤器(Filter)可以处理任何 Web 应用的请求,不局限于 Spring。过滤器允许你在请求到达任何框架组件之前对其进行处理,提供了更大的控制范围。
拦截器(Interceptor)更紧密地集成在 Spring MVC 中,因此可以更方便地使用 Spring 提供的功能。拦截器可以访问 Spring 上下文,让你能够轻松地使用其他 Spring 组件和服务。
实现方式:
过滤器(Filter)需要实现 javax.servlet.Filter 接口,并实现 init、doFilter 和 destroy 方法。
拦截器(Interceptor)需要实现 HandlerInterceptor 接口(对于请求拦截)或 ClientHttpRequestInterceptor 接口(对于客户端请求拦截),并实现相应的方法。
总的来说,过滤器和拦截器在功能上有一定的重叠,但它们的使用场景、处理层级和实现方式有所不同。选择使用过滤器还是拦截器取决于你的具体需求和场景。当你需要处理与框架无关的请求时,可以使用过滤器;当你需要实现与 Spring 框架相关的功能时,拦截器可能是更好的选择。