C# 使用 AsyncEx 库的 AsyncLock 异步锁

这async几乎是lock关键字或Mutex类型的等效变量，类似于Stephen Toub的AsyncLock。它几乎是等效的，因为该lock关键字允许重新输入，而async-ready锁目前无法实现。

一种AsyncLock是采取或不。可以通过调用异步获取该锁LockAsync，并通过处理该任务的结果将其释放。AsyncLock可选CancellationToken，可以用来取消获取锁。

返回的任务在获取时LockAsync将进入Completed状态AsyncLock。Canceled如果CancellationToken在等待之前已发出信号，则该任务将进入状态；否则，任务将进入状态。在这种情况下，该AsyncLock任务不采取。

用法示例

绝大多数用例只是替换一条lock语句。也就是说，原始代码如下所示：

private readonly object _mutex = new object();
public void DoStuff()
{
  lock (_mutex)
  {
    Thread.Sleep(TimeSpan.FromSeconds(1));
  }
}

 

如果我们想Thread.Sleep用异步等效项替换阻塞操作，则由于lock阻塞而无法直接实现。我们不能await在一个内部lock。

因此，我们改用async-compatible AsyncLock：

private readonly AsyncLock _mutex = new AsyncLock();
public async Task DoStuffAsync()
{
  using (await _mutex.LockAsync())
  {
    await Task.Delay(TimeSpan.FromSeconds(1));
  }
}

使用之前先安装 Nito.AsyncEx NuGet 库，如果是 SDK 风格的项目格式，可以在 csproj 添加下面代码

<PackageReference Include="Nito.AsyncEx" Version="5.0.0" />

简单的使用方法如下

private readonly AsyncLock _mutex = new AsyncLock();

public async Task UseLockAsync()

{

using (await _mutex.LockAsync())

{

await Task.Delay(TimeSpan.FromSeconds(1));

}

}

而 AsyncLock 其实是 Nito.AsyncEx 库的基础，在 AsyncEx 库还包括了 AsyncManualResetEvent, AsyncAutoResetEvent, AsyncConditionVariable, AsyncMonitor, AsyncSemaphore, AsyncCountdownEvent 和 AsyncReaderWriterLock 的实现

 

API

// A mutual exclusion lock that is compatible with async. Note that this lock is *not* recursive!
public sealed class AsyncLock
{
  // Creates a new async-compatible mutual exclusion lock.
  public AsyncLock();
  public AsyncLock(IAsyncWaitQueue<IDisposable> queue);

  // Acquires the lock. Returns a disposable that releases the lock when disposed.
  public AwaitableDisposable<IDisposable> LockAsync(CancellationToken cancellationToken);
  public AwaitableDisposable<IDisposable> LockAsync();
  public IDisposable Lock(CancellationToken cancellationToken);
  public IDisposable Lock();

  // Gets a semi-unique identifier for this asynchronous lock.
  public int Id { get; }
}

高级用法

AsyncLock还支持该Lock方法的同步锁定。

您可以致电Lock或LockAsync与已经取消CancellationToken的尝试AsyncLock立即获取即时消息，而无需实际进入等待队列。

  真正高级用法

该AsyncLock构造可以采用异步等待队列; 传递自定义的等待队列以指定您自己的排队逻辑。在源代码中（在AdvancedExamples单元测试项目中）有两个示例：优先级锁定队列和递归锁定队列。