WCF RESTFul服务中的异常处理

时间:2014-09-27 02:38:36

标签: web-services wcf rest exception-handling wcf-rest

我正在使用WCF Service 4.5 F / W开发REST Full API。请建议如何向客户端发送异常或任何业务验证消息。我正在寻找非常通用的解决方案,请提出最佳方法。 我在下面尝试了一些方法,

  1. 在向客户发送回复之前设置OutgoingWebResponseContext。

  2. 定义的故障合同只能正常工作添加服务引用(代理类)无法在REST FULL环境中工作。

  3. 在catch块中添加WebFaultException类。

  4. WCF休息入门套件 - 我收到了一些关于此事的文章和帖子,但他们的codeplex官方建议不再提供此信息。 link。所以,我不想这样做。

  5. 这些没有按预期工作.. 我的示例代码段:     接口:

        [OperationContract]
        [FaultContract(typeof(MyExceptionContainer))]
        [WebInvoke(Method = "GET", UriTemplate = "/Multiply/{num1}/{num2}", BodyStyle = WebMessageBodyStyle.Wrapped,RequestFormat = WebMessageFormat.Xml, ResponseFormat = WebMessageFormat.Xml)]
        string Multiply(string num1, string num2);
    

    实现:

             public string Multiply(string num1, string num2)
        {
            if (num1 == "0" || num2 == "0")
            {
                try
                {
                    MyExceptionContainer exceptionDetails = new MyExceptionContainer();
                    exceptionDetails.Messsage = "Business Rule violatuion";
                    exceptionDetails.Description = "The numbers should be non zero to perform this operation";
                    //OutgoingWebResponseContext outgoingWebResponseContext = WebOperationContext.Current.OutgoingResponse;
                    //outgoingWebResponseContext.StatusCode = System.Net.HttpStatusCode.ExpectationFailed;
                    //outgoingWebResponseContext.StatusDescription = exceptionDetails.Description.ToString();
                   // throw new WebFaultException<MyExceptionContainer>(exceptionDetails,System.Net.HttpStatusCode.Gone);
                    throw new FaultException<MyExceptionContainer>(exceptionDetails,new FaultReason("FaultReason is " + exceptionDetails.Messsage + " - " + exceptionDetails.Description));
                }
                catch (Exception ex)
                {
                    throw new FaultException(ex.Message);
                }
            }
    
            return Convert.ToString(Int32.Parse(num1) * Int32.Parse(num2));
        }
    

    Web.Config:

      <system.serviceModel>
    <services>
      <service name="TestService.TestServiceImplementation" behaviorConfiguration="ServiceBehaviour">
        <endpoint binding="webHttpBinding" contract="TestService.ITestService" behaviorConfiguration="webHttp" >
        </endpoint>
      </service>
    </services>
    <behaviors>
      <serviceBehaviors>
        <behavior name="ServiceBehaviour">
          <!-- To avoid disclosing metadata information, set the value below to false and remove the metadata endpoint above before deployment -->
          <serviceMetadata httpGetEnabled="true"/>
          <!-- To receive exception details in faults for debugging purposes, set the value below to true.  Set to false before deployment to avoid disclosing exception information -->
          <serviceDebug includeExceptionDetailInFaults="true"/>
        </behavior>
      </serviceBehaviors>
      <endpointBehaviors>
        <behavior name="webHttp" >
          <webHttp helpEnabled="true" faultExceptionEnabled="true"/>
        </behavior>
      </endpointBehaviors>
    </behaviors>
    <serviceHostingEnvironment multipleSiteBindingsEnabled="true" />
    

    客户:

    try
            {
                string serviceUrl = "http://localhost:51775/TestService.cs.svc/Multiply/0/0";
                //Web Client
                //WebClient webClient = new WebClient();
                //string responseString = webClient.DownloadString(serviceUrl);
                WebRequest req = WebRequest.Create(serviceUrl);
                req.Method = "GET";
                req.ContentType = @"application/xml; charset=utf-8";
                HttpWebResponse resp = req.GetResponse() as HttpWebResponse;
                if (resp.StatusCode == HttpStatusCode.OK)
                {
                    XmlDocument myXMLDocument = new XmlDocument();
                    XmlReader myXMLReader = new XmlTextReader(resp.GetResponseStream());
                    myXMLDocument.Load(myXMLReader);
                    Console.WriteLine(myXMLDocument.InnerText);
                }
                Console.ReadKey();
            }
            catch (Exception ex)
            { 
            Console.WriteLine(ex.Message);
            }
    

    这是我的第一个问题,感谢所有充满激情的开发者......!

3 个答案:

答案 0 :(得分:7)

使用以下内容代替FaultException

服务器

catch (Exception ex)
            {
                throw new System.ServiceModel.Web.WebFaultException<string>(ex.ToString(), System.Net.HttpStatusCode.BadRequest);
            }

客户:

catch (Exception ex)
            {
                var protocolException = ex as ProtocolException;
                var webException = protocolException.InnerException as WebException;
                if (protocolException != null && webException != null)
                {
                    var responseStream = webException.Response.GetResponseStream();
                    var error = new StreamReader(webException.Response.GetResponseStream()).ReadToEnd();
                    throw new Exception(error);
                }
                else
                    throw new Exception("There is an unexpected error with reading the stream.", ex);

            }

答案 1 :(得分:1)

在wcf中创建真正的休息几乎是不可能的,但是利用httpprotocol的部分内容当然是可能的。

要控制服务中的错误消息,您必须提供一个错误处理程序(I错误处理程序实现),该处理程序挂钩到wcf堆栈并覆盖此处定义的任何错误处理。

此界面包含两种方法。一个通知wcf它是否可以处理某个异常(bool HandleError),另一个通知如果HandleError返回true。第二种方法ProvideFault允许您定义在异常情况下如何响应客户端。

您可以链接处理程序以获得更多粒度。由于您正在休息,您应该使用httpstatus代码来告知适用的错误情况。

http://blogs.msdn.com/b/carlosfigueira/archive/2011/06/07/wcf-extensibility-ierrorhandler.aspx

http://www.remondo.net/wcf-global-exception-handling-attribute-and-ierrorhandler/

答案 2 :(得分:-1)

Web.Config:

<system.serviceModel>
   <services>
    <service name="TestService.TestServiceImplementation">
      <endpoint address=""
                binding="webHttpBinding"
                contract="TestService.Service.ITestServiceImplementation" />
    <service/>
  <services/>
    <behaviors>
      <serviceBehaviors>
        <behavior>         
          <serviceMetadata httpGetEnabled="true"/>         
          <serviceDebug includeExceptionDetailInFaults="true"/>
        <behavior/>
      <serviceBehaviors/>
    <behaviors/>
    <serviceHostingEnvironment multipleSiteBindingsEnabled="true" />
  <system.serviceModel/>
 <system.webServer>
    <modules runAllManagedModulesForAllRequests="true"/>   
    <directoryBrowse enabled="true"/>
  <system.webServer/>

实施方式:

 public string Multiply(string num1, string num2)
{
    if (num1 == "0" || num2 == "0")
    {
        try
        {
            MyExceptionContainer exceptionDetails = new MyExceptionContainer();
            exceptionDetails.Messsage = "Business Rule violatuion";
            exceptionDetails.Description = "The numbers should be non zero to perform this operation";
            //OutgoingWebResponseContext outgoingWebResponseContext = WebOperationContext.Current.OutgoingResponse;
            //outgoingWebResponseContext.StatusCode = System.Net.HttpStatusCode.ExpectationFailed;
            //outgoingWebResponseContext.StatusDescription = exceptionDetails.Description.ToString();
           // throw new WebFaultException<MyExceptionContainer>(exceptionDetails,System.Net.HttpStatusCode.Gone);
            throw new FaultException<MyExceptionContainer>(exceptionDetails,new FaultReason("FaultReason is " + exceptionDetails.Messsage + " - " + exceptionDetails.Description));
        }
        catch (FaultException ex)
        {
            throw new FaultException(ex.Message);
        }
    }

    return Convert.ToString(Int32.Parse(num1) * Int32.Parse(num2));
}