从 jQuery 调用 WCF 服务库的问题

Posted 2023-05-07

【中文标题】从 jQuery 调用 WCF 服务库的问题

【英文标题】：Problem Calling WCF Service Library from jQuery

【发布时间】：2010-12-09 03:05:58

【问题描述】：

我有一个通过我的 ASPX 站点公开的 WCF 服务库，如下所示

[System.ServiceModel.OperationContract]
[System.ServiceModel.Web.WebInvoke(
Method= "POST",
RequestFormat=System.ServiceModel.Web. WebMessageFormat .Json,
ResponseFormat=System.ServiceModel.Web.WebMessageFormat .Json)]
LogonResponse Logon(LogonRequest logonRequest);


[System.Runtime.Serialization.DataContract]
[ Serializable()]
public class LogonRequest

[System.Runtime.Serialization.DataMember]
public string EMailAddress;
[System.Runtime.Serialization.DataMember]
public string Password;

在我的测试页面中，我可以通过 MS Ajax 调用：-

<asp:ScriptManager ID ="ScriptManager1" runat="server">
<Services>
<asp:ServiceReference Path="~/testService.svc" />
</Services>
</asp:ScriptManager>
.
.
.
function clsLogonRequest(eMailAddress, password) 
this .EMailAddress = eMailAddress;
this .Password = password;


function login(eMailAddress, password) 
var LogonRequest = new clsLogonRequest(eMailAddress, password);
name.API.IAPI.Logon(LogonRequest, onSuccess, onFailure);


function onSuccess(result) 
$( "#txtSessionId").val(result.SessionId);
$( "#txtUserName").val(result.Name);
$( "#txtUserId").val(result.UserId);

效果很好，或者通过 jQuery $.ajax 调用：-

$(document).ready(function() 
$( "#Button1").click(function() 
var LogonRequest = new clsLogonRequest( '*************' , '***********');
$.ajax(
type: "POST",
url: "testService.svc/Logon",
data: "'logonRequest':" + JSON.stringify(LogonRequest) + "" ,
contentType: "application/json; charset=utf-8",
dataType: "json",
success: function(msg) 
alert(msg.d);

);
);
);

哪个没有 - 在 FireBug 下我可以看到 500 Internal Server Error 消息并且异常开始

"ExceptionDetail":"HelpLink":null,"InnerException":null,"Message":"The token '\"' was expected but found '''.","StackTrace":"   at System.Xml.XmlExceptionHelper.ThrowXmlException(XmlDictionaryReader reader, String res, String arg1, String arg2, String arg3)\u000d\u000a   at System.Xml.XmlExceptionHelper .ThrowTokenExpected(XmlDictionaryReader reader, String expected, Char found)\u000d\u000a   at System.Runtime...

当我明确告诉它不要传递 XML 时，为什么 jQuery 调用似乎正在传递 XML（以及如何停止它以便尽可能自然地处理来自所有源的调用）？

提前致谢。

编辑：

感谢您的建议，我看了你说的，认为我对问题的解释不够清楚。

问题不在于没有发送 JSON，它正在发送并且格式正确，我可以从 firebug 中看到。问题是 WCF 服务库似乎在期待 XML，并在收到 JSON 时崩溃。

为了确保我没有忽略建议的解决方案，这里是 web.Config 提取 - 我尝试从行为中删除并从 services/service/endpoint 标记中删除 behaviorConfiguration 属性，这只是使整个事情都失败了，没有离开页面。

<system.serviceModel>
<behaviors>
<serviceBehaviors>
<behavior name ="MyServiceTypeBehaviors ">
<serviceDebug includeExceptionDetailInFaults="true" />
<serviceMetadata httpGetEnabled="true" />
</behavior>
</serviceBehaviors>
<endpointBehaviors>
<behavior name ="AspNetAjaxBehavior">
<enableWebScript/>
</behavior>
</endpointBehaviors>
</behaviors>
<serviceHostingEnvironment aspNetCompatibilityEnabled= "true " />
<services>
<service name ="test.API.API" behaviorConfiguration = " MyServiceTypeBehaviors">
<endpoint behaviorConfiguration="AspNetAjaxBehavior" binding = " webHttpBinding" contract="test.API.IAPI" />
<endpoint contract ="IMetadataExchange" binding= " mexHttpBinding" address="mex" />
</service>
</services>
</system.serviceModel>

提前致谢

【参考方案1】：

我猜你已经应用了 WebScriptEnablingBehavior（.config 中的 enableWebScript 元素）？这会导致所有请求都被包装在一个 JSON 对象中，该对象具有一个名为“d”的字段，该字段随后包含一个带有您的命名参数的对象。因此，您需要将 jQuery 数据更改为：

data: "d:logonRequest:" + JSON.stringify(LogonRequest) + ""

要么这样做，要么删除 enableWebScript 行为，但是，如果这样做，则必须改为应用 webHttp 行为。现在，不幸的是，默认编码是 XML，并且该行为不提供任何开关来控制整个服务的编码（MSFT 的糟糕设计）。因此，要么您必须通过设置 Request/ResponseFormat 属性将自己与每个方法的特定编码结合起来，或者，我过去是如何处理这个问题的，是我创建了一个应用相同 WebHttpBehavior 的“EnhancedWebHttpElement”，但提供对其各种属性的配置级别控制。使用此配置的好处是，您现在可以通过不同的端点公开相同的 WCF 服务，在一个端点上使用 ASP.NET AJAX 编码，在另一个端点上使用纯 JSON，甚至可能在另一个端点上使用 POX。

代码如下：

public sealed class EnhancedWebHttpElement : BehaviorExtensionElement

    #region Type specific properties

    [ConfigurationProperty("defaultBodyStyle", DefaultValue=WebMessageBodyStyle.Bare)]
    public WebMessageBodyStyle DefaultBodyStyle
    
        get
        
            return (WebMessageBodyStyle)this["defaultBodyStyle"];
        

        set
        
            this["defaultBodyStyle"] = value;
        
    

    [ConfigurationProperty("defaultOutgoingRequestFormat", DefaultValue=WebMessageFormat.Xml)]
    public WebMessageFormat DefaultOutgoingRequestFormat
    
        get
        
            return (WebMessageFormat)this["defaultOutgoingRequestFormat"];
        

        set
        
            this["defaultOutgoingRequestFormat"] = value;
        
    

    [ConfigurationProperty("defaultOutgoingResponseFormat", DefaultValue=WebMessageFormat.Xml)]
    public WebMessageFormat DefaultOutgoingResponseFormat
    
        get
        
            return (WebMessageFormat)this["defaultOutgoingResponseFormat"];
        

        set
        
            this["defaultOutgoingResponseFormat"] = value;
        
           

    #endregion

    #region Base class overrides

    protected override object CreateBehavior()
    
        WebHttpBehavior result = new WebHttpBehavior();

        result.DefaultBodyStyle = this.DefaultBodyStyle;
        result.DefaultOutgoingRequestFormat = this.DefaultOutgoingRequestFormat;
        result.DefaultOutgoingResponseFormat = this.DefaultOutgoingResponseFormat;

        return result;
    

    public override Type BehaviorType
    
        get
        
            return typeof(WebHttpBehavior);
        
    

    #endregion

然后你必须注册它：

<system.serviceModel>
    <extensions>
        <behaviorExtensions>
            <add name="enhancedWebHttp" type="MyNamespace.EnhancedWebHttpElement, MyAssembly, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null"/>
            </behaviorExtensions>
    </extensions>

然后你像这样使用它：

<behavior name="MyBehavior">
    <enhancedWebHttp defaultOutgoingRequestFormat="JSON" defaultOutgoingResponseFormat="JSON" />
</behavior>

---

更新：

上面的答案严格适用于 .NET 3.x。如果您使用的是 .NET 4.x，那么您现在可以使用在 WebHttpElement 上公开的 the DefaultOutgoingResponseFormat property 来控制它。更好的是，您可以公开一个端点并设置the new AutomaticFormatSelectionEnabled property，它将根据原始请求的格式以正确的格式响应。

【讨论】：

感谢您的建议，我已经编辑了我的原始帖子以澄清。

该异常总是看起来像是在解析 XML，因为这是 WCF 使用的模型，即使数据不是真正的 XML。在 JSON 的情况下，正在使用 DataContractJsonSerialzer，但即使它也继承自 XmlObjectSerializer，因此堆栈可以使它看起来像是在使用 XML。如果您可以发布完整的堆栈跟踪，那也很有用。关于您的配置的其他所有内容看起来都很好，但是使用 enableWebScript 后，您必须像我说的那样传递该包装器对象。如果您删除 enableWebScript，您实际上必须自己将消息编码设置为 JSON。

我真的很喜欢将“WCF Ajax Enabled”服务变成“Ajax Enabled”所涉及的工作量。