Benutzerdefinierte Redis-Befehle

Wenn Sie auf die Verwendung eines neuen Redis-Befehls warten, müssen Sie meistens auf eine aktualisierte Version von ServiceStack.Redis warten Um Unterstützung für die neuen Befehle hinzuzufügen, gibt es Zeiten, in denen der Redis-Client nicht alle Permutationen anbietet, die redis-server unterstützt.

Mit dem neuen Custom und RawCommand APIs auf IRedisClient und IRedisNativeClient Sie können jetzt den RedisClient verwenden, um Ihre eigenen benutzerdefinierten Befehle zu senden, die Ad-hoc-Redis-Befehle aufrufen können:

public interface IRedisClient
{
    ...
    RedisText Custom(params object[] cmdWithArgs);
}

public interface IRedisNativeClient
{
    ...
    RedisData RawCommand(params object[] cmdWithArgs);
    RedisData RawCommand(params byte[][] cmdWithBinaryArgs);
}

Diese benutzerdefinierten APIs verwenden ein flexibles object[] Argumente, die jeden serialisierbaren Wert akzeptieren, z. byte[] , string , int sowie alle benutzerdefinierten komplexen Typen, die transparent als JSON serialisiert und als UTF-8-Bytes über die Leitung gesendet werden.

var ret = Redis.Custom("SET", "foo", 1);          // ret.Text = "OK"

byte[] cmdSet = Commands.Set;
ret = Redis.Custom(cmdSet, "bar", "b");           // ret.Text = "OK"

ret = Redis.Custom("GET", "foo");                 // ret.Text = "1"

Es gibt auch bequeme Erweiterungsmethoden auf RedisData und RedisText die den Zugriff auf strukturierte Daten erleichtern, z. B.:

var ret = Redis.Custom(Commands.Keys, "*");
var keys = ret.GetResults();                      // keys = ["foo", "bar"]

ret = Redis.Custom(Commands.MGet, "foo", "bar");
var values = ret.GetResults();                    // values = ["1", "b"]

Enum.GetNames(typeof(DayOfWeek)).ToList()
    .ForEach(x => Redis.Custom(Commands.RPush, "DaysOfWeek", x));
ret = Redis.Custom(Commands.LRange, "DaysOfWeek", 1, -2);
var weekDays = ret.GetResults();      

weekDays.PrintDump(); // ["Monday", "Tuesday", "Wednesday", "Thursday", "Friday"]

und einige weitere Beispiele, die komplexe Typen mit den benutzerdefinierten APIs verwenden:

var ret = Redis.Custom(Commands.Set, "foo", new Poco { Name = "Bar" }); // ret.Text = "OK"

ret = Redis.Custom(Commands.Get, "foo");          // ret.Text =  {"Name":"Bar"}
Poco dto = ret.GetResult<Poco>();

dto.Name.Print(); // Bar

Diese API wird in den meisten redis.js-JavaScript-Clientbibliotheken von Redis React UI verwendet, in denen Redis-Serverbefehle über den einzelnen ServiceStack-Dienst verfügbar gemacht werden:

public object Any(CallRedis request)
{
    var args = request.Args.ToArray();
    var response = new CallRedisResponse { Result = Redis.Custom(args) };
    return response;
}