lock 陳述式 - 確保共用資源的獨佔存取權

  • 發行項

lock 陳述式會取得指定物件的互斥鎖定、執行陳述式區塊，然後釋放鎖定。 持有鎖定時，持有鎖定的執行緒可以再次取得並釋放鎖定。 其他執行緒將無法取得鎖定，並將等待直到釋放鎖定為止。 lock 陳述式可確保任何時候最多只能有一個執行緒執行其主體。

lock 陳述式的格式如下：

lock (x)
{
    // Your code...
}

變數 x 是 System.Threading.Lock 型別的運算式，或參考型別。 當 x 在編譯時間已知為型別 System.Threading.Lock 時，它完全相當於：

using (x.EnterScope())
{
    // Your code...
}

Lock.EnterScope() 傳回的物件是包含 Dispose() 方法的 ref struct。 產生的 using 陳述式可確保即使 lock 陳述式本文擲回例外狀況，仍會釋放範圍。

否則，lock 陳述式完全相當於：

object __lockObj = x;
bool __lockWasTaken = false;
try
{
    System.Threading.Monitor.Enter(__lockObj, ref __lockWasTaken);
    // Your code...
}
finally
{
    if (__lockWasTaken) System.Threading.Monitor.Exit(__lockObj);
}

由於程式碼會使用 try-finally 陳述式，即使在 lock 陳述式的主體內擲回例外狀況，也會釋放鎖定。

您不能在 lock 陳述式主體中使用 await 運算式。

指導方針

從 .NET 9 和 C# 13 開始，鎖定 System.Threading.Lock 型別的專用物件執行個體以獲得最佳效能。 此外，如果已知 Lock 物件轉換成另一個型別並鎖定，編譯器就會發出警告。 如果使用舊版的 .NET 和 C#，請鎖定未用於其他用途的專用物件執行個體。 避免對不同的共用資源使用相同的鎖定物件執行個體，因為其可能導致鎖死或鎖定爭用。 尤其要避免使用下列執行個體當作鎖定物件：

  • this，因為呼叫端也可能鎖定 this。
  • Type 執行個體，因為這些執行個體可能會由 typeof 運算子或反映取得。
  • 字串執行個體 (包括字串常值)，因為這些執行個體可能會暫留。

盡可能縮短鎖定的時間，以減少鎖定爭用。

範例

下列範例會定義 Account 類別，該類別會透過鎖定專用的 balanceLock 執行個體來同步對其私用 balance 欄位的存取。 使用相同的執行個體進行鎖定，可確保兩個不同的執行緒無法同時呼叫 Debit 或 Credit 方法來更新 balance 欄位。 此範例使用 C# 13 和新的 Lock 物件。 如果您使用舊版 C# 或較舊的 .NET 程式庫，請鎖定 object 的執行個體。

using System;
using System.Threading.Tasks;

public class Account
{
    // Use `object` in versions earlier than C# 13
    private readonly System.Threading.Lock _balanceLock = new();
    private decimal _balance;

    public Account(decimal initialBalance) => _balance = initialBalance;

    public decimal Debit(decimal amount)
    {
        if (amount < 0)
        {
            throw new ArgumentOutOfRangeException(nameof(amount), "The debit amount cannot be negative.");
        }

        decimal appliedAmount = 0;
        lock (_balanceLock)
        {
            if (_balance >= amount)
            {
                _balance -= amount;
                appliedAmount = amount;
            }
        }
        return appliedAmount;
    }

    public void Credit(decimal amount)
    {
        if (amount < 0)
        {
            throw new ArgumentOutOfRangeException(nameof(amount), "The credit amount cannot be negative.");
        }

        lock (_balanceLock)
        {
            _balance += amount;
        }
    }

    public decimal GetBalance()
    {
        lock (_balanceLock)
        {
            return _balance;
        }
    }
}

class AccountTest
{
    static async Task Main()
    {
        var account = new Account(1000);
        var tasks = new Task[100];
        for (int i = 0; i < tasks.Length; i++)
        {
            tasks[i] = Task.Run(() => Update(account));
        }
        await Task.WhenAll(tasks);
        Console.WriteLine($"Account's balance is {account.GetBalance()}");
        // Output:
        // Account's balance is 2000
    }

    static void Update(Account account)
    {
        decimal[] amounts = [0, 2, -3, 6, -2, -1, 8, -5, 11, -6];
        foreach (var amount in amounts)
        {
            if (amount >= 0)
            {
                account.Credit(amount);
            }
            else
            {
                account.Debit(Math.Abs(amount));
            }
        }
    }
}

C# 語言規格

如需詳細資訊，請參閱 C# 語言規格的 lock 陳述式一節。

另請參閱