dotnet 里的那些锁 AutoResetEvent 用法

本文告诉大家在 dotnet 里的 AutoResetEvent 锁的用法

用法

使用 WaitOne 等待，使用 Set 让等待的逻辑继续执行

        private static void Foo(AutoResetEvent autoResetEvent)
        {
            Task.Run(() =>
            {
                while (true)
                {
                    autoResetEvent.WaitOne();

                    Console.WriteLine("Foo");
                }
            });
        }

        static void Main(string[] args)
        {
            var autoResetEvent = new AutoResetEvent(false);

            Foo(autoResetEvent);

            autoResetEvent.Set();

            Console.Read();
        }

作用

多次调用 Set 时，只有同一时间的 WaitOne 执行，如以下代码

        static void Main(string[] args)
        {
            var autoResetEvent = new AutoResetEvent(false);

            Foo(autoResetEvent);

            autoResetEvent.Set();

            for (int i = 0; i < 10; i++)
            {
                autoResetEvent.Set();
            }

            Console.Read();
        }

上面代码放在github欢迎小伙伴访问

在 for 里面做快速的释放，而 Foo 则是本文上面的方法，只会输出一次 Foo 执行一次

因此 AutoResetEvent 能做到多次设置执行，最终只有一次执行

在 WaitOne 执行之前，无论使用 Set 多少次，最终只能执行一次 WaitOne 方法

因此，如果在 WaitOne 执行之后，再次调用 Set 方法，那么将会继续让其他的 WaitOne 执行。下面代码在 Set 方法之后调用Thread.Sleep方法，让 Foo 方法的线程 WaitOne 执行

            for (int i = 0; i < 10; i++)
            {
                autoResetEvent.Set();
                Thread.Sleep(100);
            }

上面代码放在github欢迎小伙伴访问

如果有多个线程同时等待 WaitOne 方法，那么调用 Set 方法，只有一个线程执行。如果同时多次调用 Set 方法，最终也只有一次 WaitOne 之后的逻辑执行。只有在 WaitOne 通过之后的 Set 方法，才会让下一个 WaitOne 执行

如复制 Foo 方法，更改命名为 Foo2 方法，然后修改输出为 Foo2 在主函数执行

        static void Main(string[] args)
        {
            var autoResetEvent = new AutoResetEvent(false);

            Foo(autoResetEvent);
            Foo2(autoResetEvent);

            autoResetEvent.Set();

            for (int i = 0; i < 10; i++)
            {
                autoResetEvent.Set();
                Thread.Sleep(100);
            }

            Console.Read();
        }

        private static void Foo2(AutoResetEvent autoResetEvent)
        {
            Task.Run(() =>
            {
                while (true)
                {
                    autoResetEvent.WaitOne();

                    Console.WriteLine("Foo2");
                }
            });
        }

上面代码让 Foo 和 Foo2 两个方法进入 WaitOne 方法，而执行输出每次只有一个线程执行，运行代码可以看到输出是

Foo2
Foo
Foo2
Foo
Foo2
Foo
Foo2
Foo
Foo2
Foo

其中的 Set 调用了 11 次，但是第一次和第二次是合并执行，于是 WaitOne 实际只执行了 10 次。分别给 Foo 和 Foo2 两个方法执行

上面代码放在github欢迎小伙伴访问

异步锁

以上 AutoResetEvent 类将会占用线程，没有提供异步的方法。如果想要 AsyncAutoResetEvent 请使用 dotnet-campus/AsyncWorkerCollection: 多线程异步工具开源仓库的方法

通过 NuGet 安装 dotnetCampus.AsyncWorkerCollection 库，如果是 SDK 风格的 csproj 文件，可以添加如下代码

<PackageReference Include="dotnetCampus.AsyncWorkerCollection" Version="1.1.6" />

当然，不想添加多一个 dll 的小伙伴，可以采用源代码版本，以下 NuGet 包是通过 SourceYard 创建的源代码 NuGet 包，安装 NuGet 包将相当于将代码拷贝到项目

dotnet add package dotnetCampus.AsyncWorkerCollection.Source --version 1.1.6

如果是 SDK 风格的 csproj 文件，可以添加如下代码

<PackageReference Include="dotnetCampus.AsyncWorkerCollection.Source" Version="1.1.6">
  <PrivateAssets>all</PrivateAssets>
  <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
</PackageReference>

使用 AsyncAutoResetEvent 可以将 WaitOne 替换为 WaitOneAsync 方法