本文详细解析Ajax跨域访问WebService的解决方案,重点介绍JSONP技术的实现原理。通过C#与Java服务端代码示例,展示如何利用JSONP参数动态生成JavaScript回调函数以绕过浏览器同源策略。同时提及Chrome浏览器中通过设置Access-Control-Allow-Origin头实现跨域的方法,帮助开发者理解并应用相关技术。
Ajax跨域访问WebService概述
近期在使用Ajax访问WebService时遇到了跨域限制问题,经过查阅相关资料并整理实践,总结如下(部分内容参考了网络上的优质总结)。
核心思路:利用JSON传输数据,并通过JSONP机制实现跨域访问。
JSONP实现代码示例
以下是已验证可行的代码实现:
前端JavaScript调用代码:
$.ajax({
type: "get",
url: "http://localhost/Service1.asmx/getElevatorStatusJsonData?jsoncallback=?",
dataType: "jsonp",
jsonp: "json",
data: "",
success: function (result) {
var data = eval(result);
for (var i = 0; i < data.length; i++) {
alert(data[i].ID + "--" + data[i].Name);
}
},
error: function (a, b, c) {
alert(c);
}
});
服务端C#处理代码:
/// <summary>
/// 获取状态数据信息
/// </summary>
/// <returns></returns>
[WebMethod]
public void getElevatorStatusJsonData()
{
List<List<DeviceInfo>> elevatordatas = new List<List<DeviceInfo>>();
List<SendDicdate> searchList = XmlSerializeHelper.XmlDeserializeFromFile<List<SendDicdate>>(@ConfigUtil.servicePath + ConfigUtil.getConfigByKey("xmlPath") + "查询指令信息.xml", Encoding.UTF8);
foreach (SendDicdate item in searchList)
{
string key = item.portno + "-" + item.bordrate + "-" + item.sendtype;
List<DeviceInfo> deviceInfoList = (List<DeviceInfo>)Context.Cache.Get(key);
elevatordatas.Add(deviceInfoList);
}
String result = "";
DataContractJsonSerializer json = new DataContractJsonSerializer(elevatordatas.GetType());
using (MemoryStream stream = new MemoryStream())
{
json.WriteObject(stream, elevatordatas);
result = Encoding.UTF8.GetString(stream.ToArray());
}
String jsoncallback = HttpContext.Current.Request["jsoncallback"];
result = jsoncallback + '(' + result + ')';
HttpContext.Current.Response.Write(result);
HttpContext.Current.Response.End();
}
C#
上述为调用C#服务端的实现示例,下方展示Java服务端的代码。虽然具体参数可能存在差异,但核心原理一致。
Java服务端处理逻辑:
String callbackFunName = context.Request["callbackparam"];
context.Response.Write(callbackFunName + "([ { \"name\":\"John\"}])");
补充说明:客户端JSONP参数用于通过URL传递jsonpCallback参数的名称,表述较为晦涩,通俗解释如下:
配置项:jsonp: ""
配置项:jsonpCallback:""
另外需要注意的是,在Chrome浏览器环境中,还可以在服务端设置HTTP响应头 context.Response.AddHeader("Access-Control-Allow-Origin", "*") 来实现跨域请求,且无需额外配置Ajax参数。
dataType : "jsonp",
jsonp: "callbackparam",
jsonpCallback:"jsonpCallback1"
此时,使用标准的Ajax请求方式即可正常获取数据。
JSONP跨域原理分析
以下是关于该机制的原理分析,参考了相关技术讲解,逻辑清晰:
1、众所周知,Ajax直接请求普通文件存在跨域权限限制,无论是静态页面、动态网页、Web服务还是WCF,只要是跨域请求,浏览器一律禁止;
2、然而我们发现,Web页面中调用JS文件时不受跨域限制(不仅如此,我们还发现凡是拥有”src”这个属性的标签都拥有跨域的能力,比如<img>、<script>等);
3、由此可以推断,在当前阶段若想通过纯Web端(ActiveX控件、服务端代理、未来的HTML5之Websocket等方式除外)跨域访问数据,只有一种可能,那就是在远程服务器上设法把数据装进js格式的文件里,供客户端调用和进一步处理;
4、恰巧我们已经知道有一种叫做JSON的纯字符数据格式可以简洁的描述复杂数据,更妙的是JSON还被js原生支持,所以在客户端几乎可以随心所欲的处理这种格式的数据;
5、这样子解决方案就呼之欲出了,web客户端通过与调用脚本一模一样的方式,来调用跨域服务器上动态生成的js格式文件(一般以JSON为后缀),显而易见,服务器之所以要动态生成JSON文件,目的就在于把客户端需要的数据装入进去。
6、客户端在对JSON文件调用成功之后,也就获得了自己所需的数据,剩下的就是按照自己需求进行处理和展现了,这种获取远程数据的方式看起来非常像AJAX,但其实并不一样。
7、为了便于客户端使用数据,逐渐形成了一种非正式传输协议,人们把它称作JSONP,该协议的一个要点就是允许用户传递一个callback 参数给服务端,然后服务端返回数据时会将这个callback参数作为函数名来包裹住JSON数据,这样客户端就可以随意定制自己的函数来自动处理返回数 据了。
聪明的开发者很容易想到,只要服务端提供的js脚本是动态生成的就行了呗,这样调用者可以传一个参数过去告诉服务端“我想要一段调用XXX函数的js代码,请你返回给我”,于是服务器就可以按照客户端的需求来生成js脚本并响应了。
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><title></title><script type="text/javascript">// 得到航班信息查询结果后的回调函数var flightHandler =function(data){
alert('你查询的航班结果是:piao价 '+ data.price +' 元,'+'余piao '+ data.tickets +' 张。');
}; // 提供jsonp服务的url地址(不管是什么类型的地址,最终生成的返回值都是一段javascript代码)var url ="http://flightQuery.com/jsonp/flightResult.aspx?code=CA1998&callback=flightHandler"; // 创建script标签,设置其属性var script = document.createElement('script');
script.setAttribute('src', url);
// 把script标签加入head,此时调用开始
//document.getElementsByTagName('head')[0].appendChild(script);
</script></head><body></body></html>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><title>Untitled Page</title><script type="text/javascript" src=jquery.min.js"></script><script type="text/javascript">
jQuery(document).ready(function(){
$.ajax({
type: "get",
async: false,
url: "http://flightQuery.com/jsonp/flightResult.aspx?code=CA1998",
dataType: "jsonp",
jsonp: "callback",//传递给请求处理程序或页面的,用以获得jsonp回调函数名的参数名(一般默认为:callback) jsonpCallback:"flightHandler",//自定义的jsonp回调函数名称,默认为jQuery自动生成的随机函数名,也可以写"?",jQuery会自动为你处理数据 success: function(json){
alert('您查询到航班信息:piao价: '+ json.price +' 元,余piao: '+ json.tickets +' 张。');
},
error: function(){
alert('fail');
}
});
}); </script></head><body></body></html>
是不是有点奇怪?为什么我这次没有写flightHandler这个函数呢?而且竟然也运行成功了!哈哈,这就是jQuery的功劳了,jquery在处理jsonp类型的ajax时(还是忍不住吐槽,虽然jquery也把jsonp归入了ajax,但其实它们真的不是一回事儿),自动帮你生成回调函数并把数据取出来供success属性方法来调用,是不是很爽呀?