Lazy<T> Класс

Определение

Пространство имен:

System

Сборка:

System.Runtime.dll

Исходный код:

Lazy.cs

Обеспечивает поддержку отложенной инициализации.

generic <typename T>
public ref class Lazy

public class Lazy<T>

type Lazy<'T> = class

Public Class Lazy(Of T)

Параметры типа

T

Тип объекта, который инициализируется безумно.

Наследование

Object

Lazy<T>

Производный

System.Lazy<T,TMetadata>

Примеры

В следующем примере показано использование класса Lazy<T> для предоставления отложенной инициализации с доступом из нескольких потоков.

Заметка

В примере используется конструктор Lazy<T>(Func<T>). Он также демонстрирует использование конструктора Lazy<T>(Func<T>, Boolean) (указание true для isThreadSafe) и конструктора Lazy<T>(Func<T>, LazyThreadSafetyMode) (указание LazyThreadSafetyMode.ExecutionAndPublication для mode). Чтобы переключиться на другой конструктор, просто измените, какие конструкторы закомментированы.

Пример кэширования исключений с помощью одного конструктора см. в конструкторе Lazy<T>(Func<T>).

В этом примере определяется класс LargeObject, который будет инициализирован одним из нескольких потоков. Четыре ключевых раздела кода иллюстрируют создание инициализатора, метода фабрики, фактической инициализации и конструктора класса LargeObject, отображающего сообщение при создании объекта. В начале метода Main пример создает потокобезопасный инициализатор для LargeObject:

lazyLargeObject = new Lazy<LargeObject>(InitLargeObject);

// The following lines show how to use other constructors to achieve exactly the
// same result as the previous line:
//lazyLargeObject = new Lazy<LargeObject>(InitLargeObject, true);
//lazyLargeObject = new Lazy<LargeObject>(InitLargeObject,
//                               LazyThreadSafetyMode.ExecutionAndPublication);

let lazyLargeObject = Lazy<LargeObject> initLargeObject

// The following lines show how to use other constructors to achieve exactly the
// same result as the previous line:
//     let lazyLargeObject = Lazy<LargeObject>(initLargeObject, true)
//     let lazyLargeObject = Lazy<LargeObject>(initLargeObject,
//                               LazyThreadSafetyMode.ExecutionAndPublication)

lazyLargeObject = New Lazy(Of LargeObject)(AddressOf InitLargeObject)

' The following lines show how to use other constructors to achieve exactly the
' same result as the previous line: 
'lazyLargeObject = New Lazy(Of LargeObject)(AddressOf InitLargeObject, True)
'lazyLargeObject = New Lazy(Of LargeObject)(AddressOf InitLargeObject, _
'                               LazyThreadSafetyMode.ExecutionAndPublication)

Метод фабрики показывает создание объекта с заполнителем для дальнейшей инициализации:

static LargeObject InitLargeObject()
{
    LargeObject large = new LargeObject(Thread.CurrentThread.ManagedThreadId);
    // Perform additional initialization here.
    return large;
}

let initLargeObject () =
    let large = LargeObject Thread.CurrentThread.ManagedThreadId
    // Perform additional initialization here.
    large

Private Shared Function InitLargeObject() As LargeObject
    Dim large As New LargeObject(Thread.CurrentThread.ManagedThreadId)
    ' Perform additional initialization here.
    Return large
End Function

Обратите внимание, что первые два раздела кода можно объединить с помощью лямбда-функции, как показано ниже:

lazyLargeObject = new Lazy<LargeObject>(() =>
{
    LargeObject large = new LargeObject(Thread.CurrentThread.ManagedThreadId);
    // Perform additional initialization here.
    return large;
});

let lazyLargeObject = Lazy<LargeObject>(fun () ->
    let large = LargeObject Thread.CurrentThread.ManagedThreadId
    // Perform additional initialization here.
    large)

lazyLargeObject = New Lazy(Of LargeObject)(Function () 
    Dim large As New LargeObject(Thread.CurrentThread.ManagedThreadId) 
    ' Perform additional initialization here.
    Return large
End Function)

Пример приостанавливается, чтобы указать, что неопределенный период может пройти до отложенной инициализации. При нажатии клавиши ВВОД пример создает и запускает три потока. Метод ThreadProc, используемый всеми тремя потоками, вызывает свойство Value. При первом создании экземпляра LargeObject:

LargeObject large = lazyLargeObject.Value;

// IMPORTANT: Lazy initialization is thread-safe, but it doesn't protect the
//            object after creation. You must lock the object before accessing it,
//            unless the type is thread safe. (LargeObject is not thread safe.)
lock(large)
{
    large.Data[0] = Thread.CurrentThread.ManagedThreadId;
    Console.WriteLine("Initialized by thread {0}; last used by thread {1}.",
        large.InitializedBy, large.Data[0]);
}

let large = lazyLargeObject.Value

// IMPORTANT: Lazy initialization is thread-safe, but it doesn't protect the
//            object after creation. You must lock the object before accessing it,
//            unless the type is thread safe. (LargeObject is not thread safe.)
lock large (fun () ->
    large.Data[0] <- Thread.CurrentThread.ManagedThreadId
    printfn $"Initialized by thread {large.InitializedBy} last used by thread {large.Data[0]}.")

Dim large As LargeObject = lazyLargeObject.Value

' IMPORTANT: Lazy initialization is thread-safe, but it doesn't protect the  
'            object after creation. You must lock the object before accessing it,
'            unless the type is thread safe. (LargeObject is not thread safe.)
SyncLock large
    large.Data(0) = Thread.CurrentThread.ManagedThreadId
    Console.WriteLine("Initialized by thread {0}; last used by thread {1}.", _
        large.InitializedBy, large.Data(0))
End SyncLock

Конструктор класса LargeObject, который включает последний раздел ключа кода, отображает сообщение и записывает удостоверение инициализации потока. Выходные данные программы отображаются в конце полного списка кода.

int initBy = 0;
public LargeObject(int initializedBy)
{
    initBy = initializedBy;
    Console.WriteLine("LargeObject was created on thread id {0}.", initBy);
}

type LargeObject(initBy) =
    do 
        printfn $"LargeObject was created on thread id %i{initBy}."

Private initBy As Integer = 0
Public Sub New(ByVal initializedBy As Integer)
    initBy = initializedBy
    Console.WriteLine("LargeObject was created on thread id {0}.", initBy)
End Sub

Заметка

Для простоты в этом примере используется глобальный экземпляр Lazy<T>, а все методы static (Shared в Visual Basic). Это не требования к использованию отложенной инициализации.

using System;
using System.Threading;

class Program
{
    static Lazy<LargeObject> lazyLargeObject = null;

    static LargeObject InitLargeObject()
    {
        LargeObject large = new LargeObject(Thread.CurrentThread.ManagedThreadId);
        // Perform additional initialization here.
        return large;
    }

    static void Main()
    {
        // The lazy initializer is created here. LargeObject is not created until the
        // ThreadProc method executes.
        lazyLargeObject = new Lazy<LargeObject>(InitLargeObject);

        // The following lines show how to use other constructors to achieve exactly the
        // same result as the previous line:
        //lazyLargeObject = new Lazy<LargeObject>(InitLargeObject, true);
        //lazyLargeObject = new Lazy<LargeObject>(InitLargeObject,
        //                               LazyThreadSafetyMode.ExecutionAndPublication);

        Console.WriteLine(
            "\r\nLargeObject is not created until you access the Value property of the lazy" +
            "\r\ninitializer. Press Enter to create LargeObject.");
        Console.ReadLine();

        // Create and start 3 threads, each of which uses LargeObject.
        Thread[] threads = new Thread[3];
        for (int i = 0; i < 3; i++)
        {
            threads[i] = new Thread(ThreadProc);
            threads[i].Start();
        }

        // Wait for all 3 threads to finish.
        foreach (Thread t in threads)
        {
            t.Join();
        }

        Console.WriteLine("\r\nPress Enter to end the program");
        Console.ReadLine();
    }

    static void ThreadProc(object state)
    {
        LargeObject large = lazyLargeObject.Value;

        // IMPORTANT: Lazy initialization is thread-safe, but it doesn't protect the
        //            object after creation. You must lock the object before accessing it,
        //            unless the type is thread safe. (LargeObject is not thread safe.)
        lock(large)
        {
            large.Data[0] = Thread.CurrentThread.ManagedThreadId;
            Console.WriteLine("Initialized by thread {0}; last used by thread {1}.",
                large.InitializedBy, large.Data[0]);
        }
    }
}

class LargeObject
{
    public int InitializedBy { get { return initBy; } }

    int initBy = 0;
    public LargeObject(int initializedBy)
    {
        initBy = initializedBy;
        Console.WriteLine("LargeObject was created on thread id {0}.", initBy);
    }

    public long[] Data = new long[100000000];
}

/* This example produces output similar to the following:

LargeObject is not created until you access the Value property of the lazy
initializer. Press Enter to create LargeObject.

LargeObject was created on thread id 3.
Initialized by thread 3; last used by thread 3.
Initialized by thread 3; last used by thread 4.
Initialized by thread 3; last used by thread 5.

Press Enter to end the program
 */

open System
open System.Threading

type LargeObject(initBy) =
    do 
        printfn $"LargeObject was created on thread id %i{initBy}."
    member _.InitializedBy = initBy
    member val Data = Array.zeroCreate<int64> 100000000

let initLargeObject () =
    let large = LargeObject Thread.CurrentThread.ManagedThreadId
    // Perform additional initialization here.
    large

// The lazy initializer is created here. LargeObject is not created until the
// ThreadProc method executes.
let lazyLargeObject = Lazy<LargeObject> initLargeObject

// The following lines show how to use other constructors to achieve exactly the
// same result as the previous line:
//     let lazyLargeObject = Lazy<LargeObject>(initLargeObject, true)
//     let lazyLargeObject = Lazy<LargeObject>(initLargeObject,
//                               LazyThreadSafetyMode.ExecutionAndPublication)

let threadProc (state: obj) =
    let large = lazyLargeObject.Value

    // IMPORTANT: Lazy initialization is thread-safe, but it doesn't protect the
    //            object after creation. You must lock the object before accessing it,
    //            unless the type is thread safe. (LargeObject is not thread safe.)
    lock large (fun () ->
        large.Data[0] <- Thread.CurrentThread.ManagedThreadId
        printfn $"Initialized by thread {large.InitializedBy} last used by thread {large.Data[0]}.")

printfn """
LargeObject is not created until you access the Value property of the lazy
initializer. Press Enter to create LargeObject."""
stdin.ReadLine() |> ignore

// Create and start 3 threads, each of which uses LargeObject.

let threads = Array.zeroCreate 3
for i = 0 to 2 do
    threads[i] <- Thread(ParameterizedThreadStart threadProc)
    threads[i].Start()

// Wait for all 3 threads to finish.
for t in threads do
    t.Join()

printfn "\nPress Enter to end the program"
stdin.ReadLine() |> ignore

// This example produces output similar to the following:
//     LargeObject is not created until you access the Value property of the lazy
//     initializer. Press Enter to create LargeObject.
//     
//     LargeObject was created on thread id 3.
//     Initialized by thread 3 last used by thread 3.
//     Initialized by thread 3 last used by thread 4.
//     Initialized by thread 3 last used by thread 5.
//     
//     Press Enter to end the program

Imports System.Threading

Friend Class Program
    Private Shared lazyLargeObject As Lazy(Of LargeObject) = Nothing

    Private Shared Function InitLargeObject() As LargeObject
        Dim large As New LargeObject(Thread.CurrentThread.ManagedThreadId)
        ' Perform additional initialization here.
        Return large
    End Function


    Shared Sub Main()
        ' The lazy initializer is created here. LargeObject is not created until the 
        ' ThreadProc method executes.
        lazyLargeObject = New Lazy(Of LargeObject)(AddressOf InitLargeObject)

        ' The following lines show how to use other constructors to achieve exactly the
        ' same result as the previous line: 
        'lazyLargeObject = New Lazy(Of LargeObject)(AddressOf InitLargeObject, True)
        'lazyLargeObject = New Lazy(Of LargeObject)(AddressOf InitLargeObject, _
        '                               LazyThreadSafetyMode.ExecutionAndPublication)


        Console.WriteLine(vbCrLf & _
            "LargeObject is not created until you access the Value property of the lazy" _
            & vbCrLf & "initializer. Press Enter to create LargeObject.")
        Console.ReadLine()

        ' Create and start 3 threads, each of which uses LargeObject.
        Dim threads(2) As Thread
        For i As Integer = 0 To 2
            threads(i) = New Thread(AddressOf ThreadProc)
            threads(i).Start()
        Next i

        ' Wait for all 3 threads to finish. 
        For Each t As Thread In threads
            t.Join()
        Next t

        Console.WriteLine(vbCrLf & "Press Enter to end the program")
        Console.ReadLine()
    End Sub


    Private Shared Sub ThreadProc(ByVal state As Object)
        Dim large As LargeObject = lazyLargeObject.Value

        ' IMPORTANT: Lazy initialization is thread-safe, but it doesn't protect the  
        '            object after creation. You must lock the object before accessing it,
        '            unless the type is thread safe. (LargeObject is not thread safe.)
        SyncLock large
            large.Data(0) = Thread.CurrentThread.ManagedThreadId
            Console.WriteLine("Initialized by thread {0}; last used by thread {1}.", _
                large.InitializedBy, large.Data(0))
        End SyncLock
    End Sub
End Class

Friend Class LargeObject
    Public ReadOnly Property InitializedBy() As Integer
        Get
            Return initBy
        End Get
    End Property

    Private initBy As Integer = 0
    Public Sub New(ByVal initializedBy As Integer)
        initBy = initializedBy
        Console.WriteLine("LargeObject was created on thread id {0}.", initBy)
    End Sub

    Public Data(99999999) As Long
End Class

' This example produces output similar to the following:
'
'LargeObject is not created until you access the Value property of the lazy
'initializer. Press Enter to create LargeObject.
'
'LargeObject was created on thread id 3.
'Initialized by thread 3; last used by thread 3.
'Initialized by thread 3; last used by thread 5.
'Initialized by thread 3; last used by thread 4.
'
'Press Enter to end the program
'

Комментарии

Используйте отложенную инициализацию, чтобы отложить создание большого или ресурсоемкого объекта, или выполнение ресурсоемкой задачи, особенно если такое создание или выполнение может не произойти во время существования программы.

Чтобы подготовиться к отложенной инициализации, создайте экземпляр Lazy<T>. Аргумент типа создаваемого объекта Lazy<T> указывает тип объекта, который требуется инициализировать. Конструктор, используемый для создания объекта Lazy<T>, определяет характеристики инициализации. Отложенная инициализация происходит при первом доступе к свойству Lazy<T>.Value.

В большинстве случаев выбор конструктора зависит от ответов на два вопроса:

• Будет ли доступ к неявно инициализированному объекту из нескольких потоков? В этом случае объект Lazy<T> может создать его в любом потоке. Вы можете использовать один из простых конструкторов, поведение которых по умолчанию — создать потокобезопасный объект Lazy<T>, чтобы создать только один экземпляр неявного экземпляра объекта независимо от того, сколько потоков пытается получить к нему доступ. Чтобы создать объект Lazy<T>, который не является потокобезопасной, необходимо использовать конструктор, позволяющий указывать безопасность потока.

  Осторожность

  Обеспечение безопасного потока объектов Lazy<T> не защищает лениво инициализированный объект. Если несколько потоков могут получить доступ к неявно инициализированному объекту, необходимо сделать его свойства и методы безопасными для многопоточного доступа.

• Требуется ли отложенное инициализация большого количества кода или неуклюжий инициализированный объект имеет конструктор без параметров, который делает все, что вам нужно, и не выдает исключений? Если необходимо написать код инициализации или если необходимо обработать исключения, используйте один из конструкторов, который принимает метод фабрики. Напишите код инициализации в методе фабрики.

В следующей таблице показано, какой конструктор следует выбрать на основе этих двух факторов:

Доступ к объекту будет осуществляться с помощью	Если код инициализации не требуется (конструктор без параметров), используйте	Если требуется код инициализации, используйте
Несколько потоков	Lazy<T>()	Lazy<T>(Func<T>)
Один поток	Lazy<T>(Boolean) с isThreadSafe для false.	Lazy<T>(Func<T>, Boolean) с isThreadSafe для false.

Для указания метода фабрики можно использовать лямбда-выражение. Это сохраняет весь код инициализации в одном месте. Лямбда-выражение фиксирует контекст, включая все аргументы, которые вы передаете конструктору неявного инициализированного объекта.

кэширование исключений При использовании методов фабрики исключения кэшируются. То есть, если метод фабрики создает исключение при первом попытке потока получить доступ к свойству Value объекта Lazy<T>, то при каждой последующей попытке возникает то же исключение. Это гарантирует, что каждый вызов свойства Value создает один и тот же результат и позволяет избежать тонких ошибок, которые могут возникнуть, если разные потоки получают разные результаты. Lazy<T> означает фактическую T, которая в противном случае была бы инициализирована в какой-то более ранний момент, как правило, во время запуска. Сбой в этой более ранней точке обычно неустраним. Если существует потенциал для восстановления, рекомендуется создать логику повторных попыток в подпрограмму инициализации (в данном случае метод фабрики), так же, как и если бы вы не использовали отложенную инициализацию.

Альтернатива блокировке В некоторых ситуациях может потребоваться избежать затрат на поведение блокировки Lazy<T> объекта по умолчанию. В редких ситуациях может возникнуть взаимоблокировка. В таких случаях можно использовать конструктор Lazy<T>(LazyThreadSafetyMode) или Lazy<T>(Func<T>, LazyThreadSafetyMode) и указать LazyThreadSafetyMode.PublicationOnly. Это позволяет объекту Lazy<T> создать копию неявного инициализированного объекта на каждом из нескольких потоков, если потоки вызывают свойство Value одновременно. Объект Lazy<T> гарантирует, что все потоки используют один и тот же экземпляр неявного инициализированного объекта и удаляет экземпляры, которые не используются. Таким образом, стоимость снижения затрат на блокировку заключается в том, что программа иногда может создавать и удалять дополнительные копии дорогостоящих объектов. В большинстве случаев это маловероятно. Примеры для конструкторов Lazy<T>(LazyThreadSafetyMode) и Lazy<T>(Func<T>, LazyThreadSafetyMode) демонстрируют это поведение.

Важный

При указании LazyThreadSafetyMode.PublicationOnlyисключения никогда не кэшируются, даже если указать метод фабрики.

Эквивалентные конструкторы помимо включения использования LazyThreadSafetyMode.PublicationOnlyконструкторы Lazy<T>(LazyThreadSafetyMode) и Lazy<T>(Func<T>, LazyThreadSafetyMode) могут дублировать функциональные возможности других конструкторов. В следующей таблице показаны значения параметров, которые создают эквивалентное поведение.

Создание объекта Lazy<T>, который является	Для конструкторов с параметром LazyThreadSafetyModemode задайте для mode значение	Для конструкторов, имеющих логический параметр isThreadSafe, задайте для isThreadSafe значение	Для конструкторов без параметров безопасности потока
Полностью потокобезопасно; использует блокировку, чтобы гарантировать, что только один поток инициализирует значение.	ExecutionAndPublication	true	Все такие конструкторы являются полностью потокобезопасны.
Не является потокобезопасной.	None	false	Неприменимо.
Полностью потокобезопасно; Гонки потоков для инициализации значения.	PublicationOnly	Неприменимо.	Неприменимо.

Другие возможности Сведения об использовании со статическими полями потока или в качестве резервного хранилища свойств см. инициализации с отложенной инициализацией.

Конструкторы

Lazy<T>()	Инициализирует новый экземпляр класса Lazy<T>. При отложенной инициализации используется конструктор без параметров целевого типа.
Lazy<T>(Boolean)	Инициализирует новый экземпляр класса Lazy<T>. При отложенной инициализации используется конструктор без параметров целевого типа и указанный режим инициализации.
Lazy<T>(Func<T>)	Инициализирует новый экземпляр класса Lazy<T>. При отложенной инициализации используется указанная функция инициализации.
Lazy<T>(Func<T>, Boolean)	Инициализирует новый экземпляр класса Lazy<T>. При отложенной инициализации используются указанные функции и инициализации и режим инициализации.
Lazy<T>(Func<T>, LazyThreadSafetyMode)	Инициализирует новый экземпляр класса Lazy<T>, использующего указанную функцию инициализации и режим безопасности потока.
Lazy<T>(LazyThreadSafetyMode)	Инициализирует новый экземпляр класса Lazy<T>, использующего конструктор без параметров T и указанный режим безопасности потока.
Lazy<T>(T)	Инициализирует новый экземпляр класса Lazy<T>, использующего предварительно инициализированное указанное значение.

Свойства

IsValueCreated	Возвращает значение, указывающее, было ли создано значение для этого Lazy<T> экземпляра.
Value	Возвращает неявное инициализированное значение текущего экземпляра Lazy<T>.

Методы

Equals(Object)	Определяет, равен ли указанный объект текущему объекту. (Унаследовано от Object)
GetHashCode()	Служит хэш-функцией по умолчанию. (Унаследовано от Object)
GetType()	Возвращает Type текущего экземпляра. (Унаследовано от Object)
MemberwiseClone()	Создает неглубокую копию текущей Object. (Унаследовано от Object)
ToString()	Создает и возвращает строковое представление свойства Value для этого экземпляра.

Потокобезопасность

По умолчанию все общедоступные и защищенные члены класса Lazy<T> являются потокобезопасными и могут использоваться одновременно из нескольких потоков. Эти гарантии безопасности потоков могут быть удалены при необходимости и на экземпляр с помощью параметров конструкторов типа.

См. также раздел

• LazyThreadSafetyMode
• инициализация отложенного
• "Отложенные выражения" (F#)