【SpringMVC】与权限拦截器冲突导致的Cors跨域设置失效问题
问题描述
前端域名FE.com向后端域名BE.com分别请求访问优惠券的列表和提交新增的优惠券,API设计所用的Method分别为Get和Post,结果为前一次访问成功而后一次访问失败。这两次请求都是跨域请求,其中请求1包含一个Get请求,请求2本应该包含一个Options请求和一个Post请求,但是只发生了Options请求。
后端Cors配置
CORS使用SpringMVC自带的mvc:cors标签全局配置,权限检测则实现自定义的拦截器校验Cookie中的Token信息。
<mvc:cors>
<mvc:mapping allow-credentials="true" allowed-headers="Content-Type"
allowed-methods="POST, GET, OPTIONS, DELETE, PUT, HEAD"
allowed-origins="http://test.i.meituan.com"
max-age="3600" path="/**"/>
</mvc:cors>
<mvc:interceptors>
<mvc:interceptor>
<mvc:mapping path="/ajax/shop/**"/> <!--sso回调处理-->
<bean class="com.dianping.orderdish.framework.interceptor.ShopSsoInterceptor"/>
</mvc:interceptor>
</mvc:interceptors>
在复杂请求的情况下(即请求2),由于预检请求不会包含Cookie信息(浏览器本身的实现决定其是否发送Cookie,前端无法控制,并且Chrome是不发送的),因此被权限拦截器提前结束,没有输出包含指定头部信息的响应。而一个被浏览器认为合格的预检请求响应必须包含如下的Http头部。
Access-Control-Allow-Origin: http://test.i.meituan.com
Access-Control-Allow-Methods: POST, GET, OPTIONS
Access-Control-Allow-Headers: Content-Type
Access-Control-Max-Age: 86400
为什么会发生提前结束这种情况?可以对dispatch()方法进行分析。
Handler和拦截器的执行顺序
DispatchServlet.doDispatch()方法是SpringMVC的核心入口方法,分析发现所有的拦截器的preHandle()方法的执行都在实际Handler的方法(比如某个API对应的业务方法)之前,其中任意拦截器返回false都会跳过后续所有处理过程。而SpringMVC对预检请求的处理则在PreFlightHandler.handleRequest()中处理,在整个处理链条中出于后置位。由于预检请求中不带Cookie,因此先被权限拦截器拦截。
// Determine handler for the current request.
mappedHandler = getHandler(processedRequest);
//省略代码
if (!mappedHandler.applyPreHandle(processedRequest, response)) {
return;
}
// Actually invoke the handler.
mv = ha.handle(processedRequest, response, mappedHandler.getHandler());
@CrossCors时序分析
除了在XML中设置全局的CORS配置,Spring提供了@CrossCors,可以注解在类和方法上,是一种更细粒度的配置方法。SpringMVC把其处理细节包装在getHandler(processedRequest);中,具体逻辑可以简述为如果请求是预检请求,则返回PreFlightHander;否则在拦截器末尾添加一个CorsInterceptor。因此可以看出,@CrossCors相关的执行和全局的mvc:cors类似,也是滞后于权限拦截器的。
解决方案
方案1:使用Spring-Web自带的CorsFilter
由于CorsFilter是定义在Web容器中的过滤器(实现了javax.servlet.Filter),因此其执行顺序先于Servlet,而SpringMVC的入口是DispatchServlet,因此该Filter会先于SpringMVC的所有拦截器执行。分析代码可知,CorsFilter会获取单个请求对应的Cors配置做相应的处理。因此可以和mvc:cors很好的结合,不需要增加额外的代码。(勘误:CorsFilter的构造需要CorsConfigurationSource实例,并且发生在SpringMVC配置文件解析之前,因此只能放在Spring的配置文件中,否则会发生找不到bean的异常;又由于mvc:cors的解析和Spring核心的解析不共享相同的ParserContext上下文,因此SpringMVC的跨域设置不能植入到CorsFilter中)
if (CorsUtils.isCorsRequest(request)) {
CorsConfiguration corsConfiguration = this.configSource.getCorsConfiguration(request);
if (corsConfiguration != null) {
boolean isValid = this.processor.processRequest(corsConfiguration, request, response);
if (!isValid || CorsUtils.isPreFlightRequest(request)) {
return;
}
}
}
filterChain.doFilter(request, response);
方案2:自己实现Interceptor
与方案1类似,把插入Http头的功能实现为SpringMVC的拦截器,然后在mvc:interceptors中声明为第一顺位。
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
if (request.getHeader(HttpHeaders.ORIGIN) != null) {
response.addHeader("Access-Control-Allow-Origin", "http://test.i.meituan.com");
response.addHeader("Access-Control-Allow-Credentials", "true");
response.addHeader("Access-Control-Allow-Methods", "POST, GET, OPTIONS, DELETE, PUT, HEAD");
response.addHeader("Access-Control-Allow-Headers", "Content-Type");
response.addHeader("Access-Control-Max-Age", "3600");
}
return true;
}
方案3:增强自定义Interceptor
利用AOP环绕增强所有自定义拦截器的preHandle()方法,令其跳过预检请求的拦截。
@Around(value = "cut()")
public Object processTx(ProceedingJoinPoint jp) throws Throwable {
HttpServletRequest request = (HttpServletRequest) jp.getArgs()[0];
if (request != null && CorsUtils.isPreFlightRequest(request)) {
return true;
} else {
return jp.proceed();
}
}