本示例演示在 WCF REST 服务中如何支持 JSON with Padding (JSONP)。 JSONP 是通过在当前文档中生成脚本标记来调用跨域脚本时使用的约定。 结果在指定的回调函数中返回。 JSONP 基于如思想<script src="http://..." >可以从任何域评估脚本,而这些标记检索的脚本评估在其中可能已定义其他函数的范围。
演示
使用 JSONP 进行跨域脚本编写。
讨论
本示例包含一个网页,该网页在页面呈现在浏览器中后动态添加脚本块。 此脚本块调用一个 WCF REST 服务,该服务有一个 GetCustomer 操作。 WCF REST 服务返回包装在回调函数名内的客户名称和地址。 当 WCF REST 服务响应时,会使用客户数据调用网页上的回调函数,该回调函数会在网页上显示数据。 脚本标记的注入和回调函数的执行由 ASP.NET AJAX ScriptManager 控件自动处理。 使用模式与所有 ASP.NET AJAX 代理相同,只是多了一行用于启用 JSONP 的代码,如下面的代码所示:
var proxy = new JsonpAjaxService.CustomerService();
proxy.set_enableJsonp(true);
proxy.GetCustomer(onSuccess, onFail, null);
网页可以调用 WCF REST 服务,因为该服务使用 xref:System.ServiceModel.Description.WebScriptEndpoint 且 crossDomainScriptAccessEnabled 设置为 true。 这两个配置都在下的 Web.config 文件中完成<system.serviceModel > 元素。
<system.serviceModel>
<serviceHostingEnvironment aspNetCompatibilityEnabled="true"/>
<standardEndpoints>
<webScriptEndpoint>
<standardEndpoint name="" crossDomainScriptAccessEnabled="true"/>
</webScriptEndpoint>
</standardEndpoints>
</system.serviceModel>
ScriptManager 管理与服务的交互并隐藏手动实现 JSONP 访问的复杂性。 当crossDomainScriptAccessEnabled设置为true和操作的响应格式是 JSON,WCF 基础结构会检查回调查询字符串参数的请求的 URI 和包装 JSON 响应的回调查询字符串值参数。 在本示例中,网页使用以下 URI 调用 WCF REST 服务。
http://localhost:33695/CustomerService/GetCustomer?callback=Sys._json0
因为回调查询字符串参数的值为 JsonPCallback,所以 WCF 服务返回如下面的示例所示的 JSONP 响应。
Sys._json0({"__type":"Customer:#Microsoft.Samples.Jsonp","Address":"1 Example Way","Name":"Bob"});
此 JSONP 响应包含 JSON 格式的客户数据(使用网页请求的回调函数名进行包装)。 ScriptManager 将使用脚本标记执行此回调以完成跨域请求,然后将结果传递给 onSuccess 处理程序,该处理程序会传递给 ASP.NET AJAX 代理的 GetCustomer 操作。
本示例由两个 ASP.NET web 应用程序组成: 一个包含仅的 WCF 服务,另一个包含调用该服务的.aspx 网页。 当运行该解决方案,Visual Studio 2012 将承载不同端口上的两个网站将创建的服务和客户端在其中存在于不同域的环境。
Important: 您的计算机上可能已安装这些示例。 在继续操作之前,请先检查以下(默认)目录:
<InstallDrive>:\WF_WCF_Samples如果此目录不存在,请转到Windows Communication Foundation (WCF) 和.NET Framework 4 的 Windows Workflow Foundation (WF) 示例若要下载所有 Windows Communication Foundation (WCF) 和WF示例。 此示例位于以下目录:
<InstallDrive>:\WF_WCF_Samples\WCF\Basic\AJAX\JSONP
运行示例
-
打开 JSONP 示例的解决方案。
-
按 F5 启动
http://localhost:26648/JSONPClientPage.aspx在浏览器中。 -
请注意,在页面加载后,"Name"和"Address"的文本输入填充的值。 在浏览器完成呈现页面后,从对 WCF 服务的调用并提供这些值。
历史资料。此文对应 2019-08-18 的中文文档快照,适用产品版本和命令行为以原文为准。
来源与署名:Microsoft 和文档贡献者。固定版本原文。文档采用 CC BY 4.0,示例代码采用 MIT 授权。本站展开固定版本仓库内的引用内容,将 Markdown 转为 HTML,规范化链接,移除外部媒体和导航标记。
