StackExchange.Redis - Использование LockTake/LockRelease

Я использую Redis с StackExchange.Redis. У меня есть несколько потоков, которые в какой-то момент будут получать доступ и редактировать значение одного и того же ключа, поэтому мне нужно синхронизировать манипуляции с данными.

Глядя на доступные функции, я вижу, что есть две функции: TakeLock и ReleaseLock. Тем не менее, эти функции принимают как ключ, так и параметр значения, а не ожидаемую единичную клавишу для блокировки. Документация и источник intellisene на GitHub не объясняют, как использовать функции LockTake и LockRelease или что нужно передать для параметров ключа и значения.

В: Какое правильное использование LockTake и LockRelease в StackExchange.Redis?

Пример псевдокода того, что я собираюсь сделать:

//Add Items Before Parallel Execution
redis.StringSet("myJSONKey", myJSON);

//Parallel Execution
Parallel.For(0, 100, i =>
    {
        //Some work here
        //....

        //Lock
        redis.LockTake("myJSONKey");

        //Manipulate
        var myJSONObject = redis.StringGet("myJSONKey");
        myJSONObject.Total++;
        Console.WriteLine(myJSONObject.Total);
        redis.StringSet("myJSONKey", myNewJSON);

        //Unlock
        redis.LockRelease("myJSONKey");

        //More work here
        //...
    });

Ответы

Ответ 1

У блокировки есть 3 части:

  • ключ (уникальное имя блокировки в базе данных)
  • значение (токен, определенный вызывающим абонентом, который может использоваться как для указания того, кто "владеет" блокировкой, так и для проверки того, что освобождение и расширение блокировки выполняется правильно).
  • продолжительность (блокировка преднамеренно является конечной продолжительностью)

Если никакое другое значение не приходит в голову, руководство может сделать подходящее "значение". Мы склонны использовать машинное имя (или измененную версию имени машины, если несколько процессов могут конкурировать на одном компьютере).

Также обратите внимание, что блокировка является спекулятивной, а не блокирующей. Вполне возможно, что вам не удалось получить блокировку, и, следовательно, вам может потребоваться проверить это и, возможно, добавить логику повторения.

Типичным примером может быть:

RedisValue token = Environment.MachineName;
if(db.LockTake(key, token, duration)) {
    try {
        // you have the lock do work
    } finally {
        db.LockRelease(key, token);
    }
}

Обратите внимание, что если работа длинна (в частности, цикл), вы можете добавить несколько случайных вызовов LockExtend в середине - снова вспомнить, чтобы проверить успех (в случае его выключения).

Обратите внимание также, что все отдельные команды redis являются атомарными, поэтому вам не нужно беспокоиться о двух конкурирующих операциях сдержанной работы. Для более сложных многооперационных блоков транзакции и сценарии являются параметрами.

Ответ 2

Есть моя часть кода для lock- > get- > modify (если требуется) → разблокировать действия с комментариями.

    public static T GetCachedAndModifyWithLock<T>(string key, Func<T> retrieveDataFunc, TimeSpan timeExpiration, Func<T, bool> modifyEntityFunc,
       TimeSpan? lockTimeout = null, bool isSlidingExpiration=false) where T : class
    {

        int lockCounter = 0;//for logging in case when too many locks per key
        Exception logException = null;

        var cache = Connection.GetDatabase();
        var lockToken = Guid.NewGuid().ToString(); //unique token for current part of code
        var lockName = key + "_lock"; //unique lock name. key-relative.
        T tResult = null;

        while ( lockCounter < 20)
        {
            //check for access to cache object, trying to lock it
            if (!cache.LockTake(lockName, lockToken, lockTimeout ?? TimeSpan.FromSeconds(10)))
            {
                lockCounter++;
                Thread.Sleep(100); //sleep for 100 milliseconds for next lock try. you can play with that
                continue;
            }

            try
            {
                RedisValue result = RedisValue.Null;

                if (isSlidingExpiration)
                {
                    //in case of sliding expiration - get object with expiry time
                    var exp = cache.StringGetWithExpiry(key);

                    //check ttl.
                    if (exp.Expiry.HasValue && exp.Expiry.Value.TotalSeconds >= 0)
                    {
                        //get only if not expired
                        result = exp.Value;
                    }
                }
                else //in absolute expiration case simply get
                {
                    result = cache.StringGet(key);
                }

                //"REDIS_NULL" is for cases when our retrieveDataFunc function returning null (we cannot store null in redis, but can store pre-defined string :) )
                if (result.HasValue && result == "REDIS_NULL") return null;
                //in case when cache is epmty
                if (!result.HasValue)
                {
                    //retrieving data from caller function (from db from example)
                    tResult = retrieveDataFunc();

                    if (tResult != null)
                    {
                        //trying to modify that entity. if caller modifyEntityFunc returns true, it means that caller wants to resave modified entity.
                        if (modifyEntityFunc(tResult))
                        {
                            //json serialization
                            var json = JsonConvert.SerializeObject(tResult);
                            cache.StringSet(key, json, timeExpiration);
                        }
                    }
                    else
                    {
                        //save pre-defined string in case if source-value is null.
                        cache.StringSet(key, "REDIS_NULL", timeExpiration);
                    }
                }
                else
                {
                    //retrieve from cache and serialize to required object
                    tResult = JsonConvert.DeserializeObject<T>(result);
                    //trying to modify
                    if (modifyEntityFunc(tResult))
                    {
                        //and save if required
                        var json = JsonConvert.SerializeObject(tResult);
                        cache.StringSet(key, json,  timeExpiration);
                    }
                }

                //refresh exiration in case of sliding expiration flag
                if(isSlidingExpiration)
                    cache.KeyExpire(key, timeExpiration);
            }
            catch (Exception ex)
            {
                logException = ex;
            }
            finally
            {                    
                cache.LockRelease(lockName, lockToken);
            }
            break;
        }

        if (lockCounter >= 20 || logException!=null)
        {
            //log it
        }

        return tResult;
    }

и использование:

public class User
{
    public int ViewCount { get; set; }
}

var cachedAndModifiedItem = GetCachedAndModifyWithLock<User>( "MyAwesomeKey", () =>
        {
            //return from db or kind of that
            return new User() { ViewCount = 0 };
        }, TimeSpan.FromMinutes(10), user=>
        {
            if (user.ViewCount< 3)
            {
                user.ViewCount++;
                return true; //save it to cache
            }
            return false; //do not update it in cache
        }, TimeSpan.FromSeconds(10),true);

Этот код можно улучшить (например, вы можете добавлять транзакции для меньшего количества вызовов в кеш и т.д.), но я рад, что это будет полезно для вас.