慎用Spring HandlerInterceptorAdapter HandlerInterceptor 拦截器

HandlerInterceptor

HandlerInterceptor是Spring提供的拦截器的拓展接口，一搬我们可能会通过这个拓展，实现用户登录信息的校验，把用户信息放到ThreadLocal中向后传递，
这个接口有三个方法，如下

	default boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
			throws Exception {
    
    
		// 读cookie或token
		// 获取根据token获取用户信息
		// 如果不合法重定向到登录页
		// 如果获取到用户信息，则放到ThreadLocal向后传递
		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 {
    
    
			// 请求处理结束后，清楚ThreadLocal中的用户信息
	}

HandlerInterceptorAdapter的坑

HandlerInterceptorAdapter是HandlerInterceptor的子类，继承关系如下，虽然是子类但用法和HandlerInterceptor却有区别。

如上图，可以看到HandlerInterceptorAdapter继承了AsyncHandlerInterceptor，而从AsyncHandlerInterceptor它的命名，发现这个玩意可能是异步的。看下该类的java doc描述

对于AsyncHandlerInterceptor这个实现，请求处理结束后，Spring并不会调用它的 postHandle 和afterCompletion方法，而是会异步的调用afterConcurrentHandlingStarted

因此要小心了，如果再把清理ThreadLocal的逻辑写在afterCompletion里，实际上是没用的
HandlerInterceptorAdapter这个类从5.3版本已经标记为废弃

Deprecated
as of 5.3 in favor of implementing HandlerInterceptor and/or AsyncHandlerInterceptor directly.

推荐使用HandlerInterceptor或AsyncHandlerInterceptor

HandlerInterceptor如果preHandle发生了异常会怎样

	default boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
			throws Exception {
    
    
		// 读cookie或token
		// 获取根据token获取用户信息
		// 如果不合法重定向到登录页
		// 如果获取到用户信息，则放到ThreadLocal向后传递
		return true;
	}


	default void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler,
			@Nullable Exception ex) throws Exception {
    
    
			// 请求处理结束后，清楚ThreadLocal中的用户信息
	}

上述代码，如果在preHandle中发生了异常，还会再调用afterCompletion吗？

看这个方法的java doc描述，可知，不会

如果preHandle没有成功调用（包括发生了异常和没有调用）或者preHandle返回了false，都不会调用afterCompletion。

因此要小心，例如下面的代码

	default boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
			throws Exception {
    
    
		// 1读cookie或token
		// 2获取根据token获取用户信息
		// 3如果不合法重定向到登录页
		// 4如果获取到用户信息，则放到ThreadLocal向后传递
		// 5因为某些原因抛出异常，或return false
		return true;
	}
	```
	上述代码，如果在第5步发生了异常，将导致，第4步放在ThreadLocal中的数据无法被清理
	因此要小心使用preHandle方法