WCF 從理論到實踐 (10)：異常處理三大模式深度解析

文章導讀

本文系統闡述 WCF 三種異常處理模式（預設、詳細資訊、自定義錯誤合約）、適用場景、常見異常類型，並以實戰範例驗證各模式行為差異。適合已具備 WCF 基礎的開發人員。

核心知識點

• 三種異常處理模式的機制與適用場景
• WCF 三大常見異常類型：通訊、狀態、服務異常
• 不同實例模式下拋出服務異常的實例行為差異
• 實戰驗證：預設模式 vs 詳細模式 vs 自定義 FaultContract
• SOAP 追蹤工具：tcpTrace 與 Trace Utility 實戰

一、WCF 三種異常處理模式

1. 預設模式——資訊隱藏，生產環境首選

• 客戶端僅收到通用 FaultException，無堆疊追蹤、無業務錯誤細節
• 目的：防止惡意客戶端從異常推斷伺服器內部結構（資料表、路徑、技術棧）
• 適用：公開 API、不受信任客戶端、生產環境

2. 包含詳細資訊模式——開發除錯利器

兩種啟用方式：

1. 配置檔：<serviceDebug includeExceptionDetailInFaults="true" />
2. 程式碼：[ServiceBehavior(IncludeExceptionDetailInFaults = true)]

• 客戶端收到完整例外堆疊、訊息、內部例外
• ⚠️ 嚴禁生產環境開啟，洩露敏感資訊
• 適用：開發/測試環境、受信任內部客戶端

3. 自定義異常合約——企業級標準化錯誤處理

核心機制：SOAP Fault + FaultException<TDetail>

// 1. 定義資料合約
[DataContract]
public class ExceptionMsg {
    [DataMember] public string Message { get; set; }
    [DataMember] public string ErrorCode { get; set; }
}

// 2. 服務合約標註
[OperationContract]
[FaultContract(typeof(ExceptionMsg))]
int Divide(int x, int y);

// 3. 服務端拋出
throw new FaultException<ExceptionMsg>(
    new ExceptionMsg { ErrorCode = "001", Message = "除數不能為0" },
    new FaultReason("數學運算錯誤")
);

// 4. 客戶端捕獲
catch (FaultException<ExceptionMsg> ex) {
    var detail = ex.Detail; // 強型別存取 ErrorCode、Message
}

<s:Envelope xmlns:s="https://schemas.xmlsoap.org/soap/envelope/">
  <s:Body>
    <s:Fault>
      <faultcode>s:Client</faultcode>
      <faultstring xml:lang="zh-CN">The creator of this fault did not specify a Reason.</faultstring>
      <detail>
        <ExceptionMsg xmlns="https://schemas.datacontract.org/2004/07/Jillzhang.Wcf.ExContracts">
          <ErrorCode>001</ErrorCode>
          <Message>除數不能為0</Message>
        </ExceptionMsg>
      </detail>
    </s:Fault>
  </s:Body>
</s:Envelope>