DependencyObject の安全なコンストラクター パターン

  • [アーティクル]

一般的に、コンストラクターは派生クラスのコンストラクターの基底の初期化として呼び出されることがあるため、クラスのコンストラクターでは、仮想メソッドやデリゲートなどのコールバックを呼び出しません。 対象オブジェクトの初期化が不完全な状態で、仮想メソッドに入ることがあります。 ただし、プロパティ システム自体は、依存関係プロパティ システムの一部としてコールバックを呼び出し、内部的に公開します。 SetValue の呼び出しによって依存関係プロパティの値を設定するような簡単な演算には、値の決定のプロセスでコールバックが含まれる可能性があります。 このため、使用する型が基底クラスとして使われる場合に、コンストラクター本体内に依存関係プロパティ値を設定すると問題が発生する可能性があり、注意が必要です。 DependencyObject コンストラクターを実装するとき、依存関係プロパティの状態および付随するコールバックに関する特有の問題を回避するための、特定のパターンがあります。ここでは、そのパターンについて説明します。

プロパティ システムの仮想メソッド

依存関係プロパティの値を設定する SetValue の呼び出しの計算中に、ValidateValueCallback、PropertyChangedCallback、CoerceValueCallback、OnPropertyChanged の各仮想メソッドまたはコールバックが呼び出される可能性があります。 これらの仮想メソッドまたはコールバックは、Windows Presentation Foundation (WPF) のプロパティ システムと依存関係プロパティの汎用性を高めるうえで、それぞれ特定の目的を果たします。 これらの仮想メソッドを使用してプロパティ値の決定をカスタマイズする方法の詳細については、「依存関係プロパティのコールバックと検証」を参照してください。

FXCop ルールの適用とプロパティ システムの仮想メソッドの比較

ビルド プロセスの一部として Microsoft ツールの FXCop を使用している場合、基底コンストラクターを呼び出す特定の WPF フレームワーク クラスを派生させるとき、派生クラスで独自の依存関係プロパティを実装するときに、FXCop の特定のルール違反が発生することがあります。 ルール違反に該当する名前文字列は次のとおりです。

DoNotCallOverridableMethodsInConstructors

このルールは、FXCop に設定されている既定のパブリック ルールの一部です。 このルールによって報告されるのは、依存関係プロパティ システムの仮想メソッドを最終的に呼び出す、依存関係プロパティ システム内のトレースです。 このルール違反は、このトピックで説明されている推奨コンストラクター パターンに従っている場合も発生し続ける可能性があるため、FXCop のルール セット構成でこのルールを無効にするか抑制する必要があります。

既存のクラスの使用ではなくクラスの派生が大半の原因

このルールによって報告される問題は、構築のシーケンスで仮想メソッドを呼び出すように実装したクラスが派生される場合に発生します。 クラスをシールする場合、クラスが派生されないとわかっている場合、クラスが派生されないように強制する場合は、ここで説明する内容や FXCop のルールによって起こる問題は該当しません。 ただし、テンプレートや拡張可能なコントロール ライブラリのセットを作成する場合などのように、基底クラスとしての使用を想定したクラスを作成する場合は、ここで説明されているコンストラクターの推奨パターンに従う必要があります。

既定のコンストラクターにおいて、コールバックによって要求されるすべての値の初期化の必要性

任意のクラスのオーバーライドまたはコールバック (「プロパティ システムの仮想メソッド」セクションの一覧にあるコールバック) によって使用されるすべてのインスタンス メンバーは、クラスのパラメーターなしのコンストラクターで初期化する必要があります。これは、パラメーターありのコンストラクターのパラメーターによって値の一部に "実際の" 値が入る場合も同様です。

次のコード例 (および以降の例) は、この規則に違反する擬似 C# コードの例であり、問題を説明しています。

public class MyClass : DependencyObject  
{  
    public MyClass() {}  
    public MyClass(object toSetWobble)  
        : this()  
    {  
        Wobble = toSetWobble; //this is backed by a DependencyProperty  
        _myList = new ArrayList();    // this line should be in the default ctor  
    }  
    public static readonly DependencyProperty WobbleProperty =
        DependencyProperty.Register("Wobble", typeof(object), typeof(MyClass));  
    public object Wobble  
    {  
        get { return GetValue(WobbleProperty); }  
        set { SetValue(WobbleProperty, value); }  
    }  
    protected override void OnPropertyChanged(DependencyPropertyChangedEventArgs e)  
    {  
        int count = _myList.Count;    // null-reference exception  
    }  
    private ArrayList _myList;  
}

アプリケーション コードによって new MyClass(objectvalue) が呼び出されると、パラメーターなしのコンストラクターと基底クラスのコンストラクターが呼び出されます。 次に Property1 = object1 が設定されると、所有する MyClass DependencyObject で仮想メソッド OnPropertyChanged が呼び出されます。 オーバーライドでは、まだ初期化されていない _myList が参照されます。

これらの問題を回避する方法の 1 つは、コールバックが他の依存関係プロパティのみを使用し、それぞれの使用する依存関係プロパティが、登録済みのメタデータの一部として確立された既定値を持つようにすることです。

安全なコンストラクター パターン

クラスが基底クラスとして使用される場合に、不完全な初期化のリスクを回避するには、次のパターンに従ってください。

基底クラスの初期化を呼び出すパラメーターなしのコンストラクター

基底クラスの既定値を呼び出す次のコンストラクターを実装します。

public MyClass : SomeBaseClass {  
    public MyClass() : base() {  
        // ALL class initialization, including initial defaults for
        // possible values that other ctors specify or that callbacks need.  
    }  
}

基底クラスのシグネチャと一致しない、既定以外の (簡易) コンストラクター

これらのコンストラクターでパラメーターを使用して初期化の依存関係プロパティが設定される場合は、最初に初期化のための独自のクラスのパラメーターなしのコンストラクターを呼び出し、次にパラメーターを使用して依存関係プロパティを設定します。 これらは、クラスによって定義された依存関係プロパティか、基底クラスから継承された依存関係プロパティのいずれかですが、いずれの場合も次のパターンが適用されます。

public MyClass : SomeBaseClass {  
    public MyClass(object toSetProperty1) : this() {  
        // Class initialization NOT done by default.  
        // Then, set properties to values as passed in ctor parameters.  
        Property1 = toSetProperty1;  
    }  
}

基底クラスのシグネチャと一致する、既定以外の (簡易) コンストラクター

同じパラメーター化を使用して基底コンストラクターを呼び出す代わりに、独自のクラスのパラメーターなしのコンストラクターをもう一度呼び出します。 基底初期化子を呼び出さないでください。代わりに this() を呼び出す必要があります。 次に、渡されたパラメーターを関連プロパティを設定する値として使用し、元のコンストラクターの動作を複製します。 特定のパラメーターを設定するプロパティを決定する場合は、参考として元の基底コンストラクターのドキュメントを使用します。

public MyClass : SomeBaseClass {  
    public MyClass(object toSetProperty1) : this() {  
        // Class initialization NOT done by default.  
        // Then, set properties to values as passed in ctor parameters.  
        Property1 = toSetProperty1;  
    }  
}

すべてのシグネチャを一致させることが必要

基本データ型に複数のシグネチャがある場合は、追加のプロパティを設定する前に、クラスのパラメーターなしのコンストラクターを呼び出す推奨パターンを使用する独自のコンストラクター実装で、考えられるすべてのシグネチャを意図的に一致させる必要があります。

SetValue による依存関係プロパティの設定

プロパティの設定の利便性のためにラッパーを持たないプロパティを設定し、SetValue を使用して値を設定する場合は、これらの同じパターンが適用されます。 コンストラクター パラメーターを介して渡す SetValue の呼び出しでも、初期化のためのクラスのパラメーターなしのコンストラクターを呼び出す必要があります。

関連項目