WCF RESTful 4.0 Service级别的异常处理(WCF RESTful 4.0 Service level Exception Handling)

众所周知, WCF RESTful 4.0目前没有全局的异常处理方法. 也就是说, 你不能捕获所有的异常.

在ASP.NET里, 你可以在Global.asax.cs的Application_Error事件中捕获并处理所有之前没有被捕获的异常:

http://stackoverflow.com/questions/747011/how-do-i-create-a-global-exception-handler-for-a-wcf-services

public class Global : HttpApplication
{
    protected void Application_Error(object sender, EventArgs e)
    {
        Exception unhandledException = Server.GetLastError();

        //处理异常
        ...
    }
}

但在WCF RESTful 4.0中, 这种方法实际上只能捕获一些很特殊的异常, 比如你在Application_BeginRequest添加了自定义代码, 这些代码中出现了异常.

而其他绝大多数情况下, 当你的WCF服务中出现错误时, 这个事件是不会被触发的.

 

要想捕获所有"有用的异常信息", 一个折衷的办法是在每个Service Method中, 用一个try…catch包裹所有整个方法体, 像这样:

[WebGet(UriTemplate = "me/{profileIdOrName}")]
public string GetMyProfile(string profileIdOrName)
{
    try
    {
        //以下是GetMyProfile的方法体
        RequireLogin();
        return GetUserProfile(CurrentUser.Id, profileIdOrName);
    }
    catch (Exception ex)
    {
        //ExceptionHandling.Handle 是异常处理模块
        if(ExceptionHandling.Handle(ex))
            throw;

        return null;
    }
}

这样做虽然不能保证捕获所有的异常, 但是至少能保证不会遗漏任何业务逻辑层面的异常. 其他不能捕获的, 大部分是属于配置错误.

如果你能接受这个解决方法, 那你没有必要再接着读下去了.

这篇文章的其余部分, 介绍了一个不用在每个方法中加try…catch, 却能达到相同效果的解决方案.

 

为了达到在每个方法中加try…catch相同的效果(捕获所有除配置等错误之外的异常), 我们可以利用IErrorHandler接口.

首先, 实现一个IErrorHandler:

using System;
using System.ServiceModel.Channels;
using System.ServiceModel.Dispatcher;
using System.ServiceModel.Web;

namespace Test
{
    public class GeneralErrorHandler : IErrorHandler
    {
        /// <summary>
        /// 处理异常的方法代理.
        /// <para>通常情况下这个方法代理应该返回false, 以使其他处理异常的方法代理能继续处理这个异常.</para>
        /// </summary>
        public readonly Func<Exception, bool> FnHandleError;

        /// <summary>
        /// 根据异常生成返回到客户端的错误信息的方法代理.
        /// </summary>
        public readonly Func<Exception, object> FnGetFaultDetails;

        /// <summary>
        /// 创建一个GeneralErrorHandler新实例.
        /// </summary>
        /// <param name="fnGetFaultDetails">根据异常生成返回到客户端的错误信息的方法代理.</param>
        /// <param name="fnHandleError">
        /// 处理异常的方法代理.
        /// <para>通常情况下这个方法代理应该返回false, 以使其他处理异常的方法代理能继续处理这个异常.</para>
        /// </param>
        public GeneralErrorHandler(Func<Exception, bool> fnHandleError, Func<Exception, object> fnGetFaultDetails)
        {
            FnHandleError = fnHandleError;
            FnGetFaultDetails = fnGetFaultDetails;
        }

        #region IErrorHandler Members

        public bool HandleError(Exception error)
        {
            if (FnHandleError == null)
                return false; //returns false so the other Error Handlers can do sth with the error.

            return FnHandleError(error);
        }

        public void ProvideFault(Exception error, MessageVersion version, ref Message fault)
        {
            //如果你只是想捕获并记录所有的异常, 并打算向客户端发送所有的错误信息,
            //你可以把以下代码用一句fault = null;代替


            //if we set fault = null, raw error will be sent to client(http status won't be 200 OK);
            //  otherwise, if you provided fault message, http status will be 200 OK, and client will receive the fault message instead an error.

            var isJson = true;
            var context = WebOperationContext.Current;
            if (null != context && null != context.OutgoingResponse && null != context.OutgoingResponse.Format)
                isJson = context.OutgoingResponse.Format.Value == WebMessageFormat.Json;

            var faultDetails = null == FnGetFaultDetails ? null : FnGetFaultDetails(error);
            var bodyWriter = new FaultBodyWriter(faultDetails, isJson);
            fault = Message.CreateMessage(version, string.Empty, bodyWriter);

            var bodyFormatProperty = new WebBodyFormatMessageProperty(isJson ? WebContentFormat.Json : WebContentFormat.Xml);
            fault.Properties[WebBodyFormatMessageProperty.Name] = bodyFormatProperty;

            if (isJson)
                context.OutgoingResponse.ContentType = "application/json";
        }

        #endregion
    }
}

以上代码59行中有一个FaultBodyWriter, 这是为了向客户端返回JSON格式的错误信息而实现的. 如果不使用它, 返回的错误信息将是XML格式.

 

using System.Runtime.Serialization;
using System.Runtime.Serialization.Json;
using System.ServiceModel.Channels;
using System.Xml;

namespace Test
{
    public class FaultBodyWriter : BodyWriter
    {
        private object FaultDetails;
        private XmlObjectSerializer Serializer;

        public FaultBodyWriter(object faultDetails, bool isJson)
            : base(true)
        {
            FaultDetails = faultDetails;

            var type = faultDetails.GetType();
            if (isJson)
                Serializer = new DataContractJsonSerializer(type);
            else
                Serializer = new DataContractSerializer(type);
        }

        protected override void OnWriteBodyContents(XmlDictionaryWriter writer)
        {
            Serializer.WriteObject(writer, FaultDetails);
        }
    }
}

 

然后是最关键的一步, 把我们的GeneralErrorHandler"注册"(或者你可以说绑定)到WCF服务中, 我们用实现一个IServiceBehavior接口的ErrorHandlerBehaviorAttribute完成.

using System;
using System.Collections.ObjectModel;
using System.ServiceModel;
using System.ServiceModel.Channels;
using System.ServiceModel.Description;
using System.ServiceModel.Dispatcher;

namespace Test
{
    [AttributeUsage(AttributeTargets.Class, Inherited = true)]
    public class ErrorHandlerBehaviorAttribute : Attribute, IServiceBehavior
    {
        public readonly GeneralErrorHandler ErrorHandler;

        public ErrorHandlerBehaviorAttribute()
        {
            ErrorHandler = new GeneralErrorHandler(error =>
            {
                //...在这里记录并处理异常
                return false; //返回false, 以使其他处理异常的方法代理能继续处理这个异常.
            },

            error => new SampleItem //在这里, 我们返回异常的Message. 实际情况下的处理可能会很复杂, 取决于你的需求.
            {
                Id = 20110509,
                StringValue = error.Message
            });
        }

        #region IServiceBehavior Members

        public void AddBindingParameters(ServiceDescription serviceDescription, ServiceHostBase serviceHostBase,
            Collection<ServiceEndpoint> endpoints, BindingParameterCollection bindingParameters)
        { }

        public void ApplyDispatchBehavior(ServiceDescription serviceDescription, ServiceHostBase serviceHostBase)
        {
            //在这里注册我们的GeneralErrorHandler
            foreach (ChannelDispatcher dispatcher in serviceHostBase.ChannelDispatchers)
                dispatcher.ErrorHandlers.Add(ErrorHandler);
        }

        public void Validate(ServiceDescription serviceDescription, ServiceHostBase serviceHostBase)
        { }

        #endregion
    }
}

最后, 把它注册到Service上.

using System;
using System.Collections.Generic;
using System.ServiceModel;
using System.ServiceModel.Activation;
using System.ServiceModel.Web;

namespace Test
{
    [ServiceContract]
    [AspNetCompatibilityRequirements(RequirementsMode = AspNetCompatibilityRequirementsMode.Allowed)]
    [ServiceBehavior(InstanceContextMode = InstanceContextMode.PerCall)]
    [ErrorHandlerBehavior] //注册ErrorHandler到基类
    public class Service1
    {
        [WebGet(UriTemplate = "")]
        public List<SampleItem> GetCollection()
        {
            throw new Exception("这是一个演示WCF REST 4.0 Exception Handling的例子");
        }
    }
}

 

好了, 一切搞定. 现在你只要在任何新的Service上面添加一个[ErrorHandlerBehavior]属性, 就可以避免在每个方法中都添加try…catch了.

参考: http://tothsolutions.com/Blog/post/WCFSilverlight-Exception-Handling.aspx

示例: WcfRestService1.rar