Springboot的拦截器HandlerInterceptor功能
1、在Web请求处理的过程中,拦截器是服务器端进行数据处理的最后一道屏障,可以将所有用户请求的信息在拦截器中进行验证。在SpringBoot中可以继续使用SpringMVC所提供的拦截器进行处理。
1 package com.demo.config; 2 3 import java.lang.reflect.Method; 4 5 import javax.servlet.http.HttpServletRequest; 6 import javax.servlet.http.HttpServletResponse; 7 8 import org.springframework.web.method.HandlerMethod; 9 import org.springframework.web.servlet.HandlerInterceptor; 10 import org.springframework.web.servlet.ModelAndView; 11 12 /** 13 * 14 * @author 实现拦截器接口 15 * 16 */ 17 public class MyInterceptor implements HandlerInterceptor { 18 19 long start = System.currentTimeMillis(); 20 21 @Override 22 public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) 23 throws Exception { 24 // 拦截器处理代码 25 26 } 27 28 @Override 29 public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, 30 ModelAndView modelAndView) throws Exception { 31 HandlerMethod handlerMethod = (HandlerMethod) handler; 32 // 拦截器处理代码 33 System.out.println("Interceptor cost=" + (System.currentTimeMillis() - start)); 34 } 35 36 /** 37 * 在拦截器中最需要用户处理的方法是preHandle(),此方法会在控制层的方法执行之前进行调用。 38 */ 39 @Override 40 public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) 41 throws Exception { 42 start = System.currentTimeMillis(); 43 HandlerMethod handlerMethod = (HandlerMethod) handler; 44 // 拦截器处理的代码 45 Object bean = handlerMethod.getBean(); 46 System.out.println(bean.toString()); 47 48 Method method = handlerMethod.getMethod(); 49 System.out.println(method.toString()); 50 51 // 如果返回false,表示不继续请求。如果返回true,表示继续请求 52 return true; 53 } 54 55 }
2、如果要拦截器生效,则还需要定义一个拦截器的配置类。此时代码,将拦截器配置到了Web项目中,配置的访问路径为全部请求路径,这样不管用户如何访问都会先执行拦截器中的处理方法。
1 package com.demo.config; 2 3 import org.springframework.context.annotation.Configuration; 4 import org.springframework.web.servlet.config.annotation.InterceptorRegistry; 5 import org.springframework.web.servlet.config.annotation.WebMvcConfigurer; 6 7 /** 8 * Spring 5.0后,WebMvcConfigurerAdapter被废弃,取代的方法有两种: 9 * 第一种是,implements WebMvcConfigurer(官方推荐)。 10 * 11 * 第二种是,extends WebMvcConfigurationSupport。 12 * 13 * 注意:使用第一种方法是实现了一个接口,可以任意实现里面的方法,不会影响到Spring Boot自身的@EnableAutoConfiguration, 14 * 而使用第二种方法相当于覆盖了@EnableAutoConfiguration里的所有方法,每个方法都需要重写, 15 * 比如,若不实现方法addResourceHandlers(),则会导致静态资源无法访问。 16 * 17 * @author 18 * 19 */ 20 @Configuration 21 public class MyWebApplicationConfig implements WebMvcConfigurer { 22 23 /** 24 * alt + /可以提出要实现的方法。 25 * 进行拦截器的注册处理操作。 26 */ 27 @Override 28 public void addInterceptors(InterceptorRegistry registry) { 29 // 匹配路径 30 registry.addInterceptor(new MyInterceptor()).addPathPatterns("/**"); 31 WebMvcConfigurer.super.addInterceptors(registry); 32 } 33 34 }
演示效果,如下所示: