ZayniFramework.Caching.RedisClient 2.2.1

Caching.RedisClient module example.

You can use the ZayniFramework.Caching.RedisClient module to help you to access the Redis Server. It helps you control the connection between and provide all the request & response action log between your application and Redis Server.

Add namespace using. You might need to add the StackExchange.Redis namespace too.

using StackExchange.Redis;
using ZayniFramework.Caching.RedisClientComponent;
using ZayniFramework.Common;
using ZayniFramework.Serialization;

Then, config your Redis Server connection in your app.config file. Like this,

<?xml version="1.0" encoding="utf-8"?>
<configuration>
    <configSections>
        <section name="ZayniFramework" type="ZayniFramework.Common.ZayniConfigSection, ZayniFramework.Common" />
    </configSections>
    <ZayniFramework>
        <LoggingSettings eventLogEnable="false" logEnable="true">
            <DefaultTextLogger>
                <add name="_DefaultLog" enable="true" maxSize="8">
                    <LogFile path="D:\Logs\Zayni\Tracing.log" />
                    <Filter filterType="deny" category="Information,Warning" />
                </add>

                
                <add name="RedisClientTrace:MyLab" enable="true" maxSize="8" dbLoggerName="Zayni" dbLoggerType="MySQL">
                    <LogFile path="D:\Logs\Zayni\RedisClient-Tracing-Taipei-Dev.log" />
                    
                </add>
            </DefaultTextLogger>
        </LoggingSettings>
        <RedisClientSettings>
            <RedisClients>
                <add name="RedisServer1" isDefault="true" traceLoggerName="RedisClientTrace:MyLab" host="XXX.XXX.XXX.XXX " port="6379" password="" dbNumber="1" connectTimeout="5000" responseTimeout="1000" />
            </RedisClients>
        </RedisClientSettings>
    </ZayniFramework>
    <connectionStrings>
        <add name="Zayni" connectionString="SERVER=XXX.XXX.XXX.XXX;DATABASE=zayni;UID=XXX;PASSWORD=XXX;Allow User Variables=True;Charset=utf8;Convert Zero Datetime=True"
             providerName="MySql.Data.MySqlClient" />
        
    </connectionStrings>
</configuration>

Get a RedisClient object from the RedisClientContainer.

// Get the 'isDefault=ture'.
RedisClient redisClient = RedisClientContainer.Get();

// Get a RedisClient from the RedisClientContainer. By name.
RedisClient redisClient = RedisClientContainer.Get( "RedisServer1" );

Using StackExchange.Redis method to access redis server.

• With better performance.
• But no request and response action log between redis server.

// You can use the StackExchange.Redis' method like this. BUT you won't have a action log if you choose this way to access redis server. (Better performance!)
// Put string data into redis server. Using StringSet method.
bool isSuccess = redisClient.Db.StringSet( "MyKey", "AAA", when: When.Always );

// Get string data from redis sever. Using StringGet method.
string result = redisClient.Db.StringGet( "MyKey" );

Using RedisClient's wrapper method to access redis server.

• You will have the request and response log between redis server if you config the app.config correctly.
• The performance will be slower...

// Declare a delegate to wrap the StachExchange.Redis' method like this.
Delegate stringSet = (Func<string, string, When, bool>)( ( key, value, when ) => redisClient.Db.StringSet( key, value, when: when ) );

// Use RedisClient's ExecResult wrapper method to invoke the delegate like this.
// Put string data into redis server.
var r1 = redisClient.ExecResult<bool>( stringSet, "ZayniTest2", "BBB", When.Always );
Assert.IsTrue( r1.Success );
Assert.IsTrue( r1.Data );

Delegate stringGet = (Func<string, string>)( key => redisClient.Db.StringGet( key ) );
var r2 = redisClient.ExecResult<string>( stringGet, "ZayniTest2" );
Assert.IsTrue( r2.Success );
Assert.AreEqual( "BBB", r2.Data );

// =================

var hashName = new HashEntry( "name", "Pony Lin" );
var hashAge  = new HashEntry( "age", 32 );
var hashSex  = new HashEntry( "sex", 1 );
var hashDoB  = new HashEntry( "dob", "1985-05-25" );

var hashSet = (Action<string, HashEntry[]>)( ( key, hashFields ) => redisClient.Db.HashSet( key, hashFields ) );
var r = redisClient.Exec( hashSet, "ZayniTest3", new HashEntry[] { hashName, hashAge, hashSex, hashDoB } );
Assert.IsTrue( r.Success );

var hashGet = (Func<string, string, string>)( ( key, hashField ) => redisClient.Db.HashGet( key, hashField ) );
var name    = redisClient.ExecResult<string>( hashGet, "ZayniTest3", "name" ).Data;
var age     = redisClient.ExecResult<string>( hashGet, "ZayniTest3", "age" ).Data;
var sex     = redisClient.ExecResult<string>( hashGet, "ZayniTest3", "sex" ).Data;
var dob     = redisClient.ExecResult<string>( hashGet, "ZayniTest3", "dob" ).Data;

Assert.AreEqual( "Pony Lin", name );
Assert.AreEqual( "32", age );
Assert.AreEqual( "1", sex );
Assert.AreEqual( "1985-05-25", dob );

Use the RedisClient's PutHashObject and GetHashObject methods.

var source = new UserModel()
{
    Name        = "Nancy",
    Age         = 26,
    Birthday    = new DateTime( 1993, 2, 24 ),
    CashBalance = 3000,
    TotalAssets = 4100
};

string key = $"ZayniTest123:{source.Name}";

// Put a data into redis in a hash type.
var p = redisClient.PutHashObject( key, source );
Assert.IsTrue( p.Success );

// Get a data from redis in a hash type.
var g = redisClient.GetHashObject<UserModel>( key );
Assert.IsTrue( g.Success );
Assert.AreEqual( source.Name, g.Data.Name );
Assert.AreEqual( source.Age, g.Data.Age );
Assert.AreEqual( source.Birthday, g.Data.Birthday );
Assert.AreEqual( source.CashBalance, g.Data.CashBalance );
Assert.AreEqual( source.TotalAssets, g.Data.TotalAssets );

More detail sample code. You can go to Test/UnitTests/Zayni.Caching.RedisClient.Test directory.