Spring MVC拦截器Interceptor代码示例

淡淡的烟草味﹌ 2024-02-18 12:41 14阅读 0赞

在Spring MVC中，可以通过编写拦截器（Interceptor）来对请求进行预处理和后处理。以下是一个示例代码，展示如何在Spring MVC中创建和配置拦截器：

1.  创建拦截器类：

import javax.servlet.http.HttpServletRequest;
    import javax.servlet.http.HttpServletResponse;
    import org.springframework.web.servlet.HandlerInterceptor;
    import org.springframework.web.servlet.ModelAndView;
    
    public class MyInterceptor implements HandlerInterceptor {
        
    
        @Override
        public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        
            // 在请求处理之前进行预处理
            System.out.println("Pre-handle logic");
            return true; // 返回true表示继续执行请求，返回false表示中断请求
        }
    
        @Override
        public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        
            // 在请求处理之后进行后处理
            System.out.println("Post-handle logic");
        }
    
        @Override
        public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        
            // 在视图渲染完成之后进行清理工作
            System.out.println("After completion logic");
        }
    }

在上述示例中，我们创建了一个名为`MyInterceptor`的拦截器类，并实现了`HandlerInterceptor`接口。在`preHandle()`方法中，我们可以执行请求处理之前的逻辑。在`postHandle()`方法中，我们可以执行请求处理之后的逻辑。在`afterCompletion()`方法中，我们可以进行视图渲染完成后的清理工作。

1.  配置拦截器：

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 InterceptorConfig implements WebMvcConfigurer {
        
    
        @Override
        public void addInterceptors(InterceptorRegistry registry) {
        
            // 注册自定义的拦截器
            registry.addInterceptor(new MyInterceptor())
                    .addPathPatterns("/**"); // 可以指定拦截的路径
        }
    }

在上述示例中，我们创建了一个名为`InterceptorConfig`的配置类，并实现了`WebMvcConfigurer`接口。通过重写`addInterceptors()`方法，我们可以将自定义的拦截器注册到拦截器注册表中，并使用`addPathPatterns()`方法指定需要拦截的路径模式。

在这个示例中，我们将自定义的拦截器`MyInterceptor`注册到拦截器注册表中，并指定拦截所有的路径（`"/**"`）。

通过以上步骤，我们就创建并配置了一个简单的拦截器，并将其应用于Spring MVC应用程序中的所有请求。当请求经过拦截器时，将按照定义的顺序执行拦截器的逻辑。