C#使用CSRedisCore的實(shí)現(xiàn)示例

更新時(shí)間：2025年11月02日 15:53:45 作者：Yashar Qian

CSRedisCore是高效的.NET Redis客戶端,支持單節(jié)點(diǎn)、哨兵和集群模式,本文詳細(xì)介紹了其安裝配置方法和基礎(chǔ)操作,感興趣的可以了解一下

CSRedisCore 是一個(gè)功能強(qiáng)大的 .NET Redis 客戶端。以下是詳細(xì)的使用指南：

1. 安裝

首先通過 NuGet 安裝 CSRedisCore：

dotnet add package CSRedisCore

2. 基本配置

單節(jié)點(diǎn) Redis 配置

using CSRedis;

// 創(chuàng)建 Redis 客戶端實(shí)例
var redis = new CSRedisClient("127.0.0.1:6379,password=yourpassword,defaultDatabase=0");

// 設(shè)置為全局實(shí)例（推薦）
RedisHelper.Initialization(redis);

哨兵模式配置

var redis = new CSRedisClient(
    "mymaster,password=123456",
    new[] { "192.168.1.10:26379", "192.168.1.11:26379", "192.168.1.12:26379" });

RedisHelper.Initialization(redis);

集群模式配置

var redis = new CSRedisClient(
    "127.0.0.1:6379,password=123456,defaultDatabase=0",
    "127.0.0.1:6380,password=123456,defaultDatabase=0",
    "127.0.0.1:6381,password=123456,defaultDatabase=0");

RedisHelper.Initialization(redis);

3. 基本使用

字符串操作

// 設(shè)置值
RedisHelper.Set("name", "張三");
RedisHelper.Set("age", 25, TimeSpan.FromMinutes(10)); // 帶過期時(shí)間

// 獲取值
string name = RedisHelper.Get("name");
int age = RedisHelper.Get<int>("age");

// 批量操作
RedisHelper.MSet("key1", "value1", "key2", "value2");
var values = RedisHelper.MGet<string>("key1", "key2");

// 原子操作
long newValue = RedisHelper.IncrBy("counter", 1);

哈希操作

// 設(shè)置哈希字段
RedisHelper.HSet("user:1", "name", "李四");
RedisHelper.HSet("user:1", "age", 30);

// 獲取哈希字段
string userName = RedisHelper.HGet<string>("user:1", "name");
int userAge = RedisHelper.HGet<int>("user:1", "age");

// 獲取所有字段
var allFields = RedisHelper.HGetAll<string>("user:1");

// 批量設(shè)置
RedisHelper.HMSet("user:2", new Dictionary<string, object>
{
    ["name"] = "王五",
    ["age"] = 28,
    ["email"] = "wangwu@example.com"
});

列表操作

// 添加元素
RedisHelper.LPush("mylist", "item1");
RedisHelper.RPush("mylist", "item2", "item3");

// 獲取元素
string firstItem = RedisHelper.LPop<string>("mylist");
string lastItem = RedisHelper.RPop<string>("mylist");

// 獲取范圍
var items = RedisHelper.LRange<string>("mylist", 0, -1);

集合操作

// 添加成員
RedisHelper.SAdd("myset", "member1", "member2", "member3");

// 獲取所有成員
var members = RedisHelper.SMembers<string>("myset");

// 判斷成員是否存在
bool exists = RedisHelper.SIsMember("myset", "member1");

// 集合運(yùn)算
RedisHelper.SInterStore("result_set", "set1", "set2");

有序集合操作

// 添加成員和分?jǐn)?shù)
RedisHelper.ZAdd("leaderboard", 
    (100, "player1"),
    (85, "player2"),
    (95, "player3")
);

// 獲取排名
var topPlayers = RedisHelper.ZRange<string>("leaderboard", 0, 2);
var topPlayersWithScores = RedisHelper.ZRangeWithScores<string>("leaderboard", 0, 2);

// 獲取成員排名
long rank = RedisHelper.ZRevRank("leaderboard", "player1");

4. 高級(jí)功能

發(fā)布訂閱

// 訂閱
var sub = RedisHelper.Subscribe(("channel1", msg => 
{
    Console.WriteLine($"收到消息: {msg.Body}");
}));

// 發(fā)布
RedisHelper.Publish("channel1", "Hello, Redis!");

// 取消訂閱
sub.Unsubscribe();

管道操作

// 使用管道批量執(zhí)行命令
var pipe = RedisHelper.StartPipe();
pipe.Set("key1", "value1");
pipe.Set("key2", "value2");
pipe.IncrBy("counter", 1);
object[] results = pipe.EndPipe();

事務(wù)操作

var tran = RedisHelper.Multi();
tran.Set("key1", "value1");
tran.Set("key2", "value2");
tran.Exec();

Lua 腳本

var script = @"
    local current = redis.call('GET', KEYS[1])
    if current then
        redis.call('SET', KEYS[1], current + ARGV[1])
    else
        redis.call('SET', KEYS[1], ARGV[1])
    end
    return redis.call('GET', KEYS[1])
";

var result = RedisHelper.Eval<string>(script, "mycounter", 1);

5. 在 ASP.NET Core 中使用

配置服務(wù)

// Program.cs
var builder = WebApplication.CreateBuilder(args);

// 配置 CSRedis
var redisConnection = builder.Configuration.GetConnectionString("Redis");
var redis = new CSRedisClient(redisConnection);
RedisHelper.Initialization(redis);

// 注冊(cè)為服務(wù)
builder.Services.AddSingleton(redis);

// 或者使用依賴注入
builder.Services.AddScoped<IRedisService, RedisService>();

創(chuàng)建服務(wù)類

public interface IRedisService
{
    Task<T> GetAsync<T>(string key);
    Task SetAsync<T>(string key, T value, TimeSpan? expiry = null);
    Task<bool> RemoveAsync(string key);
}

public class RedisService : IRedisService
{
    public async Task<T> GetAsync<T>(string key)
    {
        return await RedisHelper.GetAsync<T>(key);
    }

    public async Task SetAsync<T>(string key, T value, TimeSpan? expiry = null)
    {
        if (expiry.HasValue)
            await RedisHelper.SetAsync(key, value, expiry.Value);
        else
            await RedisHelper.SetAsync(key, value);
    }

    public async Task<bool> RemoveAsync(string key)
    {
        return await RedisHelper.DelAsync(key) > 0;
    }
}

在控制器中使用

[ApiController]
[Route("api/[controller]")]
public class UsersController : ControllerBase
{
    private readonly IRedisService _redisService;

    public UsersController(IRedisService redisService)
    {
        _redisService = redisService;
    }

    [HttpGet("{id}")]
    public async Task<IActionResult> GetUser(string id)
    {
        var cacheKey = $"user:{id}";
        var user = await _redisService.GetAsync<User>(cacheKey);
        
        if (user == null)
        {
            // 從數(shù)據(jù)庫(kù)獲取
            user = await _userRepository.GetByIdAsync(id);
            if (user != null)
            {
                await _redisService.SetAsync(cacheKey, user, TimeSpan.FromMinutes(30));
            }
        }
        
        return Ok(user);
    }
}

6. 配置選項(xiàng)

var connectionString = 
    "127.0.0.1:6379,password=123456,defaultDatabase=0," +
    "prefix=myapp_,poolsize=50,ssl=false,writeBuffer=10240";

var redis = new CSRedisClient(connectionString);

主要配置參數(shù)：