【HTTP header】【Access-Control-Allow-Credentials】跨域Ajax请求时是否带Cookie的设置
1. 无关Cookie跨域Ajax请求
客户端
以 Jquery 的 ajax 为例:
1 $.ajax({ 2 url : 'http://remote.domain.com/corsrequest', 3 data : data, 4 dataType: 'json', 5 type : 'POST', 6 crossDomain: true, 7 contentType: "application/json", // POST时必须 8 ...
主要注意的是参数 crossDomain: true。发送Ajax时,Request header 中会包含跨域的额外信息,但不会含cookie。
服务器端
跨域的允许主要由服务器端控制。服务器端通过在响应的 header 中设置 Access-Control-Allow-Origin
及相关一系列参数,提供跨域访问的允许策略。相关参数的设置介绍,可参见 [Access_control_CORS]
以Java为例:
1 /** 2 * Spring Controller中的方法: 3 */ 4 @RequestMapping(value = "/corsrequest") 5 @ResponseBody 6 public Map<String, Object> mainHeaderInfo(HttpServletResponse response) { 7 response.setHeader("Access-Control-Allow-Origin", "*"); 8 ... 9 }
- 通过在响应 header 中设置 ‘*’ 来允许来自所有域的跨域请求访问。
1 response.setHeader("Access-Control-Allow-Origin", "*");
- 只允许来自特定域
http://my.domain.cn:8080
的跨域访问1 response.setHeader("Access-Control-Allow-Origin", "http://my.domain.cn:8080");
- 较灵活的设置方式,允许所有包含
mydomain.com
的域名访问.1 if(request.getHeader("Origin").contains("mydomain.com")) { 2 response.setHeader("Access-Control-Allow-Origin", request.getHeader("Origin")); 3 }
2. 带Cookie的跨域Ajax请求
客户端
1 $.ajax({ 2 url : 'http://remote.domain.com/corsrequest', 3 data : data, 4 dataType: 'json', 5 type : 'POST', 6 xhrFields: { 7 withCredentials: true 8 }, 9 crossDomain: true, 10 contentType: "application/json", 11 ...
通过设置
withCredentials: true
,发送Ajax时,Request header中便会带上 Cookie 信息。服务器端
相应的,对于客户端的参数,服务器端也需要进行设置:
1 /** 2 * Spring Controller中的方法: 3 */ 4 @RequestMapping(value = "/corsrequest") 5 @ResponseBody 6 public Map<String, Object> getUserBaseInfo(HttpServletResponse response) { 7 if(request.getHeader("Origin").contains("woego.cn")) { 8 response.setHeader("Access-Control-Allow-Origin", request.getHeader("Origin")); 9 } 10 response.setHeader("Access-Control-Allow-Credentials", "true"); 11 ... 12 }
对应客户端的
xhrFields.withCredentials: true
参数,服务器端通过在响应 header 中设置Access-Control-Allow-Credentials = true
来运行客户端携带证书式访问。通过对 Credentials 参数的设置,就可以保持跨域 Ajax 时的 Cookie。这里需要注意的是:服务器端
Access-Control-Allow-Credentials = true
时,参数Access-Control-Allow-Origin
的值不能为'*'
。 -
3. Java中使用跨域 Filter
当允许跨域访问的接口较多时,在每个请求中都添加 Access-Control-Allow-Origin 显然是不合适的。对于比较原生的 Java web 应用,使用 Filter 是一个不错的选择。
NOTE:不同的框架,特别是支持REST的框架,大多提供了自己的跨域设置方式,如Spring4的Config等,可以优先从使用的框架中寻找支持。
Filter本身很简单,可以直接把上面两句设置 Header 的语句抽取出来写一个Filter。这里推荐一个 Tomcat 中的 Filter:
org.apache.catalina.filters.CorsFilter
。1 <filter> 2 <filter-name>CorsFilter</filter-name> 3 <filter-class>org.apache.catalina.filters.CorsFilter</filter-class> 4 </filter> 5 <filter-mapping> 6 <filter-name>CorsFilter</filter-name> 7 <url-pattern>/*</url-pattern> 8 </filter-mapping>
一点补充:
Filter的 默认 设置包含了:<filter> <filter-name>CorsFilter</filter-name> <filter-class>org.apache.catalina.filters.CorsFilter</filter-class> <init-param> <param-name>cors.allowed.origins</param-name> <param-value>*</param-value> </init-param> <init-param> <param-name>cors.support.credentials</param-name> <param-value>true</param-value> </init-param> </filter> <filter-mapping> <filter-name>CorsFilter</filter-name> <url-pattern>/*</url-pattern> </filter-mapping>
这里的 cors.allowed.origins 虽然是 ‘*’,但实现上已经被优化,不会与 credentials 冲突