Costruttori statici (Guida per programmatori C#)

Un costruttore statico consente di inizializzare gli eventuali dati static oppure di eseguire un'operazione specifica che deve essere effettuata una volta sola. Viene chiamato automaticamente prima che ne venga creata la prima istanza o venga fatto riferimento a qualsiasi membro statico. Un costruttore statico viene chiamato al massimo una volta.

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;
    }
}

Esistono diverse azioni che fanno parte dell'inizializzazione statica. Tali azioni si svolgono nell'ordine seguente:

1. I campi statici sono impostati su 0. Il runtime esegue in genere questa inizializzazione.
2. Gli inizializzatori di campo statici vengono eseguiti. Inizializzatori di campo statici nell'esecuzione del tipo più derivato.
3. Gli inizializzatori di campo statici del tipo di base vengono eseguiti. Inizializzatori di campo statici che iniziano con la base diretta tramite ogni tipo di base a System.Object.
4. Tutti i costruttori statici vengono eseguiti. Tutti i costruttori statici, dalla classe di base principale Object.Object attraverso ogni classe di base fino all'esecuzione del tipo. L'ordine di esecuzione dei costruttori statici non è specificato. Tuttavia, tutti i costruttori statici nella gerarchia vengono eseguiti prima della creazione di qualunque istanza.

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;
}

Un inizializzatore di modulo può essere un'alternativa a un costruttore statico. Per altre informazioni, vedere la specifica per gli inizializzatori di modulo.

Osservazioni:

I costruttori statici hanno le proprietà seguenti:

• Un costruttore statico non accetta modificatori di accesso o ha parametri.
• Una classe o struct può avere solo un costruttore statico.
• I costruttori statici non possono essere ereditati e non è possibile eseguirne l'overload.
• Un costruttore statico non può essere chiamato direttamente ed è progettato esclusivamente per essere chiamato da Common Language Runtime (CLR). Viene richiamato automaticamente.
• L'utente non può controllare in alcun modo il momento in cui il costruttore statico viene eseguito nel programma.
• Un costruttore statico viene chiamato automaticamente. Inizializza la classe prima della creazione della prima istanza o viene fatto riferimento a tutti i membri statici dichiarati in tale classe (non le relative classi di base). Un costruttore statico viene eseguito prima di un costruttore di istanza. Se gli inizializzatori di variabili di campo statici sono presenti nella classe del costruttore statico, vengono eseguiti nell'ordine testuale in cui vengono visualizzati nella dichiarazione di classe. Gli inizializzatori vengono eseguiti immediatamente prima del costruttore statico.
• Se non si fornisce un costruttore statico per inizializzare i campi statici, tutti i campi statici vengono inizializzati sul valore predefinito, come indicato in Valori predefiniti dei tipi C#.
• Se un costruttore statico genera un'eccezione, il runtime non lo richiama una seconda volta e il tipo rimane non inizializzato per la durata del dominio applicazione. Viene più comunemente generata un'eccezione TypeInitializationException quando un costruttore statico non è in grado di creare un'istanza di un tipo o per un'eccezione non gestita che si verifica all'interno di un costruttore statico. Per i costruttori statici che non sono definiti in modo esplicito nel codice sorgente, la risoluzione dei problemi può richiedere l'ispezione del codice del linguaggio intermedio (IL).
• La presenza di un costruttore statico impedisce l'aggiunta dell'attributo di tipo BeforeFieldInit. Ciò limita l'ottimizzazione in fase di esecuzione.
• Un campo dichiarato come static readonly può essere assegnato solo come parte della relativa dichiarazione o in un costruttore statico. Quando non è richiesto un costruttore statico esplicito, inizializzare i campi statici in fase di dichiarazione, anziché tramite un costruttore statico per una migliore ottimizzazione in fase di esecuzione.
• Il runtime chiama un costruttore statico non più di una volta in un singolo dominio applicazione. Tale chiamata viene eseguita in un'area bloccata in base al tipo specifico della classe. Non sono necessari meccanismi di blocco aggiuntivi nel corpo di un costruttore statico. Per evitare il rischio di deadlock, non bloccare il thread corrente nei costruttori statici e negli inizializzatori. Ad esempio, non attendere attività, thread, handle di attesa o eventi, non acquisire blocchi e non eseguire operazioni parallele come cicli paralleli, Parallel.Invoke e query LINQ parallele.

Utilizzo

• In genere, i costruttori statici sono usati per scrivere voci nel file di log, quando alla classe è associato un file di log.
• I costruttori statici risultano utili anche durante la creazione di classi wrapper per il codice non gestito, quando il costruttore può chiamare il metodo LoadLibrary.
• I costruttori statici rappresentano anche una soluzione pratica per applicare controlli di runtime sul parametro di tipo che non possono essere controllati in fase di compilazione tramite vincoli di parametro di tipo.

Esempio

In questo esempio la classe Bus ha un costruttore statico. Quando viene creata la prima istanza di Bus (bus1), il costruttore statico viene chiamato per inizializzare la classe. L'output dell'esempio verifica che il costruttore statico venga eseguito una sola volta, anche se vengono create due istanze di Bus, e che venga eseguito prima del costruttore di istanze.

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 {0}",
            globalStartTime.ToLongTimeString());
    }

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

    // 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("{0} is starting its route {1:N2} minutes after global start time {2}.",
                                this.RouteNumber,
                                elapsedTime.Milliseconds,
                                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.
*/

Specifiche del linguaggio C#

Per altre informazioni, vedere la sezione Costruttori statici della specifica del linguaggio C#.

Vedi anche

• Sistema di tipi C#
• Costruttori
• Classi statiche e membri di classi statiche
• Finalizzatori
• Linee guida per la progettazione di costruttori
• Avviso di sicurezza - CA2121: i costruttori statici devono essere privati
• Inizializzatori del modulo