[原创]WCF技术剖析之二十一: WCF基本的异常处理模式[上篇]

由于WCF采用.NET托管语言（C#和NET）作为其主要的编程语言，注定以了基于WCF的编程方式不可能很复杂。同时，WCF设计的一个目的就是提供基于非业务逻辑的通信实现，为编程人员提供一套简单易用的应用编程接口（API）。WCF编程模式的简单性同样体现在异常处理上面，本篇文章的主要目的就是对WCF基于异常处理的编程模式做一个简单的介绍。

一、当异常从服务端抛出

对于一个典型的WCF服务调用，我个人倾向于将潜在抛出的异常费为两种类型：应用异常（Application Exception）和基础结构（Infrastructure Exception）。前者为应用级别，主要体现为执行某个服务操作的业务逻辑抛出的异常；而后者则是业务无关的，通过WCF本身的基础架构抛出，主要体现在对象的序列化、消息的处理、消息传输和消息的分发等等。在这里我们更多地关注与应用异常。

首先，我们在不做任何异常处理相关操作的情况下，看看如果在服务端执行某个服务操作的过程中抛出异常后，客户端会得到怎样的结果。我们通过实例的形式来演示这中场景。处于简单和易于理解考虑，我们照例沿用计算服务的例子。

我们照例采用典型的四层结构（Contract、Service、Hosting和Client），具体的层次在VS解决方案的划分如图1所示：

图1 异常抛出实例解决方案结构

下面代码片断表示服务契约（ICalculator）和服务类型（CalculatorService）的定义。为了简洁，在服务契约接口中，我们仅仅定义了唯一一个用于进行两个整数触发预算的方法Divide。服务契约和服务类型类型分别定义在项目Contracts和Services中。

   1: using System.ServiceModel;

<!--CRLF-->

   2: namespace Artech.WcfServices.Contracts

<!--CRLF-->

   3: {

<!--CRLF-->

   4:     [ServiceContract(Namespace = "http://www.artech.com/")]

<!--CRLF-->

   5:     public interface ICalculator

<!--CRLF-->

   6:     {

<!--CRLF-->

   7:         [OperationContract]

<!--CRLF-->

   8:         int Divide(int x, int y);

<!--CRLF-->

   9:     }   

<!--CRLF-->

  10: }

<!--CRLF-->

   1: using Artech.WcfServices.Contracts;

<!--CRLF-->

   2: namespace Artech.WcfServices.Services

<!--CRLF-->

   3: {

<!--CRLF-->

   4:     public class CalculatorService : ICalculator

<!--CRLF-->

   5:     {

<!--CRLF-->

   6:         public int Divide(int x, int y)

<!--CRLF-->

   7:         {

<!--CRLF-->

   8:             return x / y;

<!--CRLF-->

   9:         }

<!--CRLF-->

  10:     }

<!--CRLF-->

  11: }

<!--CRLF-->

接下来是通过Console应用程序（Hosting项目）对上面定义的WCF服务（CalculatorService）进行寄宿（Host）的代码和相关配置。

   1: using System;

<!--CRLF-->

   2: using System.ServiceModel;

<!--CRLF-->

   3: using Artech.WcfServices.Services;

<!--CRLF-->

   4: namespace Artech.WcfServices.Hosting

<!--CRLF-->

   5: {

<!--CRLF-->

   6:     public class Program

<!--CRLF-->

   7:     {

<!--CRLF-->

   8:         static void Main(string[] args)

<!--CRLF-->

   9:         {

<!--CRLF-->

  10:            using (ServiceHost host = new ServiceHost(typeof(CalculatorService)))

<!--CRLF-->

  11:             {

<!--CRLF-->

  12:                

<!--CRLF-->

  13:                 host.Open();

<!--CRLF-->

  14:                 Console.Read();

<!--CRLF-->

  15:             }

<!--CRLF-->

  16:         }

<!--CRLF-->

  17:     }

<!--CRLF-->

  18: }

<!--CRLF-->

   1: <?xml version="1.0" encoding="utf-8" ?>

<!--CRLF-->

   2: <configuration>  

<!--CRLF-->

   3:     <system.serviceModel> 

<!--CRLF-->

   4:         <services>

<!--CRLF-->

   5:             <service name="Artech.WcfServices.Services.CalculatorService">

<!--CRLF-->

   6:                 <endpoint address="http://127.0.0.1:3721/calculatorservice" binding="wsHttpBinding" contract="Artech.WcfServices.Contracts.ICalculator" />

<!--CRLF-->

   7:             </service>

<!--CRLF-->

   8:         </services>

<!--CRLF-->

   9:     </system.serviceModel>

<!--CRLF-->

  10: </configuration>

<!--CRLF-->

最后在代表客户端的Console应用程序（Client项目）中对计算服务CalculatorService进行调用。相关的服务调用代码和配置如下所示，为了让服务端在执行Divide操作的时候抛出异常，特意将第二个参数设置为0，以便服务在进行除法运算的时候抛出System.DivideByZeroException异常。

   1: using System;

<!--CRLF-->

   2: using System.ServiceModel;

<!--CRLF-->

   3: using Artech.WcfServices.Contracts;

<!--CRLF-->

   4: namespace Artech.WcfServices.Clients

<!--CRLF-->

   5: {

<!--CRLF-->

   6:     class Program

<!--CRLF-->

   7:     {

<!--CRLF-->

   8:         static void Main(string[] args)

<!--CRLF-->

   9:         {

<!--CRLF-->

  10:             using (ChannelFactory<ICalculator> channelFactory = new ChannelFactory<ICalculator>(

<!--CRLF-->

  11:                "calculatorservice"))

<!--CRLF-->

  12:             {

<!--CRLF-->

  13:                 ICalculator calculator = channelFactory.CreateChannel();

<!--CRLF-->

  14:                 using (calculator as IDisposable)

<!--CRLF-->

  15:                 {

<!--CRLF-->

  16:                     int result = calculator.Divide(1, 0);

<!--CRLF-->

  17:                 }

<!--CRLF-->

  18:             }

<!--CRLF-->

  19:         }

<!--CRLF-->

  20: }

<!--CRLF-->

  21: }

<!--CRLF-->

   1: <?xml version="1.0" encoding="utf-8" ?>

<!--CRLF-->

   2: <configuration>

<!--CRLF-->

   3:     <system.serviceModel>        

<!--CRLF-->

   4:        <client>         

<!--CRLF-->

   5:            <endpoint address="http://127.0.0.1:3721/calculatorservice"

<!--CRLF-->

   6:               binding="wsHttpBinding" contract="Artech.WcfServices.Contracts.ICalculator" name="calculatorservice" />

<!--CRLF-->

   7:         </client>

<!--CRLF-->

   8:     </system.serviceModel>

<!--CRLF-->

   9: </configuration>

<!--CRLF-->

在启动服务寄宿程序（Hosting）后执行客户端服务调用程序，在客户端将会跑出如图2所示的类型为System.ServiceModel.FaultException的异常，其错误消息为：

“由于内部错误，服务器无法处理该请求。有关该错误的详细信息，请打开服务器上的 IncludeExceptionDetailInFaults (从 ServiceBehaviorAttribute 或从 <serviceDebug> 配置行为)以便将异常信息发送回客户端，或在打开每个 Microsoft .NET Framework 3.0 SDK 文档的跟踪的同时检查服务器跟踪日志。”

图2 客户端捕获从服务端抛出的异常

从上面的实例演示中，我们可以获知WCF在默认情况下的异常处理行为：对于服务端抛出的异常（这里主要指应用异常），客户端捕获到的总一个具有相同异常消息的System.ServiceModel.FaultException异常。由于异常类型和消息固定不变，对于服务的客户端来说，直接通过捕获到的异常相关的信息是无法确定服务端在执行服务操作的时候遇到的具体的错误是什么。

WCF如此设计的一个主要的目的为了安全。原因很简单，由于我们不能保证服务端直接抛出的异常不包含任何敏感信息，所以直接将服务端原始的异常信息暴露给客户端（对于服务提供者来说，该客户端可能使一个不受信任或者部完全受信任的第三方）。

二、 异常细节的传输

通过上面的介绍，我们已经意识到了：在默认的情况下，如果异常（主要指应用异常）在执行服务操作的过程中抛出，其真正的异常信息并不能被客户端捕获。实际上，服务端具体的异常细节信息仅限于服务端可见，并不会传递到客户端。

然后，不论对于开发阶段的调试，还是维护阶段的纠错、排错，如果在客户端调用某个服务操作后能够很直接地获取到从服务端抛出异常的所有细节，这无疑是一件很有价值的事情。那么，WCF能够做到这一点呢？答案是肯定的。

实际上，对于细心的读者，看到客户端捕获的FaultException异常的消息，就能从中找到解决方案。消息中指出，如果试图得到服务端具体的错误信息，需要开启IncludeExceptionDetailInFaults这么一个开关。具体来讲，又具有两种等效的方式：配置的方式和应用自定义特性（Custom Attribute）的方式。

通过在服务端的配置中，为寄宿的服务定义相应的服务行为（Service Behavior），并把serviceDebug配置项的includeExceptionDetailInFaults属性设为True。具体配置如下所示：

   1: <?xml version="1.0" encoding="utf-8" ?>

<!--CRLF-->

   2: <configuration>  

<!--CRLF-->

   3:     <system.serviceModel> 

<!--CRLF-->

   4:         <behaviors>

<!--CRLF-->

   5:             <serviceBehaviors>

<!--CRLF-->

   6:                 <behavior name="serviceDebuBehavior">

<!--CRLF-->

   7:                     <serviceDebug includeExceptionDetailInFaults="true" />

<!--CRLF-->

   8:                 </behavior>

<!--CRLF-->

   9:             </serviceBehaviors>

<!--CRLF-->

  10:         </behaviors>

<!--CRLF-->

  11:         <services>

<!--CRLF-->

  12:             <service behaviorConfiguration="serviceDebuBehavior" name="Artech.WcfServices.Services.CalculatorService">

<!--CRLF-->

  13:                 <endpoint address="http://127.0.0.1:3721/calculatorservice" binding="wsHttpBinding"                    contract="Artech.WcfServices.Contracts.ICalculator" />

<!--CRLF-->