静的コンストラクター (C# プログラミング ガイド)

静的コンストラクターは、任意の静的データを初期化するため、または 1 回だけ実行する必要がある特定のアクションを実行するために使用されます。 最初のインスタンスが作成される前、または静的メンバーが参照される前に、自動的に呼び出されます。 静的コンストラクターが呼び出されるのは多くても 1 回です。

class SimpleClass
{
    // Static variable that must be initialized at run time.
    static readonly long baseline;

    // Static constructor is called at most one time, before any
    // instance constructor is invoked or member is accessed.
    static SimpleClass()
    {
        baseline = DateTime.Now.Ticks;
    }
}

静的な初期化の一部であるアクションがいくつかあります。 これらのアクションは、次の順序で実行されます。

1. 静的フィールドが 0 に設定されます。 通常、この初期化はランタイムによって行われます。
2. 静的フィールド初期化子が実行されます。 最多派生型の静的フィールド初期化子が実行されます。
3. 基本データ型の静的フィールド初期化子が実行されます。 静的フィールド初期化子は、各基本データ型から System.Object まで、直接の基底から始まります。
4. すべての静的コンストラクターが実行されます。 Object.Object の最終的な基底クラスから、型の実行を通じた各基底クラスまでの、すべての静的コンストラクター。 静的コンストラクターの実行順序は指定されていません。 ただし、階層内のすべての静的コンストラクターが、インスタンスの作成前に実行されます。

public class Singleton
{
    // Static field initializer calls instance constructor.
    private static Singleton instance = new Singleton();

    private Singleton()
    { 
        Console.WriteLine("Executes before static constructor.");
    }

    static Singleton()
    { 
        Console.WriteLine("Executes after instance constructor.");
    }

    public static Singleton Instance => instance;
}

モジュール初期化子は、静的コンストラクターの代わりに使用できます。 詳細については、モジュール初期化子の仕様を参照してください。

静的コンストラクターには、次の特徴があります。

• 静的コンストラクターにはアクセス修飾子が指定されず、パラメーターもありません。
• クラスまたは構造体は、静的コンストラクターを 1 つだけ持つことができます。
• 静的コンストラクターを継承またはオーバーロードすることはできません。
• 静的コンストラクターは、直接呼び出すことはできず、共通言語ランタイム (CLR) によって呼び出されるようになっています。 自動的に呼び出されます。
• ユーザーは、プログラムで静的コンストラクターが実行されるタイミングを制御できません。
• 静的コンストラクターは自動的に呼び出されます。 これにより、最初のインスタンスが作成される前、またはそのクラス (基底クラスではない) で宣言された静的メンバーが参照される前に、クラスが初期化されます。 静的コンストラクターは、インスタンス コンストラクターの前に実行されます。 静的フィールド変数初期化子が静的コンストラクターのクラスに存在する場合、それらはクラス宣言に出現するテキストの順序で実行されます。 初期化子は、静的コンストラクターの直前に実行されます。
• 静的フィールドを初期化するための静的コンストラクターを指定しないと、すべての静的フィールドは、「C# 型の既定値」で示されている既定値に初期化されます。
• 静的コンストラクターが例外をスローした場合、ランタイムでそれが再度呼び出されることはなく、その型は、アプリケーション ドメインの有効期間中、初期化されないままになります。 ほとんどの場合、静的コンストラクターで型をインスタンス化できないとき、または静的コンストラクター内でハンドルされない例外が発生したときは、TypeInitializationException 例外がスローされます。 ソース コードで明示的に定義されていない静的コンストラクターでは、トラブルシューティングの際に中間言語 (IL) のコードの調査が必要になる場合があります。
• 静的コンストラクターが存在すると、BeforeFieldInit 型属性を追加できません。 これにより、ランタイムの最適化が制限されます。
• static readonly として宣言されているフィールドは、その宣言の一部として、または静的コンストラクター内でのみ、割り当てることができます。 明示的な静的コンストラクターが必要ない場合は、ランタイムのより適切な最適化のため、静的コンストラクターではなく、宣言時に静的フィールドを初期化します。
• 静的コンストラクターは、ランタイムによって単一のアプリケーション ドメイン内で 1 回だけ呼び出されます。 その呼び出しは、特定の型のクラスに基づいてロックされた領域で行われます。 静的コンストラクターの本体に、追加のロック メカニズムは必要ありません。 デッドロックのリスクを回避するには、静的コンストラクターおよび初期化子内で現在のスレッドをブロックしないでください。 たとえば、タスク、スレッド、待機ハンドル、またはイベントを待機したり、ロックを取得したり、並列操作 (並列ループ、Parallel.Invoke、Parallel LINQ クエリなど) のブロックを実行したりしないでください。

• 静的コンストラクターの一般的な用途は、クラスがログ ファイルを使っていて、このファイルにエントリを書き込むためにコンストラクターが使われる場合です。
• コンストラクターが LoadLibrary メソッドを呼び出すことができる場合は、アンマネージ コードのラッパー クラスを作成するときにも静的コンストラクターが役に立ちます。
• 静的コンストラクターは、型パラメーターの制約によりコンパイル時にチェックできない型パラメーターに対して、実行時にチェックを強制するのに適した場所でもあります。

この例では、Bus クラスに静的コンストラクターがあります。 Bus の最初のインスタンスが作成されるとき (bus1)、静的コンストラクターが呼び出されてクラスが初期化されます。 サンプルの出力では、Bus のインスタンスが 2 つでも静的コンストラクターは 1 回だけ実行されること、およびインスタンス コンストラクターの実行前に静的コンストラクターが実行されることがわかります。

public class Bus
{
    // Static variable used by all Bus instances.
    // Represents the time the first bus of the day starts its route.
    protected static readonly DateTime globalStartTime;

    // Property for the number of each bus.
    protected int RouteNumber { get; set; }

    // Static constructor to initialize the static variable.
    // It is invoked before the first instance constructor is run.
    static Bus()
    {
        globalStartTime = DateTime.Now;

        // The following statement produces the first line of output,
        // and the line occurs only once.
        Console.WriteLine($"Static constructor sets global start time to {globalStartTime.ToLongTimeString()}");
    }

    // Instance constructor.
    public Bus(int routeNum)
    {
        RouteNumber = routeNum;
        Console.WriteLine($"Bus #{RouteNumber} is created.");
    }

    // Instance method.
    public void Drive()
    {
        TimeSpan elapsedTime = DateTime.Now - globalStartTime;

        // For demonstration purposes we treat milliseconds as minutes to simulate
        // actual bus times. Do not do this in your actual bus schedule program!
        Console.WriteLine($"{this.RouteNumber} is starting its route {elapsedTime.Milliseconds:N2} minutes after global start time {globalStartTime.ToShortTimeString()}.");
    }
}

class TestBus
{
    static void Main()
    {
        // The creation of this instance activates the static constructor.
        Bus bus1 = new Bus(71);

        // Create a second bus.
        Bus bus2 = new Bus(72);

        // Send bus1 on its way.
        bus1.Drive();

        // Wait for bus2 to warm up.
        System.Threading.Thread.Sleep(25);

        // Send bus2 on its way.
        bus2.Drive();

        // Keep the console window open in debug mode.
        Console.WriteLine("Press any key to exit.");
        Console.ReadKey();
    }
}
/* Sample output:
    Static constructor sets global start time to 3:57:08 PM.
    Bus #71 is created.
    Bus #72 is created.
    71 is starting its route 6.00 minutes after global start time 3:57 PM.
    72 is starting its route 31.00 minutes after global start time 3:57 PM.
*/

詳しくは、C# 言語仕様の「Static constructors (静的コンストラクター)」セクションをご覧ください。

• C# の型システム
• コンストラクター
• 静的クラスと静的クラス メンバー
• ファイナライザー
• コンストラクターのデザインのガイドライン
• セキュリティの警告 - CA2121: 静的コンストラクターはプライベートでなければなりません
• モジュールの初期化子