Java自定义请求拦截器实现教程

在Java Web开发中，**自定义请求拦截器**是提升代码可维护性和系统可扩展性的关键技术。通过Spring的`HandlerInterceptor`接口或更底层的`javax.servlet.Filter`，开发者可以在请求处理前后执行身份校验、日志记录、参数修改等操作，将安全、日志等横切关注点与核心业务逻辑分离。本文详细介绍了如何使用Spring的`HandlerInterceptor`实现请求拦截，包括`preHandle`、`postHandle`、`afterCompletion`三个方法的应用，以及如何在配置类中注册拦截器并设置拦截路径。同时，也简要介绍了`javax.servlet.Filter`在字符编码、会话管理等方面的应用。合理利用自定义请求拦截器，能够构建结构清晰、职责分明的Web应用，避免代码重复，提高开发效率。

自定义请求拦截器在Java Web开发中至关重要。它允许开发者在请求真正被处理前执行诸如身份校验、日志记录或参数修改等操作，将横切关注点（如安全、日志）与核心业务逻辑分离，提升代码的可维护性与系统的可扩展性。1. 通过Spring的HandlerInterceptor接口，可以在preHandle方法中实现请求前处理；2. 在postHandle中进行视图渲染前的数据操作；3. 在afterCompletion中完成资源清理；4. 必须在配置类中注册拦截器并设置拦截路径；5. 若需更底层控制，也可使用javax.servlet.Filter，但其粒度较粗，适用于字符编码、会话管理等场景。总之，合理使用拦截器有助于构建结构清晰、职责分明的Web应用。

在Java里，想在请求真正被处理前做点什么，比如校验用户身份、记录日志，或者干脆改改请求参数，自定义请求拦截器就是那个你一直在找的利器。它能让你把那些横切关注点（cross-cutting concerns）集中管理，而不是让代码里到处都是重复的判断逻辑，让整个系统既干净又高效。

要说在Java里实现请求前置过滤，方法还真不少，但最常用、也最符合现代Web开发习惯的，莫过于Spring框架提供的HandlerInterceptor。当然，如果你在更底层的Servlet容器层面，javax.servlet.Filter也是个经典选项。

我们先聊聊HandlerInterceptor，因为它在Spring MVC应用里几乎是标配。你只需要实现这个接口，然后重写它的几个方法：

1. preHandle(HttpServletRequest request, HttpServletResponse response, Object handler): 这是最常用的，在请求进入Controller方法之前执行。如果返回true，请求会继续向下传递；如果返回false，请求就会被中断，后续的拦截器和Controller都不会执行。
2. postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView): 在Controller方法执行后，但在视图渲染之前执行。你可以在这里对ModelAndView进行操作，比如添加一些公共数据。
3. afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex): 在整个请求处理完成，也就是视图渲染完毕后执行。通常用于资源清理，比如关闭数据库连接或者释放线程资源，哪怕Controller抛了异常，这个方法也照样会执行。

实现起来大概是这样：

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

public class MyAuthInterceptor implements HandlerInterceptor {

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        // 假设这里做个简单的身份验证
        String token = request.getHeader("X-Auth-Token");
        if (token == null || !token.equals("valid-token-123")) {
            response.setStatus(HttpServletResponse.SC_UNAUTHORIZED); // 401 Unauthorized
            response.getWriter().write("{\"error\": \"Unauthorized\"}");
            response.getWriter().flush();
            return false; // 中断请求
        }
        System.out.println("请求通过认证: " + request.getRequestURI());
        // 可以在这里把用户信息存到request attribute里，方便后续Controller使用
        request.setAttribute("currentUser", "admin");
        return true; // 继续处理请求
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        // 可以在这里记录请求处理时间，或者给视图添加一些公共数据
        if (modelAndView != null) {
            modelAndView.addObject("appName", "MyAwesomeApp");
        }
        System.out.println("Controller执行完毕，准备渲染视图: " + request.getRequestURI());
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        // 请求处理完成，无论成功失败都会执行
        if (ex != null) {
            System.err.println("请求处理异常: " + request.getRequestURI() + ", 异常信息: " + ex.getMessage());
        } else {
            System.out.println("请求处理流程全部结束: " + request.getRequestURI());
        }
        // 资源清理等
    }
}

光有拦截器实现还不够，你还得告诉Spring去哪里注册它，以及它应该拦截哪些路径。通常是在Spring的配置类里：

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 MyAuthInterceptor())
                .addPathPatterns("/api/**") // 拦截 /api/ 下的所有请求
                .excludePathPatterns("/api/public/**"); // 但排除 /api/public/ 下的请求
        // 你可以注册多个拦截器，它们会按照添加的顺序依次执行preHandle
        // registry.addInterceptor(new AnotherInterceptor()).addPathPatterns("/admin/**");
    }
}

至于javax.servlet.Filter，它更像是Web容器层面的东西，比Spring Interceptor更早介入请求生命周期。你实现Filter接口，重写doFilter方法，然后通过@WebFilter注解或web.xml配置。它能做的事情和拦截器有些重叠，但粒度更粗，通常用于字符编码、GZIP压缩、会话管理等。Spring Interceptor则更专注于Spring MVC的请求处理流程。选择哪个，看你的具体需求和所处的技术栈吧。

为什么我们真的需要自定义请求拦截器？

你可能会想，不就是些前置处理嘛，直接在Controller方法里写不就行了？或者用AOP也能搞定啊。话是没错，但自定义请求拦截器自有它不可替代的价值，尤其是在构建复杂系统的时候。

它能帮你把那些“横切关注点”剥离出来。什么叫横切关注点？就是那些散落在系统各个角落，但又和核心

好了，本文到此结束，带大家了解了《Java自定义请求拦截器实现教程》，希望本文对你有所帮助！关注golang学习网公众号，给大家分享更多文章知识！