Spring拦截器(Interceptor)的运用

最新推荐文章于 2024-04-06 19:25:39 发布

半城风花半城雨

最新推荐文章于 2024-04-06 19:25:39 发布

阅读量6w

点赞数

分类专栏： Java 文章标签： java interceptor 设计模式

本文链接：https://blog.csdn.net/imaginehero/article/details/103658191

版权

Java 专栏收录该内容

24 篇文章 2 订阅

订阅专栏

在以Spring为基础的框架（例如Spring boot, Spring MVC）中，会使用到一种名为拦截器的东西，它属于面向切面编程的架构模式，为我们在API调用前后做一些额外操作提供了便利。

如何使用拦截器？

首先需要建立一个Component类，实现HandlerInterceptor接口或WebRequestInterceptor 接口，然后将这个component类注册到实现了WebMvcConfigurer接口的类中即可。

1. 拦截器实现类

<1> HandlerInterceptor接口

先看一段HandlerInterceptor接口的源码：

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 {
    }
}

它定义了3个default方法，快速复习一下default方法的作用：

default方法能使接口提供一个默认实现的方法，并且不强制实现类重写此方法（有了default方法的接口可以类比抽象类来理解）。

preHandle()

这个方法在进入API之前执行，使用者通常通过这个方法进行权限验证、记录日志以及预处理一些数据。
需要注意一点：
该方法的返回值是boolean类型，如果为false，后续的Interceptor 和Controller 都不会再执行,直接开始执行此拦截器之前的所有拦截器的afterCompletion()方法；如果为true，则会继续进入到下一个拦截器的preHandle()方法中，若为最后一个拦截器则直接进入Controller方法。

postHandle()

在当前请求进行处理之后、进行视图返回渲染之前被调用，这个时候可以通过此方法修改ModelAndView返回值信息。
需要注意两点：

postHandle方法的执行顺序与preHandle相反，最后声明的最先执行
如果程序抛出异常，则不会执行此方法

afterCompletion()

在请求处理完成后执行，通常用于清理资源或打印日志

<2> WebRequestInterceptor接口

同样，先看一段WebRequestInterceptor接口的源码：

public interface WebRequestInterceptor {
    void preHandle(WebRequest var1) throws Exception;

    void postHandle(WebRequest var1, @Nullable ModelMap var2) throws Exception;

    void afterCompletion(WebRequest var1, @Nullable Exception var2) throws Exception;
}

与刚才的接口非常相似，定义了与HandlerInterceptor接口相同且用法一致的3个方法，但它们并非default方法，因此需要它的实现类同时实现这3个方法。

⚠️虽然接口命名以及用法有着高度的一致性，但是仍有部分需要注意的点：

WebRequest 参数
3个方法均有为WebRequest类型的参数，它是Spring 定义的一个接口，提供的方法基本与HttpServletRequest相同，在WebRequestInterceptor接口中对WebRequest 进行的所有操作都将同步到HttpServletRequest中，并在当前请求中继续传递。
preHandle()返回值
在这个接口中，preHandle方法无返回值，因此我们通常只在其中做资源准备工作而无法中断整个流程。
postHandle()的ModelMap参数
在postHandle方法中，我们可以通过操作ModelMap对象来修改API的返回值。
afterCompletion()的Exception参数
此参数能够获得在API运行时抛出的异常，若有异常处理器已将异常在内部处理，则此参数值为null。

2. 拦截器配置类

作为拦截器配置类，需要完成拦截器的注册工作，保持拦截器的运行顺序。配置类需实现WebMvcConfigurer接口。

WebMvcConfigurer接口

WebMvcConfigurer接口定义了十几个default方法，其中与拦截器相关的方法为 default void addInterceptors(InterceptorRegistry registry);
在接口的实现类中，需要重写这个方法来注册我们的拦截器。

拦截器示例

1. 最常用方案示例

我们以最常见的场景为例----在调用API前以及其返回后打印log。

首先定义一个拦截器，分别在preHandle和afterCompletion方法中构造了相应的log：

@Component
public class LoggerInterceptor implements HandlerInterceptor {

  private static Logger LOGGER = LoggerFactory.getLogger(LoggerInterceptor.class.getSimpleName());

  @Autowired
  private TokenAuthHelper authHelper;

  /**
   * Executed before actual handler is executed
   **/
  @Override
  public boolean preHandle(final HttpServletRequest request,
      final HttpServletResponse response, final Object handler) {
    LOGGER.info("[{}][{}][preHandle][{}]{}{}", getUserUuid(), IpUtil.getIpAddress(request),
        request.getMethod(), request.getRequestURI(), getParameters(request));
    return true;
  }

  /**
   * Executed after complete request is finished
   **/
  @Override
  public void afterCompletion(final HttpServletRequest request,
      final HttpServletResponse response, final Object handler, final Exception ex) {
    if (ex != null) {
      LOGGER.info("[{}][{}][afterCompletion][{}]{}[exception: {}]", getUserUuid(),
          IpUtil.getIpAddress(request), request.getMethod(), request.getRequestURI(), ex.toString(),
          ex);
    } else {
      LOGGER.info("[{}][{}][afterCompletion][{}]{}", getUserUuid(), IpUtil.getIpAddress(request),
          request.getMethod(), request.getRequestURI());
    }
  }

  private String getUserUuid() {
    String userUuid = authHelper.getCurrentUserUuid();
    return StringUtils.isNotBlank(userUuid) ? userUuid : "anonymous";
  }

  private String getParameters(final HttpServletRequest request) {
    final StringBuilder posted = new StringBuilder();
    final Enumeration<?> e = request.getParameterNames();
    while (e != null && e.hasMoreElements()) {
      if (posted.length() == 0) {
        posted.append("?");
      } else if (posted.length() > 1) {
        posted.append("&");
      }
      final String curr = (String) e.nextElement();
      posted.append(curr).append("=");
      if (curr.contains("password") || curr.contains("pwd")) {
        posted.append("*****");
      } else {
        posted.append(request.getParameter(curr));
      }
    }
    return posted.toString();
  }
}

然后我们构造了一个注册类，将这个拦截器注册到我们的系统中来：

@Configuration
public class WebConfig implements WebMvcConfigurer {

  @Autowired
  private LoggerInterceptor loggerInterceptor;

  @Override
  public void addInterceptors(InterceptorRegistry registry) {
    registry.addInterceptor(loggerInterceptor);
  }
}

下图是我调用API后的测试结果：
在这里插入图片描述
可以看到，在API的调用前后，均打印出了调用者的uuid以及IP，并且利用反射机制不仅获得了API的路径，同时也将参数拼装到路径后，形成了整体的CURL路径。这种应用对debug非常有帮助。

⚠️注意：如果Interceptor没有使用任何依赖，则无需加@Component注解，在注册时也无需使用@Autowired引入，可以直接new 对象即可：

registry.addInterceptor(new LoggerInterceptor());

2. 拦截器顺序示例

我们先定义3个拦截器A B C，都重写3个方法，每个方法打印一句话：

public class AInterceptor implements HandlerInterceptor {

  private static Logger LOGGER = LoggerFactory.getLogger(AInterceptor.class.getSimpleName());

  @Override
  public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) {
    LOGGER.info("run A preHandle()");
    return true;
  }

  @Override
  public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler,
      ModelAndView modelAndView) {
    LOGGER.info("run A postHandle()");
  }

  @Override
  public void afterCompletion(HttpServletRequest request, HttpServletResponse response,
      Object handler, Exception ex) {
    LOGGER.info("run A afterCompletion()");
  }

现在将A B C顺序注册到WebMvcConfigurer的addInterceptors()方法中：

@Configuration
public class WebConfig implements WebMvcConfigurer {

  @Override
  public void addInterceptors(InterceptorRegistry registry) {
    registry.addInterceptor(new AInterceptor());
    registry.addInterceptor(new BInterceptor());
    registry.addInterceptor(new CInterceptor());
  }
}

最后简化一下刚刚调用的API，使其只在运行时打印一条Log：“run API”。
开始测试：
在这里插入图片描述
可以看到它们的执行顺序如上图，那么我们来验证一些preHandle的返回值效果。我现在将B的preHandle()在打印log之后的返回值设为false，重新运行项目并调用API，结果如下：

由于B的preHandle()方法返回false，因此不会继续执行后续拦截器以及API，只会继续执行前面的拦截器的afterCompletion()方法。

总结

拦截器是一种面向切面编程的设计实现，它能够方便的在API调用前后进行记录、修改request/response等操作，大大的简化了代码，提升代码复用性的同时降低了其耦合度，这是Spring给出的一种非常棒的设计模式！

半城风花半城雨

关注

0
点赞
踩
5

收藏

觉得还不错? 一键收藏
0
评论
Spring拦截器(Interceptor)的运用

拦截器是一种面向切面编程的设计实现，它能够方便的在API调用前后进行记录、修改request/response等操作，大大的简化了代码，提升代码复用性的同时降低了其耦合度，这是Spring给出的一种非常棒的设计模式！
复制链接

扫一扫