WCF从理论到实践(10)：异常处理(转)

本文目的

通过阅读本文&＃xff0c;您能理解以下的知识

1) WCF中存在哪几种异常处理方式&＃xff1f;
2) 各种异常处理所适用的应用场合&＃xff1f;
3) WCF中常见的异常类型&＃xff1f;
4) 代码不骗人&＃xff0c;用示例来演示效果&＃xff0c;加深印象

本文适合的读者

本文适合WCF的初学者&＃xff0c;但要求对WCF有一些了解&＃xff0c;并实现过简单的服务/客户端。

WCF中存在哪几种异常处理方式&＃xff1f;

WCF定义了几种异常处理模型&＃xff0c;它们分别如下&＃xff1a;

1) 缺省模式
2) 包含详细信息模式
3) 自定义异常消息模式

各种异常处理所适用的应用场合&＃xff1f;

1) 缺省模式

缺省情况下&＃xff0c;服务端发生异常&＃xff0c;客户端会得到 一个缺省的Exception&＃xff0c;但这个Exception实例中并不包括详细的异常信息。只是告诉客户端服务端不能正常工作。在服务器和客户端模式的程序 中&＃xff0c;有些情况下&＃xff0c;服务启是不能完全信赖客户端的&＃xff0c;比如浏览器和web服务器之间&＃xff0c;为了防止非法的客户端从异常消息中获取服务端的比较详细的信息&＃xff0c;使得心怀 叵测之人有机可乘&＃xff0c;所以服务启对于异常 返回通常会比较模糊。WCF也采用了这种做法&＃xff0c;缺省情况下&＃xff0c;它返回给客户端的异常只告知我出错了&＃xff0c;但不告诉人家他哪里错了。这通常应用于客户端来源不明的 生产环境&＃xff0c;以此保护服务程序。  

2) 包含详细信息模式

如果想消息更友好一些&＃xff0c;可以通过 IncludeExceptionDetailInFaults&＃61;True来设置返回具体的异常信息&＃xff0c;这样就能告诉客户端服务出错了&＃xff0c;并指出错误出在哪 里。在程序开发阶段或者有些应用场合&＃xff0c;客户端是受信任的&＃xff0c;为了让客户端能更详尽的了解服务端到底出了什么问题&＃xff0c;WCF也支持发送详细的错误消息给客户端&＃xff0c; 这更有利于应用程序调试。而返回详细异常有两种方法&＃xff1a;第一种&＃xff1a;通过在服务端的配置文件中设置&＃xff1a;&＃xff0c;第二种方式为通过在代码中指定&＃xff1a; [ServiceBehavior(IncludeExceptionDetailInFaults&＃61;true)]

3) 自定义异常消息模式

在WCF中&＃xff0c;还支持更详细的异常消息&＃xff0c;它通 过自定义的异常消息FaultMessage来传达更多的内容。WCF采用通用的Soap Fault来处理异常&＃xff0c;并提供了FaultException和FaultException两个类型来描述和 操作异常。

WCF中常见的异常类型&＃xff1f;

WCF包括三种常见类型的异常&＃xff1a;

1) 通讯异常&＃xff0c;这通常是因为链路的原因&＃xff0c;比如服务没有启动&＃xff0c;网络阻塞等。这类异常是CommunicationException或者其派生类
2) 状态异常&＃xff0c;这类异常通常是与上文提到的实例模式相关的&＃xff0c;当访问了一个已经销毁的服务器对象时便会引发此类型的异常&＃xff0c;它们通常是ObjectDisposedException
3) 服务异常&＃xff0c;由服务端根据具体的业务逻辑触发&＃xff0c;通常是FaultException 值得注意的是当抛出服务异常的时候&＃xff0c;不同的实例模式的处理方式有所不同:

PerSession:这种模式下&＃xff0c;抛出异常&＃xff0c;服务实例将销毁&＃xff0c;客户端抛出FaultException&＃xff0c;客户端代理对象无法继续使用

PerCall:这种模式下&＃xff0c;抛出异常&＃xff0c;服务实例也将销毁。客户端代理对象无法继续使用

Single:这种模式下&＃xff0c;抛出异常&＃xff0c;服务实例会照旧运行。客户端代理无法继续使用。

代码不骗人&＃xff0c;用示例来演示效果&＃xff0c;加深印象

本文所实现的实例非常简单&＃xff0c;目的就是想验证一下各种异常处理方式下的不同表现。

1) 缺省模式

在示例中&＃xff0c;我们这样抛出异常 

public string GetWelcomeInfo([ParaAtt(CanSetNull&＃61;false)] string name) 

{ 

ParameterInfo para &＃61; MethodInfo.GetCurrentMethod().GetParameters()[0]; 

ParaAtt att &＃61; ParaAtt.GetCustomAttribute(para, typeof(ParaAtt)) as ParaAtt; 

if (!att.CanSetNull && name &＃61;&＃61; null) 

{ 

throw new Exception("参数不能设置为null"); 

} 

return "Hello," &＃43; name; 

} 

而此时&＃xff0c;我们运行客户端&＃xff0c;可以发现如下的运行结果&＃xff1a;

从结果可以看出&＃xff0c;缺省情况下&＃xff0c;虽然客户端跑出了异常&＃xff0c;但这些异常消息是不呈献给客户端的

2) 包含详细信息模式

将服务端配置文件中的&＃xff0c;再次启动&＃xff0c;此时客户端不但能收到和上图一致的跟踪堆栈信息&＃xff0c;不同的是异常消息也会呈现给客户端

3)  自定义异常消息模式

这种模式是异常处理中相对最难的&＃xff0c;因为它更加灵活&＃xff0c;我们首先定义一个用于表示错误消息的数据契约ExceptionMsg,如下&＃xff1a;

using System; 

using System.Collections.Generic; 

using System.Linq; 

using System.Text; 

using System.Runtime.Serialization; 

 

namespace Jillzhang.Wcf.ExContracts 

{ 

[DataContract] 

public class ExceptionMsg 

{ 

/// 

 

/// 异常消息文本 

/// 

 

[DataMember] 

public string Message { get; set; } 

 

/// 

 

/// 异常编码 

/// 

 

[DataMember] 

public string ErrorCode { get; set; } 

} 

} 

在定义操作的时候&＃xff0c;我们可以指定返回的异常消息的类型&＃xff0c;方法如下&＃xff1a; 

[OperationContract] 

[FaultContract(typeof(ExceptionMsg))] 

int Devide(int x, int y); 

运行实例程序&＃xff0c;可以得到如下的结果&＃xff1a;

我们可以用tcpTrace来跟踪下异常消息&＃xff0c;有关如何跟踪WCF的Soap消息&＃xff0c;前面文章WCF从理论到实践二&＃xff1a;决战紫禁之巅 有 所描述。本文讲述例外一种方法用于跟踪basicHttpBinding&＃xff0c;为此我们要准备一款工具&＃xff0c;Trace Utility&＃xff0c;它是Microsoft SOAP Toolkit Version 3中的一个工具&＃xff0c;利用它可以清晰地看到SoapMessage&＃xff0c;方式如下&＃xff1a;打开Trace Utility&＃xff0c;选择菜单项File-Formated Trace,在接下来的对话框中填写要监听的端口和服务的端口&＃xff0c;如下图所示&＃xff1a;

点击确定后&＃xff0c;将原来客户端端中的服务地址由

更改为

启动&＃xff0c;便可以在Trace Utility中跟踪到SoapMessage&＃xff0c;如下&＃xff1a;

- <s:Envelope xmlns:s&＃61;"http://schemas.xmlsoap.org/soap/envelope/"> 

- <s:Body> 

- <s:Fault> 

<faultcode>s:Clientfaultcode> 

<faultstring xml:lang&＃61;"zh-CN">The creator of this fault did not specify a Reason.faultstring> 

- <detail> 

- <ExceptionMsg xmlns&＃61;"http://schemas.datacontract.org/2004/07/Jillzhang.Wcf.ExContracts" xmlns:i&＃61;"http://www.w3.org/2001/XMLSchema-instance"> 

<ErrorCode>001ErrorCode> 

<Message>除数不能为0Message> 

ExceptionMsg> 

detail> 

s:Fault> 

s:Body> 

s:Envelope> 

另外很多人不清楚如何调试跟踪WCF应用程序&＃xff0c;特别是想从客户段跟踪到服务中&＃xff0c;可以通过以下步骤来完成&＃xff1a;

本文参考资料

1. http://www.rainsts.net/article.asp?id&＃61;430

本文示例项目&＃xff1a;

 /Files/jillzhang/Jillzhang.Wcf.ExceptionHandler.rar