如何在Spring中使用Java Interceptor

在Spring框架中，拦截器（Interceptor）是一种强大的机制，用于在方法调用前后执行特定的逻辑。通过使用拦截器，你可以在不修改原有代码的情况下，增加横切关注点（cross-cutting concerns），如日志记录、事务管理、安全性检查等。

以下是如何在Spring中使用Java拦截器的步骤：

1. 创建拦截器类

首先，你需要创建一个实现HandlerInterceptor接口的类。这个接口定义了三个方法：

• preHandle(HttpServletRequest request, HttpServletResponse response, Object handler): 在目标方法调用之前执行。
• postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView): 在目标方法调用之后，但在视图渲染之前执行。
• afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex): 在整个请求处理完成之后执行，包括视图渲染。

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 {

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("Before method execution");
        return true; // 返回true表示继续处理请求，返回false表示中断请求
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        System.out.println("After method execution but before view rendering");
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        System.out.println("After request completion");
    }
}

2. 配置拦截器

接下来，你需要在Spring配置中注册这个拦截器。你可以通过实现WebMvcConfigurer接口来完成这个任务。

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 MyInterceptor())
                .addPathPatterns("/api/**") // 拦截/api/**路径下的所有请求
                .excludePathPatterns("/api/login", "/api/register"); // 排除某些路径
    }
}

3. 使用拦截器

现在，当你访问匹配的路径时，拦截器将会被调用。例如，如果你访问/api/user，拦截器的preHandle方法将会在控制器方法调用之前执行，postHandle方法将会在控制器方法调用之后但在视图渲染之前执行，afterCompletion方法将会在整个请求处理完成之后执行。

注意事项

• 确保你的拦截器类实现了HandlerInterceptor接口。
• 在配置拦截器时，使用addPathPatterns指定要拦截的路径，使用excludePathPatterns排除不需要拦截的路径。
• 返回true表示继续处理请求，返回false表示中断请求。

通过以上步骤，你可以在Spring中使用Java拦截器来实现各种横切关注点。