拦截器在Spring框架中的应用

在Spring框架中，拦截器（Interceptor）是一种强大的机制，用于在处理请求之前或之后执行特定的逻辑。拦截器通常用于实现横切关注点（cross-cutting concerns），例如日志记录、性能监控、安全检查等。Spring提供了多种方式来实现拦截器，其中最常用的是基于HandlerInterceptor接口的实现。

以下是拦截器在Spring框架中的一些应用：

1. 基本概念

• HandlerInterceptor接口：这是Spring提供的拦截器接口，包含三个方法：
  • preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)：在请求处理之前调用。
  • postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView)：在请求处理之后，但在视图渲染之前调用。
  • afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex)：在请求处理完成之后调用，无论是否有异常发生。

2. 配置拦截器

拦截器可以通过Java配置或XML配置来注册。

Java配置

@Configuration
public class WebConfig implements WebMvcConfigurer {

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new MyInterceptor())
                .addPathPatterns("/api/**") // 拦截/api/**路径下的所有请求
                .excludePathPatterns("/api/login", "/api/register"); // 排除某些路径
    }
}

XML配置

<mvc:interceptors>
    <mvc:interceptor>
        <mvc:mapping path="/api/**"/>
        <mvc:exclude-mapping path="/api/login"/>
        <mvc:exclude-mapping path="/api/register"/>
        <bean class="com.example.MyInterceptor"/>
    </mvc:interceptor>
</mvc:interceptors>

3. 应用场景

3.1 日志记录

在请求处理之前和之后记录日志，便于跟踪请求的处理过程。

public class LoggingInterceptor implements HandlerInterceptor {
    private static final Logger logger = LoggerFactory.getLogger(LoggingInterceptor.class);

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        logger.info("Request URL: {}", request.getRequestURL());
        return true;
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        logger.info("Request completed: {}", request.getRequestURL());
    }
}

3.2 性能监控

在请求处理前后记录时间戳，计算请求的处理时间。

public class PerformanceInterceptor implements HandlerInterceptor {
    private static final Logger logger = LoggerFactory.getLogger(PerformanceInterceptor.class);

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

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        long startTime = (Long) request.getAttribute("startTime");
        long endTime = System.currentTimeMillis();
        logger.info("Request took {} ms: {}", endTime - startTime, request.getRequestURL());
    }
}

3.3 安全检查

在请求处理之前进行身份验证和授权检查。

public class SecurityInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        Authentication authentication = SecurityContextHolder.getContext().getAuthentication();
        if (authentication == null || !authentication.isAuthenticated()) {
            response.sendRedirect("/login");
            return false;
        }
        return true;
    }
}

4. 注意事项

• 顺序：拦截器的执行顺序可以通过addPathPatterns和excludePathPatterns方法的顺序来控制。
• 返回值：preHandle方法的返回值决定了请求是否继续处理。如果返回false，请求将被中断，不会进入控制器方法。
• 异常处理：在afterCompletion方法中可以处理请求过程中抛出的异常。

通过合理使用拦截器，可以有效地实现横切关注点，提高代码的可维护性和可扩展性。