SSM 中的拦截器（Interceptor）：作用与实现原理

news2024/11/28 0:36:17

SSM 中的拦截器（Interceptor）：作用与实现原理

拦截器（Interceptor）是 Spring 框架中的一个重要组件，也在 Spring + Spring MVC + MyBatis（SSM）等框架中起到了关键作用。本文将深入探讨拦截器在 SSM 中的角色和功能，以及如何实现一个自定义的拦截器。

在这里插入图片描述

什么是拦截器？

拦截器是一种应用程序设计模式，它用于截取、拦截或捕获某些事件或行为，然后在不干预原始请求的情况下执行预定义的操作。在 SSM 中，拦截器主要用于处理 HTTP 请求和响应的过程，在请求到达控制器之前和响应返回客户端之前执行特定的操作。

拦截器是 Spring 框架的一部分，它允许开发者在处理请求的不同阶段插入自己的逻辑，如权限验证、日志记录、性能监控等。拦截器通常在 Spring MVC 中使用得最广泛，但也可以在 Spring + MyBatis 或其他框架中使用。

拦截器的作用

拦截器在 SSM 中具有多种重要作用：

1. 权限验证

拦截器可以用于验证用户是否有权限访问某个特定的页面或执行某个操作。例如，一个在线商店的拦截器可以检查用户是否登录以及是否具有购买商品的权限。

public class AuthInterceptor implements HandlerInterceptor {

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
            throws Exception {
        // 检查用户是否登录，如果未登录，跳转到登录页面
        if (!isUserLoggedIn(request)) {
            response.sendRedirect("/login");
            return false;
        }
        // 检查用户是否有权限访问该页面或执行该操作
        if (!hasPermission(request)) {
            response.sendRedirect("/unauthorized");
            return false;
        }
        return true;
    }

    // 省略实现细节
}

2. 日志记录

拦截器可以用于记录请求和响应的详细信息，以便进行调试、性能分析或安全审计。通过拦截器，我们可以捕获请求的参数、执行时间、响应状态码等信息。

public class LoggingInterceptor implements HandlerInterceptor {

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler,
                           ModelAndView modelAndView) throws Exception {
        // 记录请求信息，包括请求路径、请求参数、执行时间等
        logRequestInfo(request);
        // 记录响应信息，包括响应状态码、响应内容等
        logResponseInfo(response);
    }

    // 省略实现细节
}

3. 性能监控

拦截器可以用于监控应用程序的性能，包括请求处理时间、资源消耗等。这有助于发现性能瓶颈并进行优化。

public class PerformanceInterceptor implements HandlerInterceptor {

    @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();
        long executionTime = endTime - startTime;
        // 记录请求处理时间
        logPerformance(request, executionTime);
    }

    // 省略实现细节
}

实现一个自定义拦截器

要实现一个自定义的拦截器，在 SSM 中，一般需要完成以下步骤：

创建一个类，实现 HandlerInterceptor 接口。
在拦截器中实现相应的逻辑，例如权限验证、日志记录或性能监控。
配置拦截器，告诉 Spring 在哪些请求路径下应用该拦截器。

以下是一个示例，展示如何创建一个简单的拦截器，用于记录请求的处理时间：

public class PerformanceInterceptor implements HandlerInterceptor {

    @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();
        long executionTime = endTime - startTime;
        // 记录请求处理时间
        logPerformance(request, executionTime);
    }

    private void logPerformance(HttpServletRequest request, long executionTime) {
        String requestURI = request.getRequestURI();
        String method = request.getMethod();
        System.out.println("Request URI: " + requestURI);
        System.out.println("HTTP Method: " + method);
        System.out.println("Execution Time: " + executionTime + "ms");
    }
}

配置拦截器在 Spring MVC 中的应用：

<!-- 配置拦截器 -->
<mvc:interceptors>
    <mvc:interceptor>
        <mvc:mapping path="/**" />
        <bean class="com.example.PerformanceInterceptor" />
    </mvc:interceptor>
</mvc:interceptors>