Оператор SyncLockSyncLock Statement

Получает монопольную блокировку для блока операторов перед выполнением блока.Acquires an exclusive lock for a statement block before executing the block.

СинтаксисSyntax

SyncLock lockobject  
    [ block ]  
End SyncLock  

ЧастиParts

lockobject
Обязательный.Required. Выражение, результатом которого является ссылка на объект.Expression that evaluates to an object reference.

block
Необязательный.Optional. Блок инструкций, которые выполняются при получении блокировки.Block of statements that are to execute when the lock is acquired.

End SyncLock
Завершает блок SyncLock.Terminates a SyncLock block.

ЗаметкиRemarks

Оператор SyncLock гарантирует, что несколько потоков не выполняют блок инструкций одновременно.The SyncLock statement ensures that multiple threads do not execute the statement block at the same time. SyncLock предотвращает вход каждого потока в блок до тех пор, пока не будет выполнен другой поток.SyncLock prevents each thread from entering the block until no other thread is executing it.

Чаще всего SyncLock используется для защиты данных от одновременного обновления более чем одним потоком.The most common use of SyncLock is to protect data from being updated by more than one thread simultaneously. Если инструкции, управляющие данными, должны переходить к завершению без прерывания, помещайте их в блок SyncLock.If the statements that manipulate the data must go to completion without interruption, put them inside a SyncLock block.

Блок операторов, защищенный монопольной блокировкой, иногда называют критическим разделом.A statement block protected by an exclusive lock is sometimes called a critical section.

ПравилаRules

  • Ветвления.Branching. Невозможно выполнить ветвление в блок SyncLock, находящийся за пределами блока.You cannot branch into a SyncLock block from outside the block.

  • Блокировка значения объекта.Lock Object Value. Значение lockobject не может быть Nothing.The value of lockobject cannot be Nothing. Объект Lock необходимо создать до его использования в инструкции SyncLock.You must create the lock object before you use it in a SyncLock statement.

    Невозможно изменить значение lockobject при выполнении блока SyncLock.You cannot change the value of lockobject while executing a SyncLock block. Механизм требует, чтобы объект блокировки оставался без изменений.The mechanism requires that the lock object remain unchanged.

  • Оператор await нельзя использовать в блоке SyncLock.You can't use the Await operator in a SyncLock block.

ПоведениеBehavior

  • Механизм.Mechanism. Когда поток достигает оператора SyncLock, он вычисляет выражение lockobject и приостанавливает выполнение до тех пор, пока не получит монопольную блокировку на объект, возвращенный выражением.When a thread reaches the SyncLock statement, it evaluates the lockobject expression and suspends execution until it acquires an exclusive lock on the object returned by the expression. Когда другой поток достигает оператора SyncLock, он не получает блокировку до тех пор, пока первый поток не выполнит инструкцию End SyncLock.When another thread reaches the SyncLock statement, it does not acquire a lock until the first thread executes the End SyncLock statement.

  • Защищенные данные.Protected Data. Если lockobject является Shared переменной, монопольная блокировка запрещает потоку в любом экземпляре класса выполнять блок SyncLock, пока он выполняется любым другим потоком.If lockobject is a Shared variable, the exclusive lock prevents a thread in any instance of the class from executing the SyncLock block while any other thread is executing it. Это защищает данные, которые являются общими для всех экземпляров.This protects data that is shared among all the instances.

    Если lockobject является переменной экземпляра (не Shared), блокировка не дает потоку, запущенному в текущем экземпляре, выполнять блок SyncLock в то же время, что и другой поток в том же экземпляре.If lockobject is an instance variable (not Shared), the lock prevents a thread running in the current instance from executing the SyncLock block at the same time as another thread in the same instance. Это защищает данные, обслуживаемые отдельным экземпляром.This protects data maintained by the individual instance.

  • Приобретение и выпуск.Acquisition and Release. Блок SyncLock ведет себя как конструкция Try...Finally, в которой блок Try получает монопольную блокировку на lockobject, а блок Finally освобождает ее.A SyncLock block behaves like a Try...Finally construction in which the Try block acquires an exclusive lock on lockobject and the Finally block releases it. По этой причине блок SyncLock гарантирует освобождение блокировки, независимо от того, как вы выйдете из блока.Because of this, the SyncLock block guarantees release of the lock, no matter how you exit the block. Это справедливо даже в случае необработанного исключения.This is true even in the case of an unhandled exception.

  • Платформа вызывает.Framework Calls. Блок SyncLock получает и освобождает монопольную блокировку, вызывая методы Enter и Exit класса Monitor в пространстве имен System.Threading.The SyncLock block acquires and releases the exclusive lock by calling the Enter and Exit methods of the Monitor class in the System.Threading namespace.

Рекомендации по программированиюProgramming Practices

@No__t_0ное выражение всегда должно оцениваться как объект, который относится исключительно к вашему классу.The lockobject expression should always evaluate to an object that belongs exclusively to your class. Следует объявить переменную объекта Private, чтобы защитить данные, принадлежащие текущему экземпляру, или переменную объекта Private Shared, чтобы защитить данные, общие для всех экземпляров.You should declare a Private object variable to protect data belonging to the current instance, or a Private Shared object variable to protect data common to all instances.

Не следует использовать ключевое слово Me для предоставления объекта блокировки для данных экземпляра.You should not use the Me keyword to provide a lock object for instance data. Если код, внешний для класса, имеет ссылку на экземпляр класса, он может использовать эту ссылку в качестве объекта блокировки для SyncLock блока, совершенно отличного от вашего, защищая различные данные.If code external to your class has a reference to an instance of your class, it could use that reference as a lock object for a SyncLock block completely different from yours, protecting different data. Таким образом, класс и другой класс могут заблокировать друг друга от запуска несвязанных блоков SyncLock.In this way, your class and the other class could block each other from executing their unrelated SyncLock blocks. Подобная блокировка строки может быть проблематичной, так как любой другой код в процессе, использующий одну и ту же строку, будет совместно использовать одну и ту же блокировку.Similarly locking on a string can be problematic since any other code in the process using the same string will share the same lock.

Не следует также использовать метод Me.GetType для предоставления объекта блокировки для общих данных.You should also not use the Me.GetType method to provide a lock object for shared data. Это происходит потому, что GetType всегда возвращает один и тот же Type объект для заданного имени класса.This is because GetType always returns the same Type object for a given class name. Внешний код может вызвать GetType для класса и получить тот же объект блокировки, который вы используете.External code could call GetType on your class and obtain the same lock object you are using. Это приведет к тому, что два класса блокируют друг друга из блоков SyncLock.This would result in the two classes blocking each other from their SyncLock blocks.

ПримерыExamples

ОписаниеDescription

В следующем примере показан класс, который поддерживает простой список сообщений.The following example shows a class that maintains a simple list of messages. Он хранит сообщения в массиве и последнем используемом элементе этого массива в переменной.It holds the messages in an array and the last used element of that array in a variable. @No__t_0 процедура увеличивает последний элемент и сохраняет новое сообщение.The addAnotherMessage procedure increments the last element and stores the new message. Эти две операции защищаются инструкциями SyncLock и End SyncLock, так как после увеличения последнего элемента новое сообщение должно быть сохранено до того, как любой другой поток снова сможет снова увеличить последний элемент.Those two operations are protected by the SyncLock and End SyncLock statements, because once the last element has been incremented, the new message must be stored before any other thread can increment the last element again.

Если класс simpleMessageList предоставил общий список сообщений между всеми экземплярами, переменные messagesList и messagesLast будут объявлены как Shared.If the simpleMessageList class shared one list of messages among all its instances, the variables messagesList and messagesLast would be declared as Shared. В этом случае переменную messagesLock также следует Shared, чтобы в каждом экземпляре использовался один объект блокировки.In this case, the variable messagesLock should also be Shared, so that there would be a single lock object used by every instance.

КодCode

Class simpleMessageList
    Public messagesList() As String = New String(50) {}
    Public messagesLast As Integer = -1
    Private messagesLock As New Object
    Public Sub addAnotherMessage(ByVal newMessage As String)
        SyncLock messagesLock
            messagesLast += 1
            If messagesLast < messagesList.Length Then
                messagesList(messagesLast) = newMessage
            End If
        End SyncLock
    End Sub
End Class

ОписаниеDescription

В следующем примере используются потоки и SyncLock.The following example uses threads and SyncLock. Пока используется оператор SyncLock, блок операторов является критическим разделом и balance никогда не становится отрицательным числом.As long as the SyncLock statement is present, the statement block is a critical section and balance never becomes a negative number. Можно закомментировать операторы SyncLock и End SyncLock, чтобы увидеть результат выхода из ключевого слова SyncLock.You can comment out the SyncLock and End SyncLock statements to see the effect of leaving out the SyncLock keyword.

КодCode

Imports System.Threading

Module Module1

    Class Account
        Dim thisLock As New Object
        Dim balance As Integer

        Dim r As New Random()

        Public Sub New(ByVal initial As Integer)
            balance = initial
        End Sub

        Public Function Withdraw(ByVal amount As Integer) As Integer
            ' This condition will never be true unless the SyncLock statement
            ' is commented out:
            If balance < 0 Then
                Throw New Exception("Negative Balance")
            End If

            ' Comment out the SyncLock and End SyncLock lines to see
            ' the effect of leaving out the SyncLock keyword.
            SyncLock thisLock
                If balance >= amount Then
                    Console.WriteLine("Balance before Withdrawal :  " & balance)
                    Console.WriteLine("Amount to Withdraw        : -" & amount)
                    balance = balance - amount
                    Console.WriteLine("Balance after Withdrawal  :  " & balance)
                    Return amount
                Else
                    ' Transaction rejected.
                    Return 0
                End If
            End SyncLock
        End Function

        Public Sub DoTransactions()
            For i As Integer = 0 To 99
                Withdraw(r.Next(1, 100))
            Next
        End Sub
    End Class

    Sub Main()
        Dim threads(10) As Thread
        Dim acc As New Account(1000)

        For i As Integer = 0 To 9
            Dim t As New Thread(New ThreadStart(AddressOf acc.DoTransactions))
            threads(i) = t
        Next

        For i As Integer = 0 To 9
            threads(i).Start()
        Next
    End Sub

End Module

КомментарииComments

См. такжеSee also