Java基础（33）Java Web拦截器作用和用法

Java Web拦截器（Interceptor）是Java Web开发中一个重要的概念，它允许开发者在处理HTTP请求和响应之前或之后执行特定的代码，从而实现如权限检查、日志记录、事务管理等功能。拦截器可以作用于Java EE的Servlet、Spring框架、Struts2框架等。

下面以Spring框架为例，深入详细介绍拦截器的作用和用法，结合源码解析，并提供代码演示。

1. 拦截器的作用

在Spring框架中，拦截器主要有以下作用：

• 预处理：在控制器（Controller）方法执行之前进行预处理，可以进行权限校验、日志记录等。
• 后处理：在控制器方法执行之后、视图（View）返回之前进行处理，可以添加模型数据、处理异常等。
• 完成处理：在整个请求处理完成后执行，即视图渲染结束后，可以用于资源清理等操作。

2. Spring拦截器的定义

要定义一个Spring拦截器，需要实现HandlerInterceptor接口或继承HandlerInterceptorAdapter类。HandlerInterceptor接口定义了三个方法：

• preHandle()：预处理回调方法，返回值为true时，请求继续传递；返回false时，请求处理流程中断。
• postHandle()：后处理回调方法，可以进行异常检查并处理。
• afterCompletion()：请求处理完成后回调方法，可以做资源清理工作。

3. 代码演示

import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

public class MyInterceptor implements HandlerInterceptor {

    // 在Controller方法前进行预处理
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("Pre Handle method is Calling");
        // 返回true继续流程，返回false中断流程
        return true;
    }

    // 在Controller方法后，视图渲染前进行后处理
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        System.out.println("Post Handle method is Calling");
    }

    // 请求完成后的回调方法，可用于资源清理
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        System.out.println("Request and Response is completed");
    }
}

4. 拦截器的配置

在Spring MVC配置中，需要将自定义的拦截器注册到拦截器链中。这可以通过实现WebMvcConfigurer接口并重写addInterceptors方法来完成。

import org.springframework.beans.factory.annotation.Autowired;
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 WebMvcConfig implements WebMvcConfigurer {

    @Autowired
    private MyInterceptor myInterceptor;

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(myInterceptor);
    }
}

5. 细节详尽

• 拦截器与过滤器的区别：过滤器（Filter）是Servlet规范中的一部分，可以对几乎所有的请求进行过滤，而拦截器是Spring MVC框架的一部分，只能拦截通过DispatcherServlet的请求。
• 多个拦截器执行顺序：当有多个拦截器时，它们的执行顺序遵循先进后出（FILO）原则，即最先注册的拦截器preHandle方法最先执行，但其afterCompletion方法最后执行。

通过以上详细解析和代码演示，应该能对Java Web中的拦截器有一个深入的理解了。通过合理利用拦截器，可以使得Web应用的开发更加灵活和高效。