Interception

所有 HandlerMapping 的实现都支持处理程序拦截器，当你想对某些请求应用特定的功能时，这些拦截器是非常有用的 — 例如，检查一个委托人。拦截器必须实现 org.springframework.web.servlet包中的 HandlerInterceptor，它有三个方法，应该可以提供足够的灵活性来进行各种预处理和后处理：

  • preHandle(..)：在实际处理程序运行之前

  • postHandle(..)：处理程序运行后

  • afterCompletion(..)：在完整的请求完成后运行，也就是说，只要 preHandle 执行了，无论 postHandler 是否正常完成（抛出了异常），afterCompletion 也会执行

preHandle(..)方法返回一个布尔值。你可以使用这个方法来 中断或继续执行链 的处理。当这个方法返回 true 时，处理程序执行链继续进行。当它返回 false 时，DispatcherServlet 认为拦截器本身已经处理了请求（例如，渲染了一个适当的视图），并且不继续执行其他拦截器和执行链中的实际处理程序。

关于如何配置拦截器的例子，请参见 MVC 配置部分的 拦截器。你也可以通过使用个别 HandlerMapping 实现的设置器来直接注册它们。

请注意，postHandle 对于 @ResponseBody和 ResponseEntity方法来说用处不大，因为这些方法的响应是在 HandlerAdapter 中和postHandle 之前写入并提交的。这意味着对响应进行任何修改都太晚了，比如添加一个额外的头。对于这种情况，你可以实现ResponseBodyAdvice，并把它声明为一个 Controller Advice Bean，或者直接在 RequestMappingHandlerAdapter上配置它。

下面有一个例子

实现一个拦截器

  1. package cn.mrcode.study.springdocsread.web;
  3. import org.springframework.web.servlet.HandlerInterceptor;
  4. import org.springframework.web.servlet.ModelAndView;
  6. import javax.servlet.http.HttpServletRequest;
  7. import javax.servlet.http.HttpServletResponse;
  9. /**
  10.  * @author mrcode
  11.  */
  12. public class MyHandlerInterceptor implements HandlerInterceptor {
  14.     @Override
  15.     public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
  16.         System.out.println("preHandle");
  17.         return true;
  18.     }
  20.     @Override
  21.     public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
  22.         //  这里尝试修改响应值或则添加响应头也不会生效
  23.         response.addHeader("xxxxxxxxx", "xxxxxx");
  24.         if(true) throw new RuntimeException();
  25.         System.out.println("postHandle");
  26.     }
  28.     @Override
  29.     public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
  30.         System.out.println("afterCompletion");
  31.     }
  32. }

注册拦截器（这里的知识后面才学，可以先不用管这个）

  1. package cn.mrcode.study;
  3. import org.springframework.context.annotation.ComponentScan;
  4. import org.springframework.context.annotation.Configuration;
  5. import org.springframework.web.servlet.config.annotation.EnableWebMvc;
  6. import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
  7. import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
  9. import cn.mrcode.study.springdocsread.web.MyHandlerInterceptor;
  11. /**
  12.  * @author mrcode
  13.  */
  14. @EnableWebMvc
  15. @ComponentScan("cn.mrcode.study.springdocsread")
  16. @Configuration
  17. public class AppConfig implements WebMvcConfigurer {
  19.     @Override
  20.     public void addInterceptors(InterceptorRegistry registry) {
  21.         registry.addInterceptor(new MyHandlerInterceptor()).addPathPatterns("/hello/*");
  22.     }
  23. }

controller

  1. package cn.mrcode.study.springdocsread.web;
  3. import org.springframework.stereotype.Controller;
  4. import org.springframework.web.bind.annotation.RequestMapping;
  5. import org.springframework.web.bind.annotation.ResponseBody;
  7. /**
  8.  * @author mrcode
  9.  */
  10. @Controller
  11. @RequestMapping("/hello")
  12. public class DemoController {
  13.     public DemoController() {
  14.         System.out.println("x");
  15.     }
  17.     @RequestMapping("/list")
  18.     @ResponseBody
  19.     public String test() {
  20.         return "success";
  21.     }
  22. }

访问 [http://localhost:8080/hello/list](http://localhost:8080/hello/list) 响应结果是 success，但是控制台却如下所示

  1. preHandle
  2. afterCompletion
  3. 三月 29, 2022 3:10:26 下午 org.apache.catalina.core.StandardWrapperValve invoke
  4. 严重: Servlet.service() for servlet [app] in context with path [] threw exception [Request processing failed; nested exception is java.lang.RuntimeException] with root cause
  5. java.lang.RuntimeException
  6.     at cn.mrcode.study.springdocsread.web.MyHandlerInterceptor.postHandle(MyHandlerInterceptor.java:22)
  7.     at org.springframework.web.servlet.HandlerExecutionChain.applyPostHandle(HandlerExecutionChain.java:165)
  8.     at org.springframework.web.servlet.DispatcherServlet.doDispatch(DispatcherServlet.java:1074)
  9.     at org.springframework.web.servlet.DispatcherServlet.doService(DispatcherServlet.java:963)
  10.     at org.springframework.web.servlet.FrameworkServlet.processRequest(FrameworkServlet.java:1006)
  11.     at org.springframework.web.servlet.FrameworkServlet.doGet(FrameworkServlet.java:898)

在 postHandle 中异常，不影响响应结果。

ResponseBodyAdvice 改写值的例子

  1. package cn.mrcode.study.springdocsread.web;
  3. import org.springframework.core.MethodParameter;
  4. import org.springframework.http.MediaType;
  5. import org.springframework.http.server.ServerHttpRequest;
  6. import org.springframework.http.server.ServerHttpResponse;
  7. import org.springframework.web.bind.annotation.ControllerAdvice;
  8. import org.springframework.web.servlet.mvc.method.annotation.ResponseBodyAdvice;
  10. /**
  11.  * @author mrcode
  12.  */
  14. // 这里指定对那些 controller 生效
  15. @ControllerAdvice(assignableTypes = {DemoController.class})
  16. public class MyResponseBodyAdvice implements ResponseBodyAdvice {
  17.     /**
  18.      *
  19.      * @param returnType 控制器的参数类型
  20.      * @param converterType 返回值选定的转换器
  21.      * @return
  22.      */
  23.     @Override
  24.     public boolean supports(MethodParameter returnType, Class converterType) {
  25.         // 关于这里要如何判定是否支持 这个 控制器返回的值，我们是否能改写，我暂时没有更好的例子
  26.         System.out.println(String.format("returnType=%s , converterType=%s", returnType, converterType));
  27.         return true;
  28.     }
  30.     /**
  31.      * 在写入 body 前，调用
  32.      * @param body 控制器返回的值
  33.      * @param returnType
  34.      * @param selectedContentType 被选定响应的 contentType , 比如 text/html
  35.      * @param selectedConverterType 被选定的转换器
  36.      * @param request
  37.      * @param response
  38.      * @return
  39.      */
  40.     @Override
  41.     public Object beforeBodyWrite(Object body, MethodParameter returnType, MediaType selectedContentType, Class selectedConverterType, ServerHttpRequest request, ServerHttpResponse response) {
  42.         System.out.println(String.format("body=%s , returnType=%s , selectedContentType=%s ， selectedConverterType=%s",
  43.                 body, returnType, selectedContentType, selectedConverterType));
  44.         // 这里添加一个响应头
  45.         response.getHeaders().add("mrcode", "mrcode.cn");
  46.         // 这里改写值
  47.         return "update：" + body;
  48.     }
  49. }

:::tips 使用 @ControllerAdvice 标注的话，起地方不用对这个 MyResponseBodyAdvice 进行额外的初始化之类的管理了 :::

实现的效果就是，返回值被改写了，还新增了一个响应头
image.png