WCF異常處理特點體現(xiàn)
WCF的出現(xiàn),為開發(fā)人員帶來了不一樣的體驗。在很多方面都有所改變,為編程者提供了一個非常好的開發(fā)環(huán)境。比如今天為大家介紹的WCF異常處理,就有許多特殊之處,值得我們?nèi)ド钊氲难芯俊?/p>
異常消息與特定技術(shù)有關(guān),.NET異常同樣如此,因而WCF并不支持傳統(tǒng)的異常處理方式。如果在WCF服務(wù)中采用傳統(tǒng)的方式處理異常,由于異常消息不能被序列化,因而客戶端無法收到服務(wù)拋出的異常,例如這樣的服務(wù)設(shè)計:
- [ServiceContract(SessionModeSessionMode = SessionMode.Allowed)]
- public interface IDocumentsExplorerService
- {
- [OperationContract]
- DocumentList FetchDocuments(string homeDir);
- }
- [ServiceBehavior(InstanceContextModeInstanceContextMode
=InstanceContextMode.Single)]- public class DocumentsExplorerService :
IDocumentsExplorerService,IDisposable- {
- public DocumentList FetchDocuments(string homeDir)
- {
- //Some Codes
- if (Directory.Exists(homeDir))
- {
- //Fetch documents according to homedir
- }
- else
- {
- throw new DirectoryNotFoundException(
- string.Format("Directory {0} is not found.",homeDir));
- }
- }
- public void Dispose()
- {
- Console.WriteLine("The service had been disposed.");
- }
- }
則客戶端在調(diào)用如上的服務(wù)操作時,如果采用如下的捕獲方式是無法獲取該異常的:
- catch (DirectoryNotFoundException ex)
- {
- //handle the exception;
- }
為了彌補這一缺陷,WCF異常處理會將無法識別的異常均當(dāng)作為FaultException異常對象,因此,客戶端可以捕獲FaultException或者Exception異常:
- catch (FaultException ex)
- {
- //handle the exception;
- }
- catch (Exception ex)
- {
- //handle the exception;
- }
然而,這樣捕獲的異常,卻無法識別DirectoryNotFoundException所傳遞的錯誤信息。尤為嚴重的是這樣的異常處理方式還會導(dǎo)致傳遞消息的通道出現(xiàn)錯誤,當(dāng)客戶端繼續(xù)調(diào)用該服務(wù)代理對象的服務(wù)操作時,會獲得一個CommunicationObjectFaultedException異常,無法繼續(xù)使用服務(wù)。如果服務(wù)被設(shè)置為PerSession模式或者Single模式,異常還會導(dǎo)致服務(wù)對象被釋放,終止服務(wù)。
WCF異常處理專門提供了FaultContract特性,它可以被應(yīng)用到服務(wù)操作上,指明操作可能會拋出的異常類型。例如前面的服務(wù)契約就可以修改為:
- [ServiceContract(SessionModeSessionMode = SessionMode.Allowed)]
- public interface IDocumentsExplorerService
- {
- [OperationContract]
- [FaultContract(typeof(DirectoryNotFoundException))]
- DocumentList FetchDocuments(string homeDir);
- }
然而,即使通過FaultContract指定了操作要拋出的異常,然而如果服務(wù)拋出的異常并非FaultException或者FaultException<T>異常,同樣會導(dǎo)致通道發(fā)生錯誤。因此在服務(wù)實現(xiàn)中,正確的實現(xiàn)應(yīng)該如下:
- public class DocumentsExplorerService :
IDocumentsExplorerService,IDisposable- {
- public DocumentList FetchDocuments(string homeDir)
- {
- //Some Codes
- if (Directory.Exists(homeDir))
- {
- //Fetch documents according to homedir
- }
- else
- {
- DirectoryNotFoundException exception =
new DirectoryNotFoundException();- throw new FaultException<DirectoryNotFoundException>
(exception,- new FaultReason(string.Format("Directory {0}
is not found.", homeDir)));- }
- }
- }
我們可以將服務(wù)所要拋出的異常類型作為FaultException<T>的類型參數(shù),然后創(chuàng)建一個FaultReason對象用以傳遞錯誤消息??蛻舳嗽谡{(diào)用服務(wù)代理對象時,可以捕獲FaultException< DirectoryNotFoundException>異常,并且該異常不會使得通道發(fā)生錯誤,并且客戶端可以繼續(xù)使用該服務(wù)代理對象。即使服務(wù)為PerCall服務(wù),客戶端仍然可以繼續(xù)調(diào)用服務(wù)操作。如果服務(wù)為Session服務(wù)或Singleton服務(wù),那么即使發(fā)生了異常,服務(wù)對象也不會被終結(jié)。#t#
如果只是為了讓客戶端獲得異常消息,即使不施加FaultContract特性,或者拋出非FaultException異常,我們也可以通過ServiceBehavior特性,將服務(wù)的IncludeExceptionDetailInFaults設(shè)置為true(默認為false),此時,客戶端可以捕獲拋出的非FaultException異常信息,但該異常仍然會導(dǎo)致通道出現(xiàn)錯誤。
但是,在發(fā)布服務(wù)與部署服務(wù)時,我們應(yīng)避免將服務(wù)的IncludeExceptionDetailInFaults設(shè)置為true。
如果不希望使用FaultContract,同時又要保證服務(wù)拋出的WCF異常處理能夠被客戶端捕獲,并且不會導(dǎo)致通道錯誤,我們還可以通過錯誤處理擴展的方式實現(xiàn)。此時,我們可以將服務(wù)本身作為錯誤處理對象,令其實現(xiàn)System.ServiceModel.Dispatcher.IErrorHandler接口:
- public class DocumentsExplorerService :
IDocumentsExplorerService,IErrorHandler, IDisposable- {…}
在該接口的ProvideFault()方法中,可以將非FaultContract異常提升為FaultContract<T>異常,例如將DirectoryNotFoundException異常提升為FaultExceptino<DirectoryNotFoundException>異常:
- public void ProvideFault(Exception error,
MessageVersion version, ref Message fault)- {
- if (error is DirectoryNotFoundException)
- {
- FaultException<DirectoryNotFoundException> faultException =
new FaultException<DirectoryNotFoundException>(- new DirectoryNotFoundException(), new FaultReason(error.Message));
- MessageFault messageFault = faultException.CreateMessageFault();
- fault = Message.CreateMessage(version,messageFault,
faultException.Action);- }
- }
而在該接口的HandleError()方法中,則可以進行WCF異常處理,例如記錄日志。
要使得錯誤處理擴展生效,還需要向服務(wù)通道安裝錯誤處理擴展。方法是讓服務(wù)類實現(xiàn)System.ServiceModel.Description.IServiceBehavior接口:
- public class DocumentsExplorerService :
IDocumentsExplorerService,IErrorHandler,IServiceBehavior,IDisposable- {…}
然后在ApplyDispatchBehavior()方法中安裝錯誤處理擴展:
- public void ApplyDispatchBehavior(ServiceDescription
serviceDescription, ServiceHostBase serviceHostBase)- {
- foreach (ChannelDispatcher dispatcher in serviceHostBase.
ChannelDispatchers)- {
- dispatcher.ErrorHandlers.Add(this);
- }
- }
通過這樣的處理,即使服務(wù)拋出的異常為DirectoryNotFoundException異常,并且在服務(wù)契約中沒有通過FaultContract特性指定該異常,客戶端同樣能夠獲得WCF異常處理的錯誤信息,且該異常不會導(dǎo)致通道發(fā)生錯誤,客戶端可以繼續(xù)調(diào)用服務(wù)代理對象的操作。