【Spring底层原理高级进阶】轻松掌握 Spring MVC 的拦截器机制：深入理解 HandlerInterceptor 接口和其实现类的用法

苏泽

发布于 2024-03-01 12:50:08

2780

发布于 2024-03-01 12:50:08

老样子先用一个生动的例子来讲解今天的主角拦截器的作用

一天，我们的主角坤坤打算开一家篮球店，他兴致勃勃地准备了一切，从篮球装备到装修风格，都精心设计。他决定给自己的篮球店起名叫"坤坤篮球店"，希望能够吸引更多的篮球爱好者。坤坤开业的第一天，篮球店迎来了很多顾客。他兴奋地迎接每个人，向他们介绍店里的产品和服务。然而，坤坤很快发现，有一些顾客可能并不是真正的篮球爱好者，而是想趁机捣乱或者做一些不合法的事情，也就是人们常说的“小黑子” 这时，他决定在篮球店的入口处设置三个聪明又可爱的坤家卫人称“三只鸡脚”，它是坤坤的得力助手。这个鸡脚像个守门员，聪明地分辨出哪些人是真爱粉，哪些人只是小黑子，并义正言辞的嘲讽那些虚假的粉丝并给予礼貌的问候“你最好是”。每当有人进入篮球店，坤家卫会迅速判断他们的目的。如果是真正的篮球爱好者，拦截器会热情地引导他们到合适的偶像练习生区域，给予他们服务。在他们进行愉快的热舞之前，需要将舞台和背景板渲染成他们喜欢的模样。而对于那些可疑的人，拦截器会立即拦截他们，阻止他们进一步的行动。最后在激情的热舞过后会有剩余的坤家卫打扫战场，作后续操作与资源清理

上面那个故事我们可以预见坤坤篮球店的兴起这离不开三位坤家卫的协作既然如此那么我们也走进SpringMVC的拦截器当中深入了解其原理与机制

介绍

拦截器在 Spring MVC 中扮演着重要的角色，用于拦截请求和响应的处理过程，并允许开发人员在请求进入控制器之前或离开控制器之后执行自定义的逻辑。它提供了一种在请求的不同生命周期阶段插入自定义代码的机制。

与过滤器相比，拦截器更加专注于处理控制器级别的逻辑，它们与控制器紧密耦合，并且可以访问和修改控制器方法的参数和返回值。拦截器通常用于实现一些通用的横切关注点，如身份验证、权限检查、日志记录、性能监测等。

在 Spring MVC 中，拦截器通过实现 HandlerInterceptor 接口来定义。HandlerInterceptor 接口包含了三个核心方法：

preHandle：在请求到达控制器之前被调用。可以用于进行一些前置处理，如身份验证、权限检查等。根据返回结果决定是否继续处理请求。
postHandle：在控制器方法执行完成后，视图渲染之前被调用。可以对模型数据进行进一步的处理或修改。
afterCompletion：在整个请求处理完成后被调用。用于进行一些资源清理操作或记录请求处理结果等。

这些方法在拦截器链中按照特定的顺序被调用。在多个拦截器存在的情况下，它们的执行顺序由拦截器的配置顺序决定。拦截器链的执行顺序是先进后出的，即先配置的拦截器最后执行。

通过编写自定义的 HandlerInterceptor 实现类，并将其配置到 Spring MVC 中，开发人员可以灵活地控制请求处理过程中的逻辑。拦截器提供了一种可插拔的机制，使得代码的复用性和可维护性得到提高，并且可以有效地实现横切关注点的功能。

具体实现：

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

public class CustomInterceptor implements HandlerInterceptor {

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        // 在请求到达控制器之前被调用
        // 可以进行一些前置处理，如身份验证、权限检查等
        // 返回false将阻止继续处理请求，返回true将允许继续处理请求
        String token = request.getHeader("Authorization");
        if (token == null || !isValidToken(token)) {
            response.setStatus(HttpServletResponse.SC_UNAUTHORIZED);
            return false;
        }
        return true;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        // 在控制器方法执行完成后，视图渲染之前被调用
        // 可以对模型数据进行进一步的处理或修改
        if (modelAndView != null) {
            modelAndView.addObject("customData", "Additional data");
        }
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        // 在整个请求处理完成后被调用
        // 可以进行一些资源清理操作或记录请求处理结果等
        logRequestCompletion(request, response.getStatus());
    }

    private boolean isValidToken(String token) {
        // 验证token的逻辑
        // 返回true表示token有效，返回false表示token无效
        // 这里只是一个示例，实际业务逻辑需要根据具体需求实现
        return true;
    }

    private void logRequestCompletion(HttpServletRequest request, int status) {
        // 记录请求处理结果的逻辑
        // 这里只是一个示例，实际业务逻辑需要根据具体需求实现
        System.out.println("Request completed - URI: " + request.getRequestURI() + ", Status: " + status);
    }
}

那么，我们也可以创建一个自己的拦截器来为业务服务：

创建一个Java类，实现HandlerInterceptor接口。例如，我们可以创建一个名为CustomInterceptor的类：

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

public class CustomInterceptor implements HandlerInterceptor {

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        // 实现preHandle方法，在请求到达控制器之前进行拦截和处理
        // 在这里可以实现需要的业务逻辑，例如身份验证、权限检查等
        // 返回true表示继续处理请求，返回false将阻止继续处理请求
        return true;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        // 实现postHandle方法，在控制器方法执行完成后进行拦截和处理
        // 在这里可以对模型数据进行进一步的处理或修改
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        // 实现afterCompletion方法，在整个请求处理完成后进行拦截和处理
        // 在这里可以进行一些资源清理操作或记录请求处理结果等
    }
}

在CustomInterceptor类中，您可以根据需要实现preHandle、postHandle和afterCompletion方法来编写具体的业务逻辑。

注册拦截器到Spring MVC配置中。在Spring MVC的配置文件（如XML配置文件或Java配置类）中，通过配置InterceptorRegistry来注册自定义拦截器。以下是一个示例，假设您正在使用Java配置类：

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 AppConfig implements WebMvcConfigurer {

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        // 注册自定义拦截器
        registry.addInterceptor(new CustomInterceptor()).addPathPatterns("/**");
    }
}

在上述示例中，我们通过addInterceptors方法向InterceptorRegistry注册了CustomInterceptor，并使用addPathPatterns方法指定了拦截的URL模式，这里使用"/**"表示拦截所有请求。

拦截器在实际项目中有多种应用场景，除了身份验证之外还有以下常见用途，以及我做过在业务中的具体实现：

日志记录：拦截器可以用于记录请求和响应的日志信息，包括请求的URL、参数、处理时间等。这对于跟踪和排查问题、性能优化以及统计分析非常有用。

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

public class LoggingInterceptor implements HandlerInterceptor {

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        // 记录请求的URL和参数
        String url = request.getRequestURL().toString();
        String queryString = request.getQueryString();
        System.out.println("Request URL: " + url);
        System.out.println("Request Parameters: " + queryString);
        return true;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        // 在这里可以对响应数据进行记录或处理
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        // 在这里可以记录请求处理时间等信息
    }
}

缓存管理：拦截器可以用于缓存管理，例如在请求到达控制器之前检查缓存中是否存在响应数据，如果存在则直接返回缓存数据，避免重复计算或查询数据库。

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

public class CacheInterceptor implements HandlerInterceptor {

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        // 检查缓存中是否存在响应数据
        String cacheKey = generateCacheKey(request);
        Object cachedData = getFromCache(cacheKey);
        if (cachedData != null) {
            // 直接返回缓存数据
            writeResponseData(response, cachedData);
            return false; // 终止请求继续处理
        }
        return true;
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        // 在这里可以将响应数据缓存起来
        String cacheKey = generateCacheKey(request);
        Object responseData = extractResponseData(response);
        storeInCache(cacheKey, responseData);
    }

    private String generateCacheKey(HttpServletRequest request) {
        // 根据请求的URL、参数等生成唯一的缓存键
        // ...
    }

    private Object getFromCache(String cacheKey) {
        // 从缓存中获取数据
        // ...
    }

    private void writeResponseData(HttpServletResponse response, Object data) {
        // 将数据写入响应
        // ...
    }

    private Object extractResponseData(HttpServletResponse response) {
        // 从响应中提取数据
        // ...
    }

    private void storeInCache(String cacheKey, Object data) {
        // 将数据存入缓存
        // ...
    }
}

权限控制：除了身份验证，拦截器可以用于实现细粒度的权限控制。在preHandle方法中，可以检查当前用户是否具有访问某个资源或执行某个操作的权限，如果没有权限，则可以返回相应的错误信息或重定向到其他页面。

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

public class AuthorizationInterceptor implements HandlerInterceptor {

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        // 检查用户权限
        if (!hasPermission(request)) {
            // 没有权限，返回错误信息或重定向到其他页面
            response.sendRedirect("/error/unauthorized");
            return false; // 终止请求继续处理
        }
        return true;
    }

    private boolean hasPermission(HttpServletRequest request) {
        // 检查当前用户是否具有访问资源的权限
        // ...
    }
}

请求参数解析和预处理：拦截器可以用于解析请求参数，并进行一些预处理操作，例如数据格式转换、参数校验等。这有助于减轻控制器方法的负担，使其更专注于业务逻辑的处理。

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

public class RequestProcessingInterceptor implements HandlerInterceptor {

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        // 参数解析和预处理
        String param1 = request.getParameter("param1");
        String param2 = request.getParameter("param2");
        // 对参数进行处理或校验
        // ...
        return true;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        // 在这里可以对模型数据进行进一步处理或修改
    }
}

错误处理：拦截器可以用于全局的错误处理，捕获和处理异常。在afterCompletion方法中，可以对异常进行统一的处理，例如记录日志、发送通知等。

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

public class ErrorHandlingInterceptor implements HandlerInterceptor {

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
       // 在这里对异常进行统一处理
        if (ex != null) {
            // 记录日志或发送通知
            System.out.println("Exception occurred: " + ex.getMessage());
        }
    }
}