CORS跨域问题解决

CORS跨域问题解决

简介

CORS是一个W3C标准，全称是”跨域资源共享”（Cross-origin resource sharing）。它允许浏览器向跨源(协议 + 域名 + 端口)服务器，发出XMLHttpRequest请求，从而克服了AJAX只能同源使用的限制。

CORS需要浏览器和服务器同时支持。它的通信过程，都是浏览器自动完成，不需要用户参与。对于开发者来说，CORS通信与同源的AJAX通信没有差别，代码完全一样。浏览器一旦发现AJAX请求跨源，就会自动添加一些附加的头信息，有时还会多出一次附加的请求，但用户不会有感觉。

因此，实现CORS通信的关键是服务器。只要服务器实现了CORS接口，就可以跨源通信。

什么情况才算跨域？

一般来说，当一个请求url的协议、域名、端口三者之间任意一个与当前页面地址不同即为跨域。最常见的就是在一个域名下的网页中，调用另一个域名中的资源。

两种请求

浏览器将CORS请求分成两类：简单请求（simple request）和非简单请求（not-so-simple request）。
只要同时满足以下两大条件，就属于简单请求

1、简单请求

（1) 请求方法是以下三种方法之一：
HEAD
GET
POST
（2）HTTP的头信息不超出以下几种字段：
Accept
Accept-Language
Content-Language
Last-Event-ID
Content-Type：只限于三个值application/x-www-form-urlencoded、multipart/form-data、text/plain

同时满足以上两点的就是简单请求，其他就是非简单请求了。

（1）Access-Control-Allow-Origin

该字段是必须的。它的值要么是请求时Origin字段的值，要么是一个*，表示接受任意域名的请求。

（2）Access-Control-Allow-Credentials

该字段可选。它的值是一个布尔值，表示是否允许发送Cookie。默认情况下，Cookie不包括在CORS请求之中。设为true，即表示服务器明确许可，Cookie可以包含在请求中，一起发给服务器。这个值也只能设为true，如果服务器不要浏览器发送Cookie，删除该字段即可。

（3）Access-Control-Expose-Headers

该字段可选。CORS请求时，XMLHttpRequest对象的getResponseHeader()方法只能拿到6个基本字段：Cache-Control、Content-Language、Content-Type、Expires、Last-Modified、Pragma。如果想拿到其他字段，就必须在Access-Control-Expose-Headers里面指定。

withCredentials 属性

上面说到，CORS请求默认不发送Cookie和HTTP认证信息。如果要把Cookie发到服务器，一方面要服务器同意，指定Access-Control-Allow-Credentials字段。

另一方面，开发者必须在AJAX请求中打开withCredentials属性。
var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

需要注意的是，如果要发送Cookie，Access-Control-Allow-Origin就不能设为星号，必须指定明确的、与请求网页一致的域名。同时，Cookie依然遵循同源政策，只有用服务器域名设置的Cookie才会上传，其他域名的Cookie并不会上传，且（跨源）原网页代码中的document.cookie也无法读取服务器域名下的Cookie。

2、非简单请求

非简单请求是那种对服务器有特殊要求的请求，比如需要在请求头head中设置自定义的token，请求方法是PUT或DELETE，或者Content-Type字段的类型是application/json。
非简单请求的CORS请求，会在正式通信之前，增加一次HTTP查询请求，称为”预检”请求（preflight）。

“预检”请求用的请求方法是OPTIONS，检查了Origin、Access-Control-Request-Method和Access-Control-Request-Headers字段以后，确认允许跨源请求，就可以做出回应。

1）Access-Control-Allow-Methods

该字段必需，它的值是逗号分隔的一个字符串，表明服务器支持的所有跨域请求的方法。注意，返回的是所有支持的方法，而不单是浏览器请求的那个方法。这是为了避免多次”预检”请求。

（2）Access-Control-Allow-Headers

如果浏览器请求包括Access-Control-Request-Headers字段，则Access-Control-Allow-Headers字段是必需的。它也是一个逗号分隔的字符串，表明服务器支持的所有头信息字段，不限于浏览器在”预检”中请求的字段。

（3）Access-Control-Allow-Credentials

该字段与简单请求时的含义相同。

（4）Access-Control-Max-Age

该字段可选，用来指定本次预检请求的有效期，单位为秒。上面结果中，有效期是20天（1728000秒），即允许缓存该条回应1728000秒（即20天），在此期间，不用发出另一条预检请求。

需要详细了解的请看原文跨域资源共享 CORS 详解

参数整理

把常用的参数汇总为下面的表格：

参数名	参数	含义
Access-Control-Allow-Origin	*或指定的origin	指定要接受的域名的值.，表示接受任意域名的请求(为了安全考虑不建议设置为)
Access-Control-Allow-Methods	POST, GET, OPTIONS, DELETE,PUT	表明服务器支持的所有头信息字段，逗号分隔
Access-Control-Allow-Headers	token,DNT,X-Mx-ReqToken,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Access-Control,x-access-token。其中token是自定义的	表明服务器支持的所有跨域请求的方法，逗号分隔
Access-Control-Allow-Credentials	true/false	表示是否允许发送Cookie。默认情况下，Cookie不包括在CORS请求之中。设为true，即表示服务器明确许可
Access-Control-Max-Age	3600	用来指定本次预检请求的有效期，单位为秒
Access-Control-Expose-Headers	自定义值，比如token	指定自定义的响应头字段。XMLHttpRequest对象的getResponseHeader()方法只能拿到6个基本字段

服务端代码配置

1、xml配置

在web.xml上面添加配置：

    <!--配置过滤器-->
    <filter>
        <filter-name>OriginFilter</filter-name>
        <filter-class>com.zzh.filter.OriginFilter</filter-class>
    </filter>

    <filter-mapping>
        <filter-name>OriginFilter</filter-name>
        <url-pattern>/*</url-pattern>
    </filter-mapping>

2、Java配置

下面代码示例是一个比较综合的配置，
1、http请求头中自定义了token，
2、http请求允许发送Cookie
3、http响应头自定义token

在开发中，根据实际需求可以进行删减。

public class OriginFilter implements Filter {

    private final Logger logger = LoggerFactory.getLogger(getClass());

    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        logger.debug("init......");
    }

    @Override
    public void destroy() {
        logger.debug("destroy......");


    }

    @Override
    public void doFilter(ServletRequest req, ServletResponse res, FilterChain chain) throws IOException,
            ServletException {
        HttpServletRequest request = (HttpServletRequest) req;
        HttpServletResponse response = (HttpServletResponse) res;

        String origin = request.getHeader("Origin");
        logger.debug("this is OriginFilter ,origin:" + origin + ", url: " + request.getRequestURI() + ",methods:" + request.getMethod());

        //指定要接受的域名的值.*，表示接受任意域名的请求(为了安全考虑不建议设置为*)
        response.setHeader("Access-Control-Allow-Origin", origin);
        //表明服务器支持的所有头信息字段，逗号分隔
        response.setHeader("Access-Control-Allow-Methods", "POST, GET, OPTIONS, DELETE,PUT");
        //用来指定本次预检请求的有效期，单位为秒
        response.setHeader("Access-Control-Max-Age", "3600");
        //表明服务器支持的所有跨域请求的方法，逗号分隔
        response.setHeader("Access-Control-Allow-Headers", "token,DNT,X-Mx-ReqToken,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Access-Control,x-access-token");
        //表示是否允许发送Cookie。默认情况下，Cookie不包括在CORS请求之中。设为true，即表示服务器明确许可
        response.setHeader("Access-Control-Allow-Credentials", "true");
        //指定自定义的响应头字段。XMLHttpRequest对象的getResponseHeader()方法只能拿到6个基本字段
        response.setHeader("Access-Control-Expose-Headers", "token");

        chain.doFilter(req, res);

    }

参考原文

SpringMvc解决跨域
https://my.oschina.net/wangnian/blog/689020
跨域资源共享 CORS 详解
http://www.ruanyifeng.com/blog/2016/04/cors.html#comment-text