SpringMVC拦截器

SpringMVC拦截器

一、拦截器与过滤器区别：

过滤器[Filter] 属于web服务器组件：
​           过滤器主要作用: 过滤Servlet请求
​           执行时机: 两处执行时机[Servlet前、Servlet后；

拦截器[Interceptor] 属于框架（SpringMVC所有）：

​            拦截器主要作用: 拦截Controller请求
​                执行时机: 三处执行时机
​               1.执行DisptcherServlet之后，Controller之前；				
​               2.执行Controller之后，Servlet之前；
​               3.执行DisptcherServlet之后;即渲染试图

1.1、拦截器与过滤器执行顺序：

二、自定义拦截器：

1、Spring MVC也可以使用拦截器对请求进行拦截处理，用户可以自定义拦截器来实现特定的功能

实现方式：

1):   **HandlerInterceptor** 接口，
2):   继承**HandlerInterceptorAdapter** 适配器类(过时了)

2、实现HandlerInterceptor 接口方法说明（必须实现）:

1: preHandle(): 
      这个方法在业务处理器处理请求之前被调用，可以在此方法中做些权限的校验。如果决定该拦截器对请求进行拦截处理后还要调用其他的拦截器，或者是业务处理器去进行处理，则返回 true; 如果决定不需要再调用其他的组件去处理请求，则返回 false。

2: postHandle(): 
      这个方法在业务处理器处理请求之后，染视图之前调用。在此方法中可以对 ModelAndView中的模型和视图进行处理。

3: afterCompletion(): 
	  这个方法在 DispatcherServlet 完全处理完请求后被调用可以在该方法中进行一些资源清理的操作。     

​

3、SpringMVC配置文件中配置拦截器 ：

（1）配置全局拦截器：

（1）第一种：
<!--配置全局拦截器-->
<mvc:interceptors>
     <!--声明定义的拦截器通过这种方式定义的拦截器会拦截所有请求
     <bean id="firstInterceptor  class="拦截器接口实现类权限定名">
    </bean>
</mvc:interceptors> 
    

（2）第二种：
<!--配置全局拦截器-->
<mvc:interceptors>
        <!--声明定义的拦截器通过这种方式定义的拦截器会拦截所有请求
   < ref bean ="拦截器接口实现类名小写">  <!--注意需要在实现类上面加上@Component 注解-->
</mvc:interceptors> 

​

（2) 配置局部拦截器：

<mvc:interceptors>
    <mvc:interceptor>
           <!--声明定义的拦截器通过这种方式定义的拦截器会拦截指定请求
          < ref bean ="拦截器接口实现类名小写">  <!--注意需要在实现类上面加上@Component 注解-->  
     <mvc:interceptor>
</mvc:interceptors> 

三、拦截器工作原理

1、单个拦截器工作原理：

 浏览器向服务器发送请求
​ 执行拦截器第一个方法preHandle()
​ 执行Controller中方法，处理请求做出响应
​ 执行拦截器第二个方法postHandle()
​ 执行DispatcherServlet中渲染视图
​ 执行拦截器第三个方法afterCompletion()
​ 响应

2、多个拦截器工作原理：

 浏览器向服务器发送请求
​ 执行拦截器1第一个方法preHandle()
​ 执行拦截器2第一个方法preHandle()
​ 执行Controller中方法，处理请求做出响应
​ 执行拦截器2第二个方法postHandle()
​ 执行拦截器1第二个方法postHandle()
​ 执行DispatcherServlet中渲染视图
​ 执行拦截器2第三个方法afterCompletion()
​ 执行拦截器1第三个方法afterCompletion()
​ 响应

3、总结：

 当返回值返回false时，直接停在第一个preHander方法，不会再往下执行另外两个方法和controller接口。
​ 拦截器的顺序是由SpringMVC配置文件的配置顺序决定的。

1、根据当前请求，找到HandlerExecutionChain【可以处理请求的handler以及handler的所有 拦截器】
2、先来顺序执行 所有拦截器的 preHandle方法
● 1、如果当前拦截器prehandler返回为true。则执行下一个拦截器的preHandle
● 2、如果当前拦截器返回为false。直接    倒序执行所有已经执行了的拦截器的  afterCompletion；
3、如果任何一个拦截器返回false。直接跳出不执行目标方法
4、所有拦截器都返回True。执行目标方法
5、倒序执行所有拦截器的postHandle方法。
6、前面的步骤有任何异常都会直接倒序触发 afterCompletion
7、页面成功渲染完成以后，也会倒序触发 afterCompletion

三、拦截器实例：

步骤：

/**
 * 1、编写一个拦截器实现HandlerInterceptor接口
 * 2、拦截器注册到容器中（实现WebMvcConfigurer的addInterceptors）
 * 3、指定拦截规则【如果是拦截所有，静态资源也会被拦截】
 */

第一步：编写一个拦截器实现HandlerInterceptor接口

/**
 * 登录检查
 * 1、配置好拦截器要拦截哪些请求
 * 2、把这些配置放在容器中
 */
@Slf4j
public class LoginInterceptor implements HandlerInterceptor {

    /**
     * 目标方法执行之前
     * @param request
     * @param response
     * @param handler
     * @return
     * @throws Exception
     */
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {

        String requestURI = request.getRequestURI();
        log.info("preHandle拦截的请求路径是{}",requestURI);

        //登录检查逻辑
        HttpSession session = request.getSession();

        Object loginUser = session.getAttribute("loginUser");

        if(loginUser != null){
            //放行
            return true;
        }

        //拦截住。未登录。跳转到登录页
        request.setAttribute("msg","请先登录");
//        re.sendRedirect("/");
        request.getRequestDispatcher("/").forward(request,response);
        return false;
    }

    /**
     * 目标方法执行完成以后
     * @param request
     * @param response
     * @param handler
     * @param modelAndView
     * @throws Exception
     */
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        log.info("postHandle执行{}",modelAndView);
    }

    /**
     * 页面渲染以后
     * @param request
     * @param response
     * @param handler
     * @param ex
     * @throws Exception
     */
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        log.info("afterCompletion执行异常{}",ex);
    }
}

第二步：拦截器注册到容器中；指定拦截规则

第一种：

/**
 * 1、拦截器注册到容器中（实现WebMvcConfigurer的addInterceptors）
 * 2、指定拦截规则【如果是拦截所有，静态资源也会被拦截】
 */
@Configuration
public class AdminWebConfig implements WebMvcConfigurer {

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new LoginInterceptor())//将定义的拦截器注册到容器中
                .addPathPatterns("/**")  //所有请求都被拦截包括静态资源
                .excludePathPatterns("/","/login","/css/**","/fonts/**","/images/**","/js/**"); //放行的请求
    }
}

第二种：

@Configuration
public class AdminWebConfig implements WebMvcConfigurer {
  
  @Bean
  public LoginInterceptor loginInterceptor(){
    return new loginInterceptor();
  }
    
   @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(loginInterceptor())//所有请求都被拦截包括静态资源
                .addPathPatterns("/**")  //所有请求都被拦截包括静态资源
                .excludePathPatterns("/","/login","/css/**","/fonts/**","/images/**","/js/**"); //放行的请求
    }
}