窓際プログラマーの独り言 -C#の話題を中心に

メールマガジン「C#プログラミングレッスン」では、今、[FxCopに学ぶ編] を連載中です。
そこで取上げようとしたルールで、下書きまでしたのですが、結局メルマガには書かないことにしたルールがいくつかあります。
そのまま捨ててしまうのはもったいないので、ブログに掲載します。

---

■IDisposableの実装（２）■
前回の続き
まず、なぜ、以下のクラスは、sealedを付加して継承できないようにしないと いけないのでしょうか?
前回のクラスを再度示します。

public class Sample : IDisposable { private TextReader reader; public Sample() { Stream stream = new FileStream(@"sample.txt", FileMode.Open); reader = new StreamReader(stream); } public void Exec() { Console.WriteLine(reader.ReadLine()); } public void Exec2() { string s; while ( (s = reader.ReadLine()) != null ) Console.WriteLine(s); } public void Dispose() { reader.Dispose(); } }
たとえば、Sampleを継承した、DelivedSampleを考えてみます。
このクラスにも、Dispoaseしないといけないフィールドが存在したとしましょ う。そうなると、必然的に、IDisposableインターフェースを実装しないとい けません。

public class DelivedSample : Sample, IDisposable { private DisposableClass handle; public void Dispose() { handle.Dispose(); } }
しかし、このコードは、派生元のDisposeメソッドを隠すことになってしまい ます。
これだと、派生元のTextReaderオブジェクトを破棄することができませ ん。
つまり、Sampleクラスは、継承に対応していないクラスということになり ます。sealedを付けることで、表面上はこの問題を解決することができます。

無理やりコンパイルを通したとしても、以下のようなコードを書くと、

Sample obj = new DelivedSample(); ... obj.Dispose();
ポリモーフィズムが働きませんので、派生クラスDelivedSampleのDisposeメソ ッドが呼ばれず、DelivedSampleが保持しているリソースを破棄することがで きなくなってしまいます。

では、継承にも対応したクラスをお見せしましょう。

public class DisposableType : IDisposable { private bool _disposed; // 破棄済みかどうかを示す private TextReader reader; public DisposableType() { Stream stream = new FileStream(@"sample.txt", FileMode.Open); reader = new StreamReader(stream); } protected virtual void Dispose(bool disposing) { if (!this._disposed) { if (disposing) reader.Dispose(); } _disposed = true; } public void Dispose() { Dispose(true); GC.SuppressFinalize(this); } ~DisposableType() { Dispose(false); } }
このコードの肝は、

1. 複数回、Disposeが呼ばれても問題が発生しない。
2. Finalaizeメソッド(デストラクタ）を実装することで、DIsposeを呼び出さなかった 場合でも、ガベージコレクション時にクリーンアップ処理をしている。
3. Dispose を呼び出した場合は、GC.SuppressFinalize を呼び出し、 ファイナライズメソッドの呼び出しを抑制している。
(ファイナライズでやることは、すでにDisposeでやっているから不要ということ）
4. 実際のクリーンアップ処理を受け持つ、virtualで引数ありのDisposeメソ ッドを用意している。これで継承に対応可能。

の４点です。
これは、Disposeパターンと呼ばれているものです。詳しくは、
http://msdn.microsoft.com/ja-jp/library/fs2xkftw.aspx
をご覧ください。

■FxCopのルール
CA1063: IDisposable を正しく実装します