C＃の仮想イベント：何かがおかしい

最近、私はPVS-Studio静的アナライザーのV3119の新しいC＃-診断に取り組んでいました。 診断の目的は、仮想イベントおよびオーバーライドされたイベントの使用に関連するC＃ソースコード内の潜在的に安全でない構成を識別することです。 C＃の仮想イベントの何が問題なのか、診断がどのように機能するのか、仮想イベントやオーバーライドされたイベントの使用をマイクロソフトが推奨しない理由を把握してみましょう。

はじめに

読者はC＃の仮想性のメカニズムをよく知っていると思います。 理解する最も簡単な方法は、仮想メソッドの例です。 この場合、仮想性により、オブジェクトのランタイムのタイプに応じて、仮想メソッドのオーバーライドの1つを実行できます。 このメカニズムを簡単な例で説明します。

class A { public virtual void F() { Console.WriteLine("AF"); } public void G() { Console.WriteLine("AG"); } } class B : A { public override void F() { Console.WriteLine("BF"); } public new void G() { Console.WriteLine("BG"); } } static void Main(....) { B b = new B(); A a = b; aF(); bF(); aG(); bG(); } 

実行の結果、コンソールには以下が表示されます。

 BF BF AG BG 

すべて正しいです。 オブジェクトaとbの両方が実行時型 Bを持っているため、これらのオブジェクトの両方に対して仮想メソッドF（）を呼び出すと、クラスBのオーバーライドされたメソッドF（）が呼び出されます。一方、オブジェクトaとbはコンパイル時の型によって異なりますそれぞれ、タイプAおよびBを持ちます。 したがって、これらの各オブジェクトのG（）メソッドを呼び出すと、クラスAまたはBの対応するメソッドが呼び出されます。 virtualおよびoverrideキーワードの使用方法の詳細については、たとえばこちらをご覧ください 。

メソッド、プロパティ、インデクサーと同様に、 イベントは仮想として宣言できます。

 public virtual event .... 

これは、「シンプル」な追加イベントと削除イベントの明示的な実装の両方で実行できます。 同時に、仮想イベントを操作し、派生クラスでオーバーライドされた場合、たとえば仮想メソッドに似た動作をそれらから期待することは論理的です。 しかし、これはそうではありません。 さらに、 MSDNは仮想イベントおよびオーバーライドされたイベントの使用を明示的に推奨していません 。「基本クラスで仮想イベントを宣言したり、派生クラスでそれらをオーバーライドしたりしないでください。 C＃コンパイラはこれらを正しく処理せず、派生イベントのサブスクライバーが実際に基本クラスイベントにサブスクライブするかどうかは予測できません。

しかし、すぐにgiveめずに、「...基本クラスで仮想イベントを宣言し、派生クラスでそれらをオーバーライドする」ことを実装しようとします。

実験

最初の実験として、基本クラスの2つの仮想イベントの宣言と使用（ 追加および削除アクセサーの暗黙的および明示的な実装）を含み、これらのイベントをオーバーライドする派生クラスを含むコンソールアプリケーションを作成します。

 class Base { public virtual event Action MyEvent; public virtual event Action MyCustomEvent { add { _myCustomEvent += value; } remove { _myCustomEvent -= value; } } protected Action _myCustomEvent { get; set; } public void FooBase() { MyEvent?.Invoke(); _myCustomEvent?.Invoke(); } } class Child : Base { public override event Action MyEvent; public override event Action MyCustomEvent { add { _myCustomEvent += value; } remove { _myCustomEvent -= value; } } protected new Action _myCustomEvent { get; set; } public void FooChild() { MyEvent?.Invoke(); _myCustomEvent?.Invoke(); } } static void Main(...) { Child child = new Child(); child.MyEvent += () => Console.WriteLine("child.MyEvent handler"); child.MyCustomEvent += () => Console.WriteLine("child.MyCustomEvent handler"); child.FooChild(); child.FooBase(); } 

プログラムの結果は、コンソールに2行出力されます。

 child.MyEvent handler child.MyCustomEvent handler 

デバッガーまたはテスト出力を使用すると、 child.FooBase（）の呼び出し時に変数MyEventと_myCustomEventの両方の値がnullであり、プログラムがMyEventをトリガーしようとするときに条件付きアクセス演算子を使用することによってのみ「クラッシュ」しないことを簡単に確認できますか？.Invoke（ ）および_myCustomEvent？.Invoke（） 。

したがって、MSDNの警告は無駄ではありませんでした。 それは本当に機能しません！ 派生クラスChildのランタイムタイプを持つオブジェクトの仮想イベントをサブスクライブしても、Base基本クラスのイベントを同時にサブスクライブすることはできません。

暗黙的なイベント実装の場合、コンパイラは、サブスクライブまたはサブスクライブ解除に使用されるデリゲートフィールドと同様に、そのアクセサメソッドを自動的に追加および削除します。 問題は、明らかに、仮想イベントを使用する場合、ベースクラスと子クラスに、このイベントに関連付けられた個々の（非仮想）デリゲートフィールドがあることです。

明示的な実装の場合、これは開発者によって行われ、開発者はC＃の仮想イベントの動作のこの機能を考慮することができます。 上記の例では、 _myCustomEventデリゲートプロパティを基本クラスと派生クラスで保護されていると宣言することで、この機能を考慮しませんでした。 したがって、実際にはコンパイラーによって提供される実装を仮想イベントに対して自動的に繰り返しました。

それでも、2番目の実験を使用して、仮想イベントの予想される動作を達成しようとしましょう。 これを行うには、 追加および削除アクセサの明示的な実装と、それらに関連付けられた仮想デリゲートプロパティを使用して、仮想および再定義されたイベントを使用します。 最初の実験からプログラムのテキストを少し変更してみましょう。

 class Base { public virtual event Action MyEvent; public virtual event Action MyCustomEvent { add { _myCustomEvent += value; } remove { _myCustomEvent -= value; } } public virtual Action _myCustomEvent { get; set; } //<= virtual public void FooBase() { MyEvent?.Invoke(); _myCustomEvent?.Invoke(); } } class Child : Base { public override event Action MyEvent; public override event Action MyCustomEvent { add { _myCustomEvent += value; } remove { _myCustomEvent -= value; } } public override Action _myCustomEvent { get; set; } //<= override public void FooChild() { MyEvent?.Invoke(); _myCustomEvent?.Invoke(); } } static void Main(...) { Child child = new Child(); child.MyEvent += () => Console.WriteLine("child.MyEvent handler"); child.MyCustomEvent += () => Console.WriteLine("child.MyCustomEvent handler"); child.FooChild(); child.FooBase(); } 

プログラムの結果：

 child.MyEvent handler child.MyCustomEvent handler child.MyCustomEvent handler 

child.MyCustomEventイベントに対して2つのハンドラーイベントが発生したことに注意してください。 デバッグモードでは、 FooBase（）メソッドで_myCustomEvent？.Invoke（）を呼び出すときに、 _myCustomEventのデリゲート値がnullで はないことを簡単に判断できます 。 したがって、明示的に実装された追加アクセサーと削除アクセサーを持つイベントを使用することによってのみ、仮想イベントに期待される動作を達成することができました。

もちろん、これはすべて良いと言えますが、理論分野からのある種の合成例について話し、これらの仮想イベントと再定義されたイベントがそこに残るようにします。 私は次のコメントをします：

• 仮想イベントを使用せざるを得ない状況に陥ることがあります。 たとえば、暗黙的な実装を持つ抽象イベントが宣言されている抽象クラスから継承します。 その結果、使用している可能性のあるクラスでオーバーライドされたイベントを受け取ります。 クラスから継承してこのイベントを再定義することを決定するまで、これには危険はありません。
  
  
• そのようなデザインはまれですが、実際のプロジェクトではまだ見つかっています。 PVS-Studio静的アナライザーにV3119の C＃診断を実装した後、私はこれを確信しました。 診断ルールは、現在のクラスで使用される仮想またはオーバーライドされた暗黙的な実装イ​​ベントの宣言を探します。 安全でない状況とは、そのような構造が見つかり、クラスに相続人がいる可能性がある場合で、イベントをオーバーライドできます（ 封印されていない）。 つまり、派生クラスで仮想イベントまたは既に再定義されたイベントを再定義する状況が仮説的に可能になる場合です。 この方法で見つかった警告については、次のセクションで説明します。

実際のプロジェクトの例

PVS-Studioアナライザーの品質をテストするために、テストプロジェクトのプールを使用します。 仮想ルールおよび再定義されたイベントに新しいルールV3119をアナライザーに追加した後、プロジェクトのプール全体がチェックされました。 受け取った警告の分析について説明します。

ロズリン

PVS-Studioを使用してこのプロジェクトをチェックすることを目的とした記事がありました。 次に、仮想イベントおよびオーバーライドされたイベントに関連するアナライザーの警告をリストします。

PVS-Studioアナライザーの警告： V3119オーバーライドされたイベント「開始済み」を呼び出すと、予期しない動作が発生する場合があります。 イベントアクセサーを明示的に実装するか、「sealed」キーワードを使用することを検討してください。 GlobalOperationNotificationServiceFactory.cs 33

PVS-Studioアナライザーの警告 ： V3119オーバーライドされたイベント「停止」を呼び出すと、予期しない動作が発生する場合があります。 イベントアクセサーを明示的に実装するか、「sealed」キーワードを使用することを検討してください。 GlobalOperationNotificationServiceFactory.cs 34

 private class NoOpService : AbstractGlobalOperationNotificationService { .... public override event EventHandler Started; public override event EventHandler<GlobalOperationEventArgs> Stopped; .... public NoOpService() { .... var started = Started; //<= var stopped = Stopped; //<= } .... } 

この場合、仮想イベントの強制的な再定義の状況に対処する可能性が最も高くなります。 基本クラスAbstractGlobalOperationNotificationServiceは抽象クラスであり、 StartedおよびStopped抽象イベントの定義が含まれています。

 internal abstract class AbstractGlobalOperationNotificationService : IGlobalOperationNotificationService { public abstract event EventHandler Started; public abstract event EventHandler<GlobalOperationEventArgs> Stopped; .... } 

デリゲートは、 NoOpServiceメソッドで開始および停止されたローカル変数に単に割り当てられ、いかなる方法でも使用されないため、オーバーライドされたStartedおよびStoppedイベントのさらなる使用は完全に明確ではありません。 ただし、アナライザーが警告するため、この状況は潜在的に危険です。

シャープ開発

このプロジェクトの検証については、以前に記事で説明しました。 V3119アナライザーの警告のリストを示します。

PVS-Studioアナライザーの警告 ： V3119オーバーライドされたイベント「ParseInformationUpdated」を呼び出すと、予期しない動作が発生する場合があります。 イベントアクセサーを明示的に実装するか、「sealed」キーワードを使用することを検討してください。 CompilableProject.cs 397

 .... public override event EventHandler<ParseInformationEventArgs> ParseInformationUpdated = delegate {}; .... public override void OnParseInformationUpdated (....) { .... SD.MainThread.InvokeAsyncAndForget (delegate { ParseInformationUpdated(null, args); }); //<= } .... 

オーバーライドされた仮想イベントが検出されました。 現在のクラスから継承し、派生クラスでParseInformationUpdatedイベントを再定義すると、危険が待ち受けます。

PVS-Studioアナライザーの警告： V3119オーバーライドされたイベント「ShouldApplyExtensionsInvalidated」を呼び出すと、予期しない動作が発生する場合があります。 イベントアクセサーを明示的に実装するか、「sealed」キーワードを使用することを検討してください。 DefaultExtension.cs 127

 .... public override event EventHandler<DesignItemCollectionEventArgs> ShouldApplyExtensionsInvalidated; .... protected void ReapplyExtensions (ICollection<DesignItem> items) { if (ShouldApplyExtensionsInvalidated != null) { ShouldApplyExtensionsInvalidated(this, //<= new DesignItemCollectionEventArgs(items)); } } .... 

ここでも、オーバーライドされた仮想イベントの使用が検出されました。

宇宙エンジニア

また、このプロジェクトは以前にPVS-Studioを使用してテストされました。 検証結果は記事に記載されています 。 新しいV3119診断では、2つの警告が生成されました。

PVS-Studioアナライザーの警告： V3119仮想イベント「OnAfterComponentAdd」を呼び出すと、予期しない動作が発生する場合があります。 イベントアクセサを明示的に実装することを検討してください。 MyInventoryAggregate.cs 209

PVS-Studioアナライザーの警告： V3119仮想イベント「OnBeforeComponentRemove」を呼び出すと、予期しない動作が発生する場合があります。 イベントアクセサを明示的に実装することを検討してください。 MyInventoryAggregate.cs 218

 .... public virtual event Action<MyInventoryAggregate, MyInventoryBase> OnAfterComponentAdd; public virtual event Action<MyInventoryAggregate, MyInventoryBase> OnBeforeComponentRemove; .... public void AfterComponentAdd(....) { .... if (OnAfterComponentAdd != null) { OnAfterComponentAdd(....); // <= } } .... public void BeforeComponentRemove(....) { .... if (OnBeforeComponentRemove != null) { OnBeforeComponentRemove(....); } } .... 

ここでは、再定義されたイベントではなく、仮想イベントの宣言と使用を扱っています。 一般に、状況は以前に考慮されたものと変わりません。

Ravendb

RavenDBプロジェクトは、いわゆる「NoSQL」（またはドキュメント指向）データベースです。 詳細な説明は公式ウェブサイトで入手できます。 プロジェクトは.NETを使用して開発され、そのソースコードはGitHubで入手できます 。 PVS-StudioアナライザーによるRavenDBのチェックにより、V3119の3つの警告が明らかになりました。

PVS-Studioアナライザーの警告： V3119オーバーライドされたイベント「AfterDispose」を呼び出すと、予期しない動作が発生する場合があります。 イベントアクセサーを明示的に実装するか、「sealed」キーワードを使用することを検討してください。 DocumentStore.cs 273

PVS-Studioアナライザーの警告： V3119オーバーライドされたイベント「AfterDispose」を呼び出すと、予期しない動作が発生する場合があります。 イベントアクセサーを明示的に実装するか、「sealed」キーワードを使用することを検討してください。 ShardedDocumentStore.cs 104

これらの警告は両方とも、同様のコードスニペットに対して発行されます。 次のフラグメントのいずれかを考えてください

 public class DocumentStore : DocumentStoreBase { .... public override event EventHandler AfterDispose; .... public override void Dispose() { .... var afterDispose = AfterDispose; //<= if (afterDispose != null) afterDispose(this, EventArgs.Empty); } .... } 

DocumentStoreクラスでオーバーライドされたOverDisposeイベントは、ベースの抽象クラスDocumentStoreBaseで抽象として宣言されます。

 public abstract class DocumentStoreBase : IDocumentStore { .... public abstract event EventHandler AfterDispose; .... } 

前の例のように、 AfterDispose仮想イベントがオーバーライドされ、 DocumentStoreから派生したクラスで使用される場合、 アナライザーは潜在的な危険について警告します。

PVS-Studioアナライザーの警告： V3119仮想イベント「エラー」を呼び出すと、予期しない動作が発生する場合があります。 イベントアクセサを明示的に実装することを検討してください。 JsonSerializer.cs 1007

 .... public virtual event EventHandler<ErrorEventArgs> Error; .... internal void OnError(....) { EventHandler<ErrorEventArgs> error = Error; //<= if (error != null) error(....); } .... 

ここで、仮想イベントの発表と使用が行われます。 繰り返しますが、不確実な動作のリスクがあります。

おわりに

ここで研究を終了し、暗黙的に実装された仮想イベントを使用する価値は本当にないと結論付けます。 C＃での実装の性質により、このようなイベントを使用すると、未定義の動作が発生する可能性があります。 再定義された仮想イベントを使用する必要がある場合（たとえば、抽象クラスから継承する場合）、明示的に追加および削除するアクセサーを使用して、これを慎重に行う必要があります。 クラスまたはイベントを宣言するときに、 sealedキーワードを使用することもできます。 そしてもちろん、静的コード分析ツール、たとえばPVS-Studioを使用する必要があります。


この記事を英語圏の聴衆と共有したい場合は、翻訳へのリンクを使用してください：Sergey Khrenov。 C＃の仮想イベント：何かがおかしかった 。