Enterprise Library深入解析与灵活应用（8）：WCF与Exception Handling AppBlock集成[下]

在上篇中，我详细介绍了如何通过自定义ClientMessageInspector和ErrorHandler，实现WCF与微软企业库中的Exception Handling Application Block（EHAB）之间的集成。这个方案的基本思路就是：当异常从服务端抛出，利用EHAB针对某个配置好的异常处理策略进行处理；然后将处理有的异常通过ServiceExceptionDetail对象进行封装，最后序列化置于Fault消息，最终被返回给客户端；客户端接收到该Fault消息后，提取并创建ServiceExceptionDetail对象，并通过反射重建异常；最后将异常抛出，使客户端可以根据客户端配置的异常处理策略对该异常进行进一步的处理。（Source Code从这里下载）

为了实现WCF对ServiceExceptionDetail对象的序列化和反序列化，我们必须通过FaultContractAttribute特性将类型定义成错误契约，相应的形式如下面的代码所示。在一般的情况下，如果你定义的服务是为他人所用，比如第三方服务消费者，该错误契约的定义是必须的，因为相应的错误明细类型需要通过元数据的形式发布出来，指导客户端如何对接收到的消息进行反序列化。但是，如果服务仅供你自己的应用所用，那么你可以在运行时动态地添加相应的错误描述，从而避免在服务契约的每一个服务操作方法上应用这么一个FaultContractAttribute。

[ServiceContract(Namespace = "http://www.artech.com/")]
public interface ICalculator
{
    [OperationContract]
    [ExceptionHandlingBehavior("myExceptionPolicy")]
    [FaultContract(typeof(ServiceExceptionDetail), Action = "http://www.artech.com/fault")]
    int Divide(int x, int y);
}

我们应用在操作方法上面的FaultContractAttribute特性，最终会转换成操作描述（OperationDescription）的错误描述（FaultDescription），如果我们在运行时能够为所有的操作描述添加相应的错误描述，就能避免在每个服务操作上面应用相同的FaultContractAttribute特性。不过，为了服务的重用，我不介意这样偷懒，所以这种方案仅仅作为研究、学习之用。

一、通过自定义ServiceHost的方式动态添加错误描述（服务端）

首先需要在服务端为每一个服务操作添加基于ServiceExceptionDetail的错误描述，这可以通过自定ServiceHost来实现。由于服务描述需要在ServiceHost开启之前生成方才有效（具体的原因，相对比较复杂，大家可以在《WCF技术剖析(卷1)》第7章关于服务寄宿的部分找到答案），所以我们将相关的逻辑定义在OnOpening方法之中。在下面的代码中，我定义了这样一个简单的ServiceHost：ExceptionHandlingServiceHost。

using System;
using System.ServiceModel;
using System.ServiceModel.Activation;
using System.ServiceModel.Description;

namespace Artech.EnterLibIntegration.WcfExtensions
{
    public class ExceptionHandlingServiceHost : ServiceHost
    {
        public ExceptionHandlingServiceHost(Type t, params Uri[] baseAddresses)
            : base(t, baseAddresses)
        { }

        protected override void OnOpening()
        {
            base.OnOpening();
            foreach (ServiceEndpoint endpoint in this.Description.Endpoints)
            {
                foreach (OperationDescription operation in endpoint.Contract.Operations)
                {
                    FaultDescription faultDescription = new FaultDescription(ServiceExceptionDetail.FaultAction);
                    faultDescription.DetailType = typeof(ServiceExceptionDetail);
                    operation.Faults.Add(faultDescription);
                }
            }
        }
    }
}

逻辑相对比较简单：遍历所有终结点（ServiceEndpoint），为每一个终结点的契约（ContractDescription）的每一个操作（OperationDescription）添加错误明细类型为ServiceExceptionDetail的错误描述（FaultDescription），并指定预定义的Action。

对于自定义的ServiceHost，可以直接用于不需要.svc文件进行访问的寄宿场景，也就是说对于除了IIS和WAS的服务寄宿，可以直接采用自定义的ServiceHost。服务需要在基于IIS和WAS的寄宿方式中采用自定义的ServiceHost，还需要为之创建相应的ServiceHostFactory（关于ServiceHostFactory作用和用法，同样可以参阅《WCF技术剖析(卷1)》第7章）。下面，我们为ExceptionHandlingServiceHost定义了一个简单的ServiceHostFactory：ExceptionHandlingServiceHostFactory。

using System;
using System.ServiceModel;
using System.ServiceModel.Activation;
using System.ServiceModel.Description;

namespace Artech.EnterLibIntegration.WcfExtensions
{
    public class ExceptionHandlingServiceHostFactory : ServiceHostFactory
    {
        protected override ServiceHost CreateServiceHost(Type serviceType, Uri[] baseAddresses)
        {
            return new ExceptionHandlingServiceHost(serviceType, baseAddresses);
        }
    }
}

二、通过自定义ChannelFactory<TChanel>的方式动态添加错误描述（客户端）

服务端需要为每一个操作添加基于ServiceExceptionDetail的错误描述，以便实现对该对象的序列化；同理，客户端同样需要这样一个错误描述，以实现对该对象的反序列化。我们可以将这样的功能通过一个自定义ChannelFactory<TChannel>来实现。下面定义的ExceptionHandlingChannelFactory就是这样一个自定的ChannelFactory<TChannel>。对错误描述的添加实现在重写的CreateDescription方法中：

using System.ServiceModel;
using System.ServiceModel.Description;

namespace Artech.EnterLibIntegration.WcfExtensions
{
    public class ExceptionHandlingChannelFactory<TChannel>:ChannelFactory<TChannel>
    {
        public ExceptionHandlingChannelFactory(string endpointConfigurationName)
            : base(endpointConfigurationName)
        { }

        protected override ServiceEndpoint CreateDescription()
        {
            ServiceEndpoint serviceEndpoint = base.CreateDescription();
            foreach (OperationDescription operation in serviceEndpoint.Contract.Operations)
            {
                FaultDescription faultDescription = new FaultDescription(ServiceExceptionDetail.FaultAction);
                faultDescription.DetailType = typeof(ServiceExceptionDetail);
                operation.Faults.Add(faultDescription);
            }

            return serviceEndpoint;
        }
    }
}

三、实例演示

那么，对其我们给出的例子，我们就要使用我们上面创建的这两个组件了。首先，有了这两个组件的帮助，在服务契约中，我们再也不需要在繁琐地为每一个服务操作定义相同的FaultContractAttribute特性了。于是我们先将其拿掉。

[ServiceContract(Namespace = "http://www.artech.com/")]
public interface ICalculator
{
    [OperationContract]
    [ExceptionHandlingBehavior("myExceptionPolicy")]
    int Divide(int x, int y);
}

然后，再进行服务寄宿的时候，直接利用我们定义的ExceptionHandlingServiceHost就可以了。

using System;
using Artech.EnterLibIntegration.WcfExtensions;
using Artech.WcfServices.Services;
namespace Artech.WcfServices.Hosting
{
    public class Program
    {
        static void Main(string[] args)
        {
            using (ExceptionHandlingServiceHost host = new ExceptionHandlingServiceHost(typeof(CalculatorService)))
            {

                host.Open();
                Console.Read();
            }
        }
    }
}

而客户端，我们可以借助于我们定义的ExceptionHandlingChannelFactory<TChannel>实现对服务代理的创建。

using System;
using Artech.EnterLibIntegration.WcfExtensions;
using Artech.WcfServices.Contracts;
namespace Artech.WcfServices.Clients
{
    class Program
    {
        static void Main(string[] args)
        {
            using (ExceptionHandlingChannelFactory<ICalculator> channelFactory = new ExceptionHandlingChannelFactory<ICalculator>(
               "calculatorservice"))
            {
                ICalculator calculator = channelFactory.CreateChannel();
                using (calculator as IDisposable)
                {
                    try
                    {
                        int result = calculator.Divide(1, 0);
                    }
                    catch (CalculationException ex)
                    {
                        Console.WriteLine(ex.Message);
                        Console.WriteLine("InnerException");
                        Console.WriteLine("\tType:{0}", ex.InnerException.GetType());
                        Console.WriteLine("\tMessage:{0}", ex.InnerException.Message);
                    }
                }
            }

            Console.Read();
        }
    }
}

这样我们同样可以得到与上篇一样的执行结果：

计算错误
InnerException
        Type:System.DivideByZeroException
        Message:试图除以零.

作者：Artech
出处：http://artech.cnblogs.com
本文版权归作者和博客园共有，欢迎转载，但未经作者同意必须保留此段声明，且在文章页面明显位置给出原文连接，否则保留追究法律责任的权利。