Статические конструкторы (Руководство по программированию в C#)

Статический конструктор используется для инициализации любых статических данных или для выполнения определенного действия, которое требуется выполнить только один раз. Он вызывается автоматически до создания первого экземпляра или ссылки на статические элементы. Статический конструктор вызывается по крайней мере один раз.

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

Инициализатор модуля может быть альтернативой статическому конструктору. Дополнительные сведения см. в спецификации для инициализаторов модулей.

Замечания

Статические конструкторы обладают следующими свойствами.

• Статический конструктор не принимает модификаторы доступа и не имеет параметров.
• Класс или структура могут иметь только один статический конструктор.
• Статические конструкторы не могут быть унаследованы или перегружены.
• Статический конструктор не может вызываться напрямую и должен вызываться только средой CLR. Он вызывается автоматически.
• Пользователь не управляет временем, в течение которого статический конструктор выполняется в программе.
• Статический конструктор вызывается автоматически. Он инициализирует класс перед созданием первого экземпляра или ссылок на какие-либо статические элементы, объявленные в этом классе (не его базовых классах). Статический конструктор выполняется раньше, чем конструктор экземпляра. Если инициализаторы статических полей присутствуют в классе статического конструктора, они выполняются в текстовом порядке, в котором они отображаются в объявлении класса. Инициализаторы выполняются непосредственно перед статическим конструктором.
• Если вы не предоставили статический конструктор для инициализации статических полей, все статические поля инициализируются значениями по умолчанию, которые указаны в разделе Значения по умолчанию типов C#.
• Если статический конструктор создает исключение, среда выполнения не вызывает его во второй раз, а тип остается неинициализируемым в течение времени существования домена приложения. Чаще всего исключение TypeInitializationException вызывается, когда статический конструктор не может создать экземпляр типа или в статическом конструкторе создается необработанное исключение. Для статических конструкторов, не определенных явным образом в исходном коде, может потребоваться проверка кода промежуточного языка (IL).
• Наличие статического конструктора не позволяет добавлять атрибут типа BeforeFieldInit. Это ограничивает возможности оптимизации во время выполнения.
• Поле, объявленное как static readonly может быть назначено только в рамках его объявления или в статическом конструкторе. Если явный статический конструктор не требуется, инициализируйте статические поля в объявлении, а не через статический конструктор, чтобы оптимизировать среду выполнения.
• Среда выполнения вызывает статический конструктор не более одного раза для каждого домена приложения. Этот вызов выполняется в заблокированном регионе на основе определенного типа класса. В тексте статического конструктора не требуются дополнительные механизмы блокировки. Чтобы избежать риска взаимоблокировки, не блокируйте текущий поток в статических конструкторах и инициализаторах. Например, не следует ожидать выполнения задач, потоков, обработчиков ожидания или событий, а также создавать блокировки или выполнять блокирующие параллельные операции, как, например, параллельные циклы, Parallel.Invoke и запросы Parallel LINQ.

Использование

• Типичным использованием статических конструкторов является случай, когда класс использует файл журнала и конструктор применяется для добавления записей в этот файл.
• Статические конструкторы также полезны при создании классов-оболочек для неуправляемого кода, когда конструктор может вызвать метод LoadLibrary.
• Статические конструкторы также удобны для применения проверок во время выполнения для параметра типа, который не может быть проверен во время компиляции с помощью ограничений типа- параметров.

Пример

В этом примере класс Bus имеет статический конструктор. При создании первого экземпляра класса Bus (bus1) для инициализации класса вызывается статический конструктор. В выходных данных этого примера можно увидеть, что статический конструктор выполняется только один раз, несмотря на то, что создается два экземпляра класса Bus. Кроме того, этот конструктор вызывается до выполнения конструктора экземпляра.

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.
*/

Спецификация языка C#

Дополнительные сведения см. в разделе Статические конструктор в спецификации языка C#.

См. также

• Система типов C#
• Конструкторы
• Статические классы и члены статических классов
• Методы завершения
• Рекомендации по разработке конструкторов
• Предупреждение системы безопасности — CA2121: статические конструкторы должны быть закрытыми
• Инициализаторы модулей