springboot 拦截器 详解

springboot 拦截器 详解

在 Spring Boot 中，拦截器（Interceptor）是一种强大的工具，用于在请求处理的前后执行特定的逻辑。它可以对请求进行预处理和后处理，常用于身份验证、日志记录、性能监控等场景。下面将从拦截器的概念、实现步骤、执行流程以及使用场景等方面进行详细介绍。

拦截器的概念

拦截器是 Spring MVC 框架中的一个组件，它可以在请求到达控制器之前或之后执行特定的操作。与过滤器（Filter）不同，拦截器是 Spring 框架的一部分，它可以访问 Spring 容器中的 Bean，因此在处理与 Spring 相关的业务逻辑时更加方便。

实现步骤

1. 创建拦截器类

要创建一个拦截器，需要实现 HandlerInterceptor 接口，该接口定义了三个方法：

• preHandle：在请求处理之前进行调用（Controller 方法调用之前），若返回 false，则请求将被终止，后续的拦截器和控制器方法都不会执行。
• postHandle：在请求处理之后，视图渲染之前调用（Controller 方法调用之后）。
• afterCompletion：在整个请求处理完成后调用，即视图渲染完成之后，通常用于资源清理等操作。

以下是一个简单的拦截器示例：

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;

public class MyInterceptor implements HandlerInterceptor {

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("Pre-handle method is called");
        // 返回 true 表示继续执行后续的拦截器和控制器方法
        return true;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        System.out.println("Post-handle method is called");
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        System.out.println("After-completion method is called");
    }
}

2. 配置拦截器

创建好拦截器后，需要将其注册到 Spring Boot 应用中。可以通过实现 WebMvcConfigurer 接口并重写 addInterceptors 方法来完成配置。

import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

@Configuration
public class WebConfig implements WebMvcConfigurer {

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new MyInterceptor())
                .addPathPatterns("/**") // 拦截所有请求
                .excludePathPatterns("/login"); // 排除 /login 请求
    }
}

在上述代码中，addPathPatterns 方法用于指定需要拦截的请求路径，excludePathPatterns 方法用于排除不需要拦截的请求路径。

拦截器的执行流程

1. 客户端发送请求：客户端向服务器发送 HTTP 请求。
2. 执行 preHandle 方法：请求到达服务器后，会依次执行所有拦截器的 preHandle 方法。如果某个拦截器的 preHandle 方法返回 false，则请求将被终止，后续的拦截器和控制器方法都不会执行。
3. 执行控制器方法：如果所有拦截器的 preHandle 方法都返回 true，则请求会到达控制器，执行相应的控制器方法。
4. 执行 postHandle 方法：控制器方法执行完成后，会依次执行所有拦截器的 postHandle 方法。
5. 视图渲染：postHandle 方法执行完成后，会进行视图渲染。
6. 执行 afterCompletion 方法：视图渲染完成后，会依次执行所有拦截器的 afterCompletion 方法。

使用场景

1. 身份验证

在 preHandle 方法中检查用户是否已经登录，如果未登录，则重定向到登录页面。

@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
    HttpSession session = request.getSession();
    if (session.getAttribute("user") == null) {
        response.sendRedirect("/login");
        return false;
    }
    return true;
}

2. 日志记录

在 preHandle 方法中记录请求的相关信息，如请求的 URL、请求参数等；在 afterCompletion 方法中记录请求的处理结果和执行时间。

@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
    System.out.println("Request URL: " + request.getRequestURL());
    System.out.println("Request Parameters: " + request.getParameterMap());
    return true;
}

@Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
    System.out.println("Request completed with status: " + response.getStatus());
}

3. 性能监控

在 preHandle 方法中记录请求开始时间，在 afterCompletion 方法中计算请求的执行时间。

private ThreadLocal<Long> startTime = new ThreadLocal<>();

@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
    startTime.set(System.currentTimeMillis());
    return true;
}

@Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
    long endTime = System.currentTimeMillis();
    long executionTime = endTime - startTime.get();
    System.out.println("Request execution time: " + executionTime + "ms");
    startTime.remove();
}

总结

Spring Boot 拦截器是一种非常有用的工具，它可以在请求处理的不同阶段执行特定的逻辑，为开发人员提供了很大的灵活性。通过实现 HandlerInterceptor 接口和配置 WebMvcConfigurer，可以轻松地创建和使用拦截器。常见的使用场景包括身份验证、日志记录和性能监控等。