SpringBoot中自定义拦截器（Interceptor）实现详解：配置HandlerInterceptor接口及在preHandle、postHandle与afterCompletion中的应用实践

一、引言

在我们日常开发中，有时候会遇到一些需求，需要在业务逻辑执行之前或者之后做一些额外的操作。这时候我们可以使用拦截器（Interceptor）来进行处理。在 Spring MVC 这个大家伙里，拦截器可是个大忙人，它身影广泛地出现在各个角落。比如说吧，当我们要对用户权限进行验证时，或者要对系统性能进行实时监控时，都离不开这位“幕后英雄”——拦截器的鼎力相助。本文将详细介绍 SpringBoot 如何实现自定义的拦截器。

二、自定义拦截器的原理

首先我们需要了解一下什么是拦截器。在Spring MVC这个大家伙里，拦截器就像是个扮演关键角色的小家伙，它其实就是一个实实在在的类，不过这个类得乖乖实现HandlerInterceptor接口，这样才能上岗工作。当我们发送一个 HTTP 请求给 Spring MVC 处理时，拦截器会对这个请求进行拦截，并根据我们的业务逻辑决定是否继续执行下一个拦截器或者 Controller。

三、自定义拦截器的实现步骤

接下来我们将一步步介绍如何在 SpringBoot 中实现自定义的拦截器。

1. 创建自定义拦截器实现 HandlerInterceptor 接口

public class MyInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        // 这里可以根据需要进行预处理操作
        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 {
        // 这里可以在处理完成且没有异常发生的情况下进行后续操作
    }
}

2. 需要一个配置类实现 WebMvcConfigurer 接口，并添加@Configuration注解

@Configuration
public class WebConfig implements WebMvcConfigurer {
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new MyInterceptor());
    }
}

3. 在配置类中重写 addInterceptors 方法，将自定义拦截器添加到拦截器链中

@Override
public void addInterceptors(InterceptorRegistry registry) {
    registry.addInterceptor(new MyInterceptor())
            .addPathPatterns("/"); // 添加拦截器路径匹配规则
}

四、自定义拦截器的应用场景

下面我们来看几个常见的应用场景。

1. 权限验证

public class AuthInterceptor implements HandlerInterceptor {
    private List<String> allowedRoles = Arrays.asList("admin", "manager");
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        String username = (String) SecurityContextHolder.getContext().getAuthentication().getName();
        if (!allowedRoles.contains(username)) {
            response.sendError(HttpServletResponse.SC_FORBIDDEN);
            return false;
        }
        return true;
    }
}

在这个例子中，我们在 preHandle 方法中获取了当前用户的用户名，然后检查他是否有权访问这个资源。如果没有，则返回 403 Forbidden 错误。

2. 记录请求日志

public class LogInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        long start = System.currentTimeMillis();
        System.out.println("开始处理请求：" + request.getRequestURL() + "，参数：" + request.getParameterMap());
        return true;
    }
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        long end = System.currentTimeMillis();
        System.out.println("结束处理请求：" + request.getRequestURL() + "，耗时：" + (end - start));
    }
}

在这个例子中，我们在 preHandle 和 afterCompletion 方法中分别记录了请求开始时间和结束时间，并打印了相关的信息。

3. 判断用户是否登录

public class LoginInterceptor implements HandlerInterceptor {
    private User user;
    public LoginInterceptor(User user) {
        this.user = user;
    }
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        if (user != null) {
            return true;
        } else {
            response.sendRedirect("/login");
            return false;
        }
    }
}

在这个例子中，我们在 preHandle 方法中判断用户是否已经登录，如果没有，则跳转到登录页面。
总结
以上就是如何在 SpringBoot 中实现自定义的拦截器。拦截器是一个非常强大的功能，可以帮助我们解决很多复杂的问题。但是伙计们，你们得留意了，过度依赖拦截器这玩意儿，可能会让代码变得乱七八糟、一团乱麻，维护起来简直能让你头疼欲裂。所以呐，咱们一定要悠着点用，合理利用这个小工具才是正解。希望这篇文章对你有所帮助！