从刚接触前端开发起,跨域
这个词就一直以很高的频率在身边重复出现,一直到如今,已经调试过N个跨域相关的问题了,16年时也整理过一篇相关文章,可是感受仍是差了点什么,因而如今从新梳理了一下。javascript
我的见识有限,若有差错,请多多见谅,欢迎提出issue,另外看到这个标题,请勿喷~php
关于跨域,有N种类型,本文只专一于ajax请求跨域
(,ajax跨域只是属于浏览器"同源策略"中的一部分,其它的还有Cookie跨域iframe跨域,LocalStorage跨域等这里不作介绍),内容大概以下:html
什么是ajax跨域前端
如何解决ajax跨域java
如何分析ajax跨域node
ajax出现请求跨域错误问题,主要缘由就是由于浏览器的“同源策略”,能够参考git
浏览器同源政策及其规避方法(阮一峰)github
CORS是一个W3C标准,全称是"跨域资源共享"(Cross-origin resource sharing)。它容许浏览器向跨源服务器,发出XMLHttpRequest请求,从而克服了AJAX只能同源使用的限制。web
基本上目前全部的浏览器都实现了CORS标准,其实目前几乎全部的浏览器ajax请求都是基于CORS机制的,只不过可能平时前端开发人员并不关心而已(因此说其实如今CORS解决方案主要是考虑后台该如何实现的问题)。ajax
关于CORS,强烈推荐阅读
跨域资源共享 CORS 详解(阮一峰)
另外,这里也整理了一个实现原理图(简化版):
浏览器将CORS请求分红两类:简单请求(simple request)和非简单请求(not-so-simple request)。只要同时知足如下两大条件,就属于简单请求。
HTTP的头信息不超出如下几种字段:
凡是不一样时知足上面两个条件,就属于非简单请求。
说实话,当初整理过一篇文章,而后做为了一个解决方案,可是后来发现仍然有不少人仍是不会。无奈只能耗时又耗力的调试。然而就算是我来分析,也只会根据对应的表现来判断是不是跨域,所以这一点是很重要的。
ajax请求时,若是存在跨域现象,而且没有进行解决,会有以下表现:(注意,是ajax请求,请不要说为何http请求能够,而ajax不行,由于ajax是伴随着跨域的,因此仅仅是http请求ok是不行的)
注意:具体的后端跨域配置请看题纲位置。
No 'Access-Control-Allow-Origin' header is present on the requested resource
,而且The response had HTTP status code 404
出现这种状况的缘由以下:
解决方案: 后端容许options请求
No 'Access-Control-Allow-Origin' header is present on the requested resource
,而且The response had HTTP status code 405
这种现象和第一种有区别,这种状况下,后台方法容许OPTIONS请求,可是一些配置文件中(如安全配置
),阻止了OPTIONS请求,才会致使这个现象
解决方案: 后端关闭对应的安全配置
No 'Access-Control-Allow-Origin' header is present on the requested resource
,而且status 200
这种现象和第一种和第二种有区别,这种状况下,服务器端后台容许OPTIONS请求,而且接口也容许OPTIONS请求,可是头部匹配时出现不匹配现象
好比origin头部检查不匹配,好比少了一些头部的支持(如常见的X-Requested-With头部),而后服务端就会将response返回给前端,前端检测到这个后就触发XHR.onerror,致使前端控制台报错
解决方案: 后端增长对应的头部支持
heade contains multiple values '*,*'
表现现象是,后台响应的http头部信息有两个Access-Control-Allow-Origin:*
说实话,这种问题出现的主要缘由就是进行跨域配置的人不了解原理,致使了重复配置,如:
解决方案(一一对应):
通常ajax跨域解决就是经过JSONP解决或者CORS解决,如如下:(注意,如今已经几乎不会再使用JSONP了,因此JSONP了解下便可)
jsonp解决跨域问题是一个比较古老的方案(实际中不推荐使用),这里作简单介绍(实际项目中若是要使用JSONP,通常会使用JQ等对JSONP进行了封装的类库来进行ajax请求)
JSONP之因此可以用来解决跨域方案,主要是由于 <script> 脚本拥有跨域能力,而JSONP正是利用这一点来实现。具体原理如图
JSONP的实现步骤大体以下(参考了来源中的文章)
客户端网页网页经过添加一个<script>元素,向服务器请求JSON数据,这种作法不受同源政策限制
function addScriptTag(src) { var script = document.createElement('script'); script.setAttribute("type","text/javascript"); script.src = src; document.body.appendChild(script); } window.onload = function () { addScriptTag('http://example.com/ip?callback=foo'); } function foo(data) { console.log('response data: ' + JSON.stringify(data)); };
请求时,接口地址是做为构建出的脚本标签的src的,这样,当脚本标签构建出来时,最终的src是接口返回的内容
foo({ "test": "testData" });
注意,通常的JSONP接口和普通接口返回数据是有区别的,因此接口若是要作JSONO兼容,须要进行判断是否有对应callback关键字参数,若是有则是JSONP请求,返回JSONP数据,不然返回普通数据
使用注意
基于JSONP的实现原理,因此JSONP只能是“GET”请求,不能进行较为复杂的POST和其它请求,因此遇到那种状况,就得参考下面的CORS解决跨域了(因此现在它也基本被淘汰了)
CORS的原理上文中已经介绍了,这里主要介绍的是,实际项目中,后端应该如何配置以解决问题(由于大量项目实践都是由后端进行解决的),这里整理了一些常见的后端解决方案:
PHP后台得配置几乎是全部后台中最为简单的,遵循以下步骤便可:
<?php header('Access-Control-Allow-Origin: *'); header('Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept'); //主要为跨域CORS配置的两大基本信息,Origin和headers
原始代码
<Directory /> AllowOverride none Require all denied </Directory>
改成如下代码
<Directory /> Options FollowSymLinks AllowOverride none Order deny,allow Allow from all </Directory>
Node.js的后台也相对来讲比较简单就能够进行配置。只需用express以下配置:
app.all('*', function(req, res, next) { res.header("Access-Control-Allow-Origin", "*"); res.header("Access-Control-Allow-Headers", "X-Requested-With"); res.header("Access-Control-Allow-Methods", "PUT,POST,GET,DELETE,OPTIONS"); res.header("X-Powered-By", ' 3.2.1') //这段仅仅为了方便返回json而已 res.header("Content-Type", "application/json;charset=utf-8"); if(req.method == 'OPTIONS') { //让options请求快速返回 res.sendStatus(200); } else { next(); } });
JAVA后台配置只须要遵循以下步骤便可:
下载 cors-filter-1.7.jar, java-property-utils-1.9.jar 这两个库文件放到lib目录下。(放到对应项目的webcontent/WEB-INF/lib/下)
<dependency> <groupId>com.thetransactioncompany</groupId> <artifactId>cors-filter</artifactId> <version>[ version ]</version> </dependency>
其中版本应该是最新的稳定版本,CORS过滤器
<!-- 跨域配置--> <filter> <!-- The CORS filter with parameters --> <filter-name>CORS</filter-name> <filter-class>com.thetransactioncompany.cors.CORSFilter</filter-class> <!-- Note: All parameters are options, if omitted the CORS Filter will fall back to the respective default values. --> <init-param> <param-name>cors.allowGenericHttpRequests</param-name> <param-value>true</param-value> </init-param> <init-param> <param-name>cors.allowOrigin</param-name> <param-value>*</param-value> </init-param> <init-param> <param-name>cors.allowSubdomains</param-name> <param-value>false</param-value> </init-param> <init-param> <param-name>cors.supportedMethods</param-name> <param-value>GET, HEAD, POST, OPTIONS</param-value> </init-param> <init-param> <param-name>cors.supportedHeaders</param-name> <param-value>Accept, Origin, X-Requested-With, Content-Type, Last-Modified</param-value> </init-param> <init-param> <param-name>cors.exposedHeaders</param-name> <!--这里能够添加一些本身的暴露Headers --> <param-value>X-Test-1, X-Test-2</param-value> </init-param> <init-param> <param-name>cors.supportsCredentials</param-name> <param-value>true</param-value> </init-param> <init-param> <param-name>cors.maxAge</param-name> <param-value>3600</param-value> </init-param> </filter> <filter-mapping> <!-- CORS Filter mapping --> <filter-name>CORS</filter-name> <url-pattern>/*</url-pattern> </filter-mapping>
请注意,以上配置文件请放到web.xml的前面,做为第一个filter存在(能够有多个filter的)
20171230补充
仅列举简单的全局配置
@Configuration public class CorsConfig { private CorsConfiguration buildConfig() { CorsConfiguration corsConfiguration = new CorsConfiguration(); // 能够自行筛选 corsConfiguration.addAllowedOrigin("*"); corsConfiguration.addAllowedHeader("*"); corsConfiguration.addAllowedMethod("*"); return corsConfiguration; } @Bean public CorsFilter corsFilter() { UrlBasedCorsConfigurationSource source = new UrlBasedCorsConfigurationSource(); source.registerCorsConfiguration("/**", buildConfig()); return new CorsFilter(source); } }
新建配置,而后添加Configuration注解便可配置成功
PS:这一部分方法是收录的,没有亲身实践过,但根据反馈,理论上可行
.NET后台配置能够参考以下步骤:
打开控制面板,选择管理工具,选择iis;右键单击本身的网站,选择浏览;打开网站所在目录,用记事本打开web.config文件添加下述配置信息,重启网站
请注意,以上截图较老,若是配置仍然出问题,能够考虑增长更多的headers容许,好比:
"Access-Control-Allow-Headers":"X-Requested-With,Content-Type,Accept,Origin"
第二步:其它更多配置,若是第一步进行了后,仍然有跨域问题,多是:
Origin:*
,请去除便可Origin:*
,请去除便可注意,因为接口代理是有代价的,因此这个仅是开发过程当中进行的。
与前面的方法不一样,前面CORS是后端解决,而这个主要是前端对接口进行代理,也就是:
关于如何实现代理,这里就不重点描述了,方法和多,也不难,基本都是基于node.js的。
搜索关键字node.js
,代理请求
便可找到一大票的方案。
Access-Control-Max-Age:
这个头部加上后,能够缓存这次请求的秒数。
在这个时间范围内,全部同类型的请求都将再也不发送预检请求而是直接使用这次返回的头做为判断依据。
很是有用,能够大幅优化请求次数
上述已经介绍了跨域的原理以及如何解决,但实际过程当中,发现仍然有不少人对照着相似的文档没法解决跨域问题,主要体如今,前端人员不知道何时是跨域问题形成的,何时不是,所以这里稍微介绍下如何分析一个请求是否跨域:
第一步固然是得知道咱们的ajax请求发送了什么数据,接收了什么,作到这一步并不难,也不须要fiddler
等工具,仅基于Chrome
便可
Chrome
浏览器打开对应发生ajax的页面,F12
打开Dev Tools
NetWork
->XHR
,而后找到刚才的ajax请求,点进去上述请求是一个正确的请求,为了方便,我把每个头域的意思都代表了,咱们能够清晰的看到,接口返回的响应头域中,包括了
Access-Control-Allow-Headers: X-Requested-With,Content-Type,Accept Access-Control-Allow-Methods: Get,Post,Put,OPTIONS Access-Control-Allow-Origin: *
因此浏览器接收到响应时,判断的是正确的请求,天然不会报错,成功的拿到了响应数据。
为了方便,咱们仍然拿上面的错误表现示例举例。
这个请求中,接口Allow里面没有包括OPTIONS
,因此请求出现了跨域、
这个请求中,Access-Control-Allow-Origin: *
出现了两次,致使了跨域配置没有正确配置,出现了错误。
更多跨域错误基本都是相似的,就是以上三样没有知足(Headers,Allow,Origin),这里再也不一一赘述。
固然,也并非全部的ajax请求错误都与跨域有关,因此请不要混淆,好比如下:
好比这个请求,它的跨域配置没有一点问题,它出错仅仅是由于request的Accept
和response的Content-Type
不匹配而已。
基本上都是这样去分析一个ajax请求,经过Chrome
就能够知道了发送了什么数据,收到了什么数据,而后再一一比对就知道问题何在了。
跨域是一个老生常谈的话题,网上也有大量跨域的资料,而且有很多精品(好比阮一峰前辈的),可是身为一个前端人员不该该浅尝而止,故而才有了本文。
漫漫前端路,望与诸君共勉之!
初次发布2017.03.22
于我的博客