C# SyncRoot：获取可用于同步对集合的访问的对象

C# SyncRoot 完整攻略

什么是 C# SyncRoot

在 C# 中，SyncRoot 是一个实现了 ICollection 接口的对象的同步根对象。它通常是一个对象，用来充当锁。

可以通过以下代码将 SyncRoot 属性访问锁对象：

ICollection myCollection = ...;
object myLock = myCollection.SyncRoot;

为什么要使用 SyncRoot

在进行多线程操作时，使用集合的 Add、Remove、CopyTo 等方法可能会抛出异常，因为多个线程同时访问同一个集合可能会产生竞争条件。为了在多个线程之间保持同步，可以使用 SyncRoot 来同步对集合的访问。

使用 SyncRoot 必须在操作 ICollection 对象之前获取锁，然后在操作完成后释放锁。

使用 SyncRoot 的示例

示例 1：使用 SyncRoot 同步对集合的访问

下面的代码演示了如何使用 SyncRoot 同步对集合的访问：

// 创建一个 Hashtable 对象
Hashtable myHashtable = new Hashtable();

// 初始化 Hashtable 
myHashtable.Add(1, "one");
myHashtable.Add(2, "two");
myHashtable.Add(3, "three");

// 获取 SyncRoot 锁对象
object syncRoot = myHashtable.SyncRoot;

lock (syncRoot)
{
    // 通过 SyncRoot 安全地访问集合
    foreach (DictionaryEntry entry in myHashtable)
    {
        Console.WriteLine($"{entry.Key}: {entry.Value}");
    }
}

示例 2：在多线程环境下使用 SyncRoot

下面的代码演示了如何在多线程环境下使用 SyncRoot 安全地增加集合中的元素：

// 创建一个线程安全的 ArrayList
ArrayList myList = ArrayList.Synchronized(new ArrayList());

// 获取 SyncRoot 锁对象
object syncRoot = myList.SyncRoot;

// 创建多个添加元素的线程
for (int i = 0; i < 5; i++)
{
    Thread thread = new Thread(() =>
    {
        lock(syncRoot)
        {
            myList.Add(Thread.CurrentThread.ManagedThreadId);
            Console.WriteLine($"Added {Thread.CurrentThread.ManagedThreadId}");
        }
    });

    thread.Start();
}

Thread.Sleep(1000);
Console.WriteLine("Final Contents:");
foreach (var item in myList)
{
    Console.WriteLine(item);
}

在该示例中，我们使用 ArrayList.Synchronized 方法创建了一个线程安全的集合，然后使用 SyncRoot 锁定了集合访问。我们启动了多个线程，每个线程都向集合中添加一个元素。由于 SyncRoot 对象被锁定，线程会按顺序进行添加操作，最终集合中的元素数量会增加至 5。