浅谈SpringMVC HandlerInterceptor诡异问题排查

下面来详细讲解如何排查 SpringMVC HandlerInterceptor 的诡异问题。

1. 确定问题

当我们在 SpringMVC 中使用 HandlerInterceptor 的时候，发现执行顺序有问题，拦截器不按照我们希望的顺序执行，或者是某个拦截器失效了。这个时候，我们首先需要确定问题的根源。

1.1 确定是哪个拦截器失效

我们可以通过在每个拦截器中添加日志来判断当前拦截器是否执行。如果添加日志后发现某个拦截器没有被执行，我们可以在这个拦截器中打上断点并调试，查看其执行流程，找到问题的原因。

1.2 确定拦截器执行顺序

我们可以通过在每个拦截器的 preHandle 方法中打印日志，来确认每个拦截器的执行顺序。如果拦截器的执行顺序不符合我们的预期，我们可以在 WebMvcConfigurer 的 configurePathMatch 方法中设置拦截器执行顺序，具体代码如下：

@Override
public void configurePathMatch(PathMatchConfigurer configurer) {
    // 设置拦截器执行顺序
    configurer.addPathPrefix("/api", HandlerTypeInterceptor.class);
    configurer.addPathPrefix("/api", HandlerPathInterceptor.class);
}

2. 解决问题

2.1 问题一：拦截器顺序不对

有时候我们希望多个拦截器按照我们指定的顺序依次执行，但实际的执行顺序却不符合我们的预期。这个时候，我们需要重新定义拦截器的执行顺序。

以我们的项目为例，我们希望所有的请求先执行 HandlerTypeInterceptor，然后执行 HandlerPathInterceptor。但是实际的执行顺序却是反过来的。我们可以使用上面提到的 configurePathMatch 方法来指定拦截器的执行顺序，具体代码如下：

@Override
public void configurePathMatch(PathMatchConfigurer configurer) {
    // 设置拦截器执行顺序
    configurer.addPathPrefix("/api", HandlerTypeInterceptor.class);
    configurer.addPathPrefix("/api", HandlerPathInterceptor.class);
}

这段代码的作用是指定所有以 /api 开头的请求先执行 HandlerTypeInterceptor，然后执行 HandlerPathInterceptor。

2.2 问题二：拦截器失效

有时候我们会发现某一个拦截器不被执行，这个时候我们需要分析拦截器的执行流程，找到问题的原因。

以我们的项目为例，我们有一个拦截器 A，在请求处理前需要检查用户是否登录，如果未登录需要跳转到登录页面。但是实际的情况是，即使用户未登录也不会被拦截器 A 所拦截。我们可以在拦截器 A 的 preHandle 方法中添加日志和断点，然后再次发送请求来观察拦截器 A 的执行流程，找到问题的原因。

经过排查，我们发现问题出在拦截器的拦截路径上。拦截器 A 要拦截的路径是 /api/**，但是实际的请求路径却没有以 /api 开头，导致拦截器 A 没有被执行。我们修改拦截器 A 的拦截路径，问题就得到了解决，具体代码如下：

@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
    // 拦截 /api/** 的请求
    if (request.getRequestURI().startsWith(request.getContextPath() + "/api/")) {
        // ... 拦截逻辑
    }
    return true;
}

以上就是关于 SpringMVC HandlerInterceptor 诡异问题的排查解决方法。希望能对大家有所帮助。