当前位置：首页 > news >正文

拦截器（Interceptor）的使用

news 2025/8/6 12:39:41

在Java Web开发中，拦截器（Interceptor）是一种动态拦截请求和响应的对象，它可以在请求被控制器处理之前和之后执行一些预处理和后处理逻辑。要定义一个拦截器并使其生效，通常需要以下几个步骤：

1. 定义拦截器类

首先，你需要创建一个实现了 HandlerInterceptor 接口的类。这个接口定义了三个方法：preHandle、postHandle 和 afterCompletion，分别用于在请求处理之前、请求处理之后但在视图渲染之前、以及整个请求处理完成之后执行逻辑。

import org.springframework.stereotype.Component;
import org.springframework.web.servlet.HandlerInterceptor;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;@Component
public class MyInterceptor implements HandlerInterceptor {@Overridepublic boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {// 在请求处理之前执行的逻辑System.out.println("Pre Handle");return true; // 返回true表示继续流程（即调用下一个拦截器或处理器）；返回false表示流程中断，直接通过response输出，不再继续调用其他的拦截器或处理器}@Overridepublic void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {// 在请求处理之后但在视图渲染之前执行的逻辑System.out.println("Post Handle");}@Overridepublic void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {// 在整个请求处理完成之后执行的逻辑System.out.println("After Completion");}
}

2. 注册拦截器

接下来，你需要在Spring配置中注册这个拦截器。这可以通过Java配置或XML配置来完成。

XML配置方式

如果你使用的是XML配置，你可以在Spring MVC的配置文件中添加mvc:interceptors元素来注册拦截器：

<mvc:interceptors><mvc:interceptor><mvc:mapping path="/api/**"/><mvc:exclude-mapping path="/api/login"/><bean id="myInterceptor" class="com.example.MyInterceptor"/></mvc:interceptor>
</mvc:interceptors>

Java配置方式

如果你使用的是Java配置（基于@Configuration的配置），你可以通过实现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 WebConfig implements WebMvcConfigurer {@Autowiredprivate MyInterceptor myInterceptor;@Overridepublic void addInterceptors(InterceptorRegistry registry) {registry.addInterceptor(myInterceptor).addPathPatterns("/**") // 拦截所有路径.excludePathPatterns("/login"); // 排除/login路径}
}

3. 拦截器配置

确保你的Spring配置（无论是Java配置还是XML配置）已经被正确加载。如果你使用的是Spring Boot，通常Spring Boot会自动加载@Configuration类中的配置。如果你使用的是传统的Spring MVC项目，你需要确保配置文件被正确地包含在项目的构建路径中。

4. 拦截器执行流程

拦截器的执行流程是由Spring框架控制的，不需要编写额外的代码。当请求到达时，框架会自动按照注册的拦截器顺序执行。

5. 拦截器的作用

以下是一个拦截器中实现权限校验的示例：

@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {// 检查用户是否已经登录if (request.getSession().getAttribute("user") == null) {// 如果用户未登录，则重定向到登录页面response.sendRedirect("/login");return false;}return true;
}