SpringMVC HandlerInterceptor(拦截器)

SpringMVC HandlerInterceptor(拦截器)

1. 拦截器接口

public interface HandlerInterceptor {

	/**
	 * 控制器方法执行之前执行，返回值返回true为放行，即调用控制器方法；返回false表示拦截，即不调用控制器方法
	 */
	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 {
	}

2. 拦截器的配置

<!-- 配置拦截器：-->
<mvc:interceptors>
	<!-- 会拦截所有Controller类里的所有处理方法 -->
	<bean class="cn.com.xxx.web.FirstInterceptor"></bean>
	<bean class="cn.com.xxx.web.SecondInterceptor"></bean>
  
  <!-- 
  1.可以通过ref或bean标签设置拦截器
  2.通过mvc:mapping设置需要拦截的请求
  3.通过mvc:exclude-mapping设置需要排除的请求，即不需要拦截的请求 
  -->
  <mvc:interceptor>
    <mvc:mapping path="/**"/> <!--  /** (任意层路径) ，/*(单层路径) -->
    <mvc:exclude-mapping path="/testRequestEntity"/>
    <ref bean="firstInterceptor"></ref>
  </mvc:interceptor>

</mvc:interceptors>

3. 实现方式

// 1. 实现HandlerInterceptor接口(或者AsyncHandlerInterceptor)
public class FirstInterceptor implements HandlerInterceptor {
  ....
}

// 1. 继承HandlerInterceptorAdapter(该类已废弃)
public class SecondInterceptor extends HandlerInterceptorAdapter {
  ....
}

4. 拦截器个接口的执行时机

// org.springframework.web.servlet.DispatcherServlet#doDispatch
protected void doDispatch(HttpServletRequest request, HttpServletResponse response) throws Exception {
	// ...

  	// 执行拦截器的preHandle()方法，当返回false时，后续方法不再执行(内部会触发部分拦截器的afterCompletion())
  	if (!mappedHandler.applyPreHandle(processedRequest, response)) {
    	return;
  	}

  	// Actually invoke the handler.
  	mv = ha.handle(processedRequest, response, mappedHandler.getHandler());

	// ...
	
	// 执行拦截器的postHandle()
	mappedHandler.applyPostHandle(processedRequest, response, mv);
	
	// ...
	  
	// 内部会执行拦截器的afterCompletion()方法
	processDispatchResult(processedRequest, response, mappedHandler, mv, dispatchException);
	
	// ...
}

// org.springframework.web.servlet.DispatcherServlet#processDispatchResult
private void processDispatchResult(HttpServletRequest request, HttpServletResponse response,
			@Nullable HandlerExecutionChain mappedHandler, @Nullable ModelAndView mv,
			@Nullable Exception exception) throws Exception {

	// ...
		
	if (mappedHandler != null) {
		// Exception (if any) is already handled..
    	// 执行拦截器的afterCompletion()
		mappedHandler.triggerAfterCompletion(request, response, null);
	}
}

5. 多个拦截器的执行顺序

• 若每个拦截器的preHandle()都返回true

  1. 此时拦截器的执行循序和拦截器在配置文件中的配置顺序有关

  2. 优先执行所有拦截器的preHandle()，按照配置顺序执行

     boolean applyPreHandle(HttpServletRequest request, HttpServletResponse response) throws Exception {
     		for (int i = 0; i < this.interceptorList.size(); i++) { // 按顺序遍历执行
     			HandlerInterceptor interceptor = this.interceptorList.get(i);
     			if (!interceptor.preHandle(request, response, this.handler)) {
                 	// 当某个拦截器的preHandle()返回false时，执行之前拦截器的afterCompletion()
     				triggerAfterCompletion(request, response, null);
     				return false;
     			}
     			this.interceptorIndex = i; // 后面afterCompletion的执行依赖该属性
     		}
     		return true;
     }
     

  3. 执行完目标方法后，倒序执行所有拦截器的postHandle()

     void applyPostHandle(HttpServletRequest request, HttpServletResponse response, @Nullable ModelAndView mv)	throws Exception {
     		// 倒序遍历所有拦截器
     		for (int i = this.interceptorList.size() - 1; i >= 0; i--) {
     			HandlerInterceptor interceptor = this.interceptorList.get(i);
     			interceptor.postHandle(request, response, this.handler, mv);
     		}
     }
     

  4. 当完成视图渲染后，倒序执行afterComplation()

     void triggerAfterCompletion(HttpServletRequest request, HttpServletResponse response, @Nullable Exception ex) {
       		// 此处使用applyPreHandle方法中赋值的interceptorIndex倒序执行
     		for (int i = this.interceptorIndex; i >= 0; i--) {
     			HandlerInterceptor interceptor = this.interceptorList.get(i);
     			try {
     				interceptor.afterCompletion(request, response, this.handler, ex);
     			}
     			catch (Throwable ex2) {
     				logger.error("HandlerInterceptor.afterCompletion threw exception", ex2);
     			}
     		}
     }
     

• 若某个拦截器的preHandle()返回false (具体代码见上)

  1. preHandle()返回false和它之前的拦截器的preHandle()都会执行
  2. 所有拦截器的postHandle()都不执行
  3. preHandle()返回false的拦截器之前的拦截器的afterComplation()会被执行