使用IDisposable檢查約束 - 瘋狂還是天才？

Question

我在今天工作的代碼庫中遇到了一個模式，最初看起來非常聰明，後來讓我瘋了，現在我想知道是否有辦法在最小化瘋狂的同時拯救聰明的部分。

我們有一堆的實施IContractObject對象，並且看起來像這樣一類InvariantChecker：

internal class InvariantChecker : IDisposable 
{ 
    private IContractObject obj; 

    public InvariantChecker(IContractObject obj) 
    { 
     this.obj = obj; 
    } 

    public void Dispose() 
    { 
     if (!obj.CheckInvariants()) 
     { 
      throw new ContractViolatedException(); 
     } 
    } 
} 

internal class Foo : IContractObject 
{ 
    private int DoWork() 
    { 
     using (new InvariantChecker(this)) 
     { 
      // do some stuff 
     } 
     // when the Dispose() method is called here, we'll throw if the work we 
     // did invalidated our state somehow 
    } 
} 

這是用來提供狀態的一致性相對容易的運行時間驗證。我沒有寫這個，但它最初似乎是一個非常酷的想法。

但是，如果Foo.DoWork引發異常，則會出現問題。拋出異常時，很可能我們處於不一致狀態，這意味着也會拋出隱藏原始異常的情況。這種情況可能會發生多次，因爲異常會在調用堆棧中傳播，每幀中的InvariantChecker會隱藏下面幀中的異常。爲了診斷問題，我必須禁用InvariantChecker中的拋出，然後才能看到原始異常。

這顯然很糟糕。然而，有沒有什麼辦法可以挽救原創想法的聰明，而不會產生可怕的異常隱藏行爲？

Answer 1

將屬性添加到InvariantChecker類中，該類允許您抑制檢查/投擲。

internal class InvariantChecker : IDisposable 
{ 
    private IContractObject obj; 

    public InvariantChecker(IContractObject obj) 
    { 
     this.obj = obj; 
    } 

    public bool Suppress { get; set; } 

    public void Dispose() 
    { 
     if (!this.Suppress) 
     { 
      if (!obj.CheckInvariants()) 
      { 
       throw new ContractViolatedException(); 
      } 
     } 
    } 
} 

internal class Foo : IContractObject 
{ 
    private int DoWork() 
    { 
     using (var checker = new InvariantChecker(this)) 
     { 
      try 
      { 
       // do some stuff 
      } 
      catch 
      { 
       checker.Suppress = true; 
       throw; 
      } 
     } 
    } 
} 

Answer 2

這是對使用模式的可怕濫用。使用模式是用於處理非託管資源，而不是像這樣的「聰明」技巧。我建議你直接寫代碼。

Answer 3

我不喜歡以這種方式重載using的含義的想法。爲什麼不用一個靜態方法來代替委託類型呢？所以，你會寫：

InvariantChecker.Check(this,() => 
{ 
    // do some stuff 
}); 

甚至更​​好，只是使它的擴展方法：

this.CheckInvariantActions(() => 
{ 
    // do some stuff 
}); 

（請注意，「這個」部分，需要爲了得到C＃編譯器看對於適用於this的擴展方法。）這也允許您使用「普通」方法來實現該操作（如果需要），並使用方法組轉換爲其創建委託。如果您有時想從身體返回，您可能還想讓它返回一個值。

現在CheckInvariantActions可以使用類似：

action(); 
if (!target.CheckInvariants()) 
{ 
    throw new ContractViolatedException(); 
} 

我也建議CheckInvariants也許應該直接拋出異常，而不是僅僅返回bool - 這樣的異常可以給有關這不變的是侵犯。

Answer 4

如果你真的要做到這一點：

internal class InvariantChecker : IDisposable 
{ 
    private IContractObject obj; 

    public InvariantChecker(IContractObject obj) 
    { 
     this.obj = obj; 
    } 

    public void Dispose() 
    { 
     if (Marshal.GetExceptionCode() != 0xCCCCCCCC && obj.CheckInvariants()) 
     { 
      throw new ContractViolatedException(); 
     } 
    } 
} 

Answer 5

如果你目前的問題是讓原始異常 - 去調試 - >異常，並檢查「拋出」對所有CLR例外。當拋出異常時它會中斷，因此你會首先看到它。如果異常從VS的角度來看「不是你的代碼」，則可能還需要關閉tools-> options-> debug - >「僅限我的代碼」選項。

Answer 6

使這個更好的是需要一個乾淨的方法來找出Dispose被調用時是否有異常。微軟應該提供一種標準化的方法來隨時查明在當前try-finally模塊退出時哪些異常（如果有）將被掛起，或者微軟應該支持擴展的Dispose接口（可能會繼承Dispose的DisposeEx）接受一個pending-exception參數。

Answer 7

取而代之的是：

using (new InvariantChecker(this)) { 
    // do some stuff 
} 

只是這樣做（假設你不從do some stuff返程）：

// do some stuff 
this.EnforceInvariants(); 

如果您需要從do some stuff回來，我相信有些refactoring是爲了：

DoSomeStuff(); // returns void 
this.EnforceInvariants(); 

... 

var result = DoSomeStuff(); // returns non-void 
this.EnforceInvariants(); 
return result; 

它更簡單，你不會遇到你以前遇到的問題。

你只需要一個簡單的擴展方法：

public static class InvariantEnforcer { 
    public static void EnforceInvariants(this IContractObject obj) { 
    if (!obj.CheckInvariants()) { 
     throw new ContractViolatedException(); 
    } 
    } 
}