Spring Boot中使用拦截器

您所在的位置：网站首页 › springboot拦截器拦截所有请求 › Spring Boot中使用拦截器

Spring Boot中使用拦截器

2023-04-18 21:52| 来源: 网络整理| 查看: 265

Spring Boot中使用拦截器拦截器

Aop的一种实现，主要拦截对动态资源的后台请求。Controller层的请求拦截。

常用场景：

判断用户权限拦截webSocket请求。使用1、定义拦截器

定义拦截器只需要实现HandlerIntercepter

package org.springframework.web.servlet; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; import org.springframework.lang.Nullable; public interface HandlerInterceptor { default boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception { return true; } default void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, @Nullable ModelAndView modelAndView) throws Exception { } default void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, @Nullable Exception ex) throws Exception { } }

preHandle()：当某个 url 已经匹配到对应的 Controller 中的某个方法，且在这个方法执行之前去执行。返回 true 则放行，返回 false 则不会向后执行。

postHandle()：当某个 url 已经匹配到对应的 Controller 中的某个方法，且在执行完了该方法，但是在 DispatcherServlet视图渲染之前。所以在这个方法中有个 ModelAndView 参数，可以在此做一些修改动作。

afterCompletion()：在整个请求处理完成后（包括视图渲染）执行，这时做一些资源的清理工作，这个方法只有在 preHandle(……) 被成功执行后并且返回 true才会被执行。

1、自定义拦截器/** * 自定义拦截器 */ public class MyInterceptor implements HandlerInterceptor { private static final Logger logger = LoggerFactory.getLogger(MyInterceptor.class); @Override public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception { HandlerMethod handlerMethod = (HandlerMethod) handler; Method method = handlerMethod.getMethod(); String methodName = method.getName(); logger.info("====拦截到了方法：{}，在该方法执行之前执行====", methodName); // 返回true才会继续执行，返回false则取消当前请求 return true; } @Override public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception { logger.info("执行完方法之后进执行(Controller方法调用之后)，但是此时还没进行视图渲染"); } @Override public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception { logger.info("整个请求都处理完咯，DispatcherServlet也渲染了对应的视图咯，此时我可以做一些清理的工作了"); } }2、配置拦截器

Spring Boot 2.0之前：通过继承WebMvcConfigurerAdapter类，进而重写addInterceptors实现。

Spring Boot 2.0之后：通过继承WebMvcConfigurationSupport，重写addInterceptors实现。

@Configuration public class MyInterceptorConfig extends WebMvcConfigurationSupport { @Override protected void addInterceptors(InterceptorRegistry registry) { // 将上面自定义好的拦截器添加进去。 registry.addInterceptor(new MyInterceptor()).addPathPatterns("/**"); super.addInterceptors(registry); } }

之后通过访问接口即可，发现已经拦截到请求，在控制台日志中打印了上述日志信息。

3、问题解决1、解决静态资源被拦截的问题

按照上述的配置拦截器，静态资源会被拦截住。可以通过在resources/static/下放一个图片，项目启动后直接访问。发现无法访问。

解决办法：

因为，WebMvcConfigurationSupport会导致默认的姿态资源被拦截，需要我们手动配置。

/** * 用来指定静态资源不被拦截，否则继承WebMvcConfigurationSupport这种方式会导致静态资源无法直接访问 * @param registry */ @Override protected void addResourceHandlers(ResourceHandlerRegistry registry) { registry.addResourceHandler("/**").addResourceLocations("classpath:/static/"); super.addResourceHandlers(registry); }

另外！我们发现也可通过实现WebMvcConfigurer接口，重写addInterceptors方法，将自定义拦截器添加进去且静态资源不会被拦截。

@Configuration public class MyInterceptorConfig implements WebMvcConfigurer { @Override public void addInterceptors(InterceptorRegistry registry) { // 实现WebMvcConfigurer不会导致静态资源被拦截 registry.addInterceptor(new MyInterceptor()).addPathPatterns("/**"); } }

两种方式的区别：

继承 WebMvcConfigurationSupport类的方式可以用在前后端分离的项目中，后台不需要访问静态资源（就不需要放开静态资源了）；

实现WebMvcConfigure接口的方式可以用在非前后端分离的项目中，因为需要读取一些图片、css、js文件等等。

2、使用场景判断用户登录状态

java @Override public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception { HandlerMethod handlerMethod = (HandlerMethod) handler; Method method = handlerMethod.getMethod(); String methodName = method.getName(); logger.info("====拦截到了方法：{}，在该方法执行之前执行====", methodName); // 判断用户有没有登陆，一般登陆之后的用户都有一个对应的token String token = request.getParameter("token"); if (null == token || "".equals(token)) { logger.info("用户未登录，没有权限执行……请登录"); return false; } // 返回true才会继续执行，返回false则取消当前请求 return true; }

开放某些接口的通行权限，取消拦截区别哪些接口需要开放，可以选择在Controller接口方法上添加自定义注解区分。

java /** * 该注解用来指定某个方法不用拦截 */ @Target(ElementType.METHOD) @Retention(RetentionPolicy.RUNTIME) public @interface UnInterception { }

在前置处理器中添加过滤逻辑

java @Override public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception { HandlerMethod handlerMethod = (HandlerMethod) handler; Method method = handlerMethod.getMethod(); String methodName = method.getName(); logger.info("====拦截到了方法：{}，在该方法执行之前执行====", methodName); // 通过方法，可以获取该方法上的自定义注解，然后通过注解来判断该方法是否要被拦截 // @UnInterception 是我们自定义的注解 UnInterception unInterception = method.getAnnotation(UnInterception.class); if (null != unInterception) { return true; } // 返回true才会继续执行，返回false则取消当前请求 return true; }

【本文地址】

Spring Boot中使用拦截器

Spring Boot中使用拦截器

今日新闻

推荐新闻