欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页

Spring Boot 拦截器

程序员文章站 2022-03-18 16:14:10
...

拦截器

 Spring框架中一个很重要的思想:AOP–面向切面编程。
 利用这一点可以在Web生命周期里横切一刀,在对请求进行处理之前统一加上一个方法(这个方法就叫做切面),处理相应的事情(例如解决登录问题)。
切面也分种类,可以通过请求的URL来进行过滤,也可以指定Controller的名字来进行过滤。
通常情况下是对URL进行过滤,这就要用到SpringBoot的拦截器(Interceptor)机制。

使用拦截器

 定义拦截器,只需要定义一个@Component注解的类,实现HandlerInterceptor接口:

package com.chase.qing.other;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
import org.springframework.web.servlet.HandlerInterceptor;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

/**
 * @author Chase
 * @date 2018年08月28日
 */
@Component
public class MyInterceptor implements HandlerInterceptor {

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        return true;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
    }
}

配置拦截器

 使用拦截器要先配置拦截器的拦截规则:
 新建一个继承了WebMvcConfigurerAdapter的配置类。WebMvcConfigurerAdapter管理了很多的配置信息,就包括了拦截器的配置。这里说一下表示配置类的两个注解:

  • @Component 支持通过依赖注入要注册的拦截器。
  • @Configuration 不支持过依赖注入要注册的拦截器,需要单独new一个对象。
     通过依赖注入导入要注册的拦截器(或者直接new一个),然后通过重写addInterceptors方法来进行配置。如果需要对拦截器进行过滤,我们只需要对addInterceptors返回的InterceptorRegistration对象进行处理。
     这个InterceptorRegistration对象通常有两个方法addPathPatterns和excludePathPatterns,并且支持链式调用。

  • addPathPatterns 用于添加拦截规则

  • excludePathPatterns 用于排除拦截
/**
 * @author Chase
 * @date 2018年08月28日
 */
@Component
public class MyWebConfiguration extends WebMvcConfigurerAdapter {
    @Autowired
    MyInterceptor myInterceptor;

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(myInterceptor).addPathPatterns("/**");
        super.addInterceptors(registry);
    }
}
package com.chase.qing.other;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.http.converter.HttpMessageConverter;
import org.springframework.web.method.support.HandlerMethodArgumentResolver;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;

/**
 * @author Chase
 * @date 2018年08月28日
 */
@Configuration
public class WebMvcConfigurer extends WebMvcConfigurerAdapter {

    public void addInterceptors(InterceptorRegistry registry) {
        //addPathPatterns 用于添加拦截规则
        //excludePathPatterns 用于排除拦截
        registry.addInterceptor(new MyInterceptor()).addPathPatterns("/**"); 
        super.addInterceptors(registry);
    }
}

拦截器方法解析

preHandle

 preHandle是在请求已经被RequestMapping分配到了不同的Controller里,但是还没有执行handler方法的时候执行。

  • 此时可以进行登陆验证,验证用户的Cookie:
  • 验证成功,则记录下当前User的信息,并且将这个信息保存到一个ThreadLocal的UserComponent里,方便以后的调用,并且将请求放行(返回true)。
  • 验证失败,则可以将请求通过response的sendRedirect函数重定向到登陆页面。
  • 在目标方法之前调用,如果返回false,则后续拦截器和目标方法都不能别调用。可以做权限,日志,事务等。

postHandle

 postHandle是在请求已经被Controller处理,但是还并未进行视图渲染。因此postHandle的参数比preHandle多了一个ModelAndView这个参数。这个参数其实就包括了Controller处理后需要传递给视图的那个Model参数。可以对请求域进行修改,或者修改视图

afterCompletion

 afterCompletion在视图被渲染之后即将返回给用户的时候。此时是清除一些局部变量等资源清理操作,比如清除掉在前面保存的ThreadLocal的本地信息。


本文索引


喜欢的话可以点点关注,或者添加作者微信,欢迎随时来撩

Spring Boot 拦截器