C#实现Redis的分布式锁

C#实现Redis的分布式锁

概述

在分布式系统中，为了保证数据的一致性，在某个时间段内只有一个客户端能够对数据进行操作。这种机制称为分布式锁。Redis非常适合实现分布式锁的机制，以下是C#实现Redis分布式锁的详细攻略。

Redis实现分布式锁的原理

Redis实现分布式锁的原理可以概括成两个步骤：

1. 通过SETNX方法在共享资源上创建一个锁标记，创建成功则获取锁。
2. 通过EXPIRE设置锁标记的过期时间，在过期时间到达之前完成对共享资源的操作。

C#中使用Redis实现分布式锁的步骤

1. 安装StackExchange.Redis包

打开Visual Studio -> 打开Nuget包管理器 -> 在浏览选项卡中搜索StackExchange.Redis包 -> 选择安装StackExchange.Redis。

1. 编写获取分布式锁的代码

private static readonly string LockKey = "LockKey"; // 定义锁的Key
private static readonly int LockExpireTime = 60; // 定义锁的过期时间，单位：秒

public bool GetLock(string clientId)
{
    var db = GetRedisDb();
    // 根据LockKey获取锁的值，如果LockKey不存在，则设置当前客户端为锁的拥有者
    var result = db.StringSet(LockKey, clientId, TimeSpan.FromSeconds(LockExpireTime), When.NotExists);
    return result;
}

1. 编写释放分布式锁的代码

public bool ReleaseLock(string clientId)
{
    var db = GetRedisDb();
    // 释放锁：根据LockKey获取锁的值，如果锁的值和当前客户端一致，则删除锁
    var lockValue = db.StringGet(LockKey).ToString();
    if (lockValue == clientId)
    {
        db.KeyDelete(LockKey);
        return true;
    }
    return false;
}

示例说明

以下是一个简单的示例，在这个示例中，我们演示了如何在分布式系统中使用Redis实现分布式锁的机制。

示例1：并发请求同一个方法，只有一个客户端能够执行方法

代码：

private static readonly string LockKey = "LockKey"; // 定义锁的Key
private static readonly int LockExpireTime = 60; // 定义锁的过期时间，单位：秒

public void TestMethod()
{
    Console.WriteLine($"开始执行方法，线程ID：{Thread.CurrentThread.ManagedThreadId}");

    // 获取锁
    var db = GetRedisDb();
    var clientId = Guid.NewGuid().ToString(); // 获取客户端ID
    var result = db.StringSet(LockKey, clientId, TimeSpan.FromSeconds(LockExpireTime), When.NotExists);
    if (!result) // 如果获取锁失败，则返回
    {
        Console.WriteLine($"获取锁失败，线程ID：{Thread.CurrentThread.ManagedThreadId}");
        return;
    }

    try
    { 
        // 模拟方法需要执行5秒
        Thread.Sleep(5000);
        Console.WriteLine($"方法执行成功，线程ID：{Thread.CurrentThread.ManagedThreadId}");
    }
    finally
    {
        // 释放锁
        var lockValue = db.StringGet(LockKey).ToString();
        if (lockValue == clientId)
        {
            db.KeyDelete(LockKey);
            Console.WriteLine($"释放锁成功，线程ID：{Thread.CurrentThread.ManagedThreadId}");
        }
    }
}

使用上面的代码测试，输出：

开始执行方法，线程ID：1

方法执行成功，线程ID：1

释放锁成功，线程ID：1

示例2：演示两个客户端争夺锁的情况

var t1 = new Thread(() =>
{
    GetLock("Client1");
    Console.WriteLine("Client1获得了锁");
    Thread.Sleep(5000);
    ReleaseLock("Client1");
    Console.WriteLine("Client1释放了锁");
});

var t2 = new Thread(() =>
{
    var result = GetLock("Client2");
    if (result)
    {
        Console.WriteLine("Client2获得了锁");
        Thread.Sleep(5000);
        ReleaseLock("Client2");
        Console.WriteLine("Client2释放了锁");
    }
    else
    {
        Console.WriteLine("Client2没有获得锁");
    }
});

t1.Start();
t2.Start();

使用上面的代码测试，输出：

Client1获得了锁

Client2没有获得锁

Client1释放了锁

从输出结果可以看出，两个客户端争夺锁，只有一个客户端获得了锁，另一个客户端获取锁失败。