CachingFramework.Redis 开源项目教程

1. 项目介绍

CachingFramework.Redis 是一个基于 StackExchange.Redis 开发的 .NET Redis 客户端库。它提供了一些有趣的功能，如可扩展的序列化策略、标签机制来分组键、哈希字段和集合成员，以及支持原子添加/获取操作的获取机制，并且所有功能都与 Redis 集群完全兼容。

主要特性包括：

• 支持 .NET Framework 和 .NET Core
• 类型化缓存：任何可序列化对象都可以作为缓存值
• 获取机制：用于原子添加/获取操作的快捷缓存方法（缓存旁路模式）
• 标签机制：允许缓存项被标记，可以按标签检索或使键或成员失效
• 生存时间（TTL）机制：每个键都可以关联一个定义其生存时间的值
• 字符串排序集合：用于快速的字符串匹配和自动完成建议
• 发布/订阅支持：带强类型消息的发布-订阅实现
• 地理空间索引：支持半径查询
• HyperLogLog 支持：用于计数唯一事物
• 可配置序列化：默认使用压缩的二进制序列化，或提供自定义序列化
• Redis 数据类型作为 .NET 集合：支持 List、Set、Sorted Set、Hash 和 Bitmap 作为托管集合
• Redis Keyspace 通知：订阅 Pub/Sub 频道以接收影响 Redis 数据集的事件

2. 项目快速启动

首先，确保你已经安装了 .NET SDK。然后，你可以通过 NuGet 包管理器来安装 CachingFramework.Redis 包。

PM> Install-Package CachingFramework.Redis

以下是一个快速启动示例，演示如何创建一个 RedisContext 实例并使用它来设置和获取一个缓存对象。

using System;
using CachingFramework.Redis;

class Program
{
    static void Main(string[] args)
    {
        // 默认配置连接到本地主机端口 6379
        var context = new RedisContext();

        // 或者使用自定义连接配置
        // var context = new RedisContext("10.0.0.1:7000, 10.0.0.2:7000, connectRetry=10, abortConnect=false, allowAdmin=true");

        // 设置一个缓存对象
        var key = "user:1";
        var user = new User { Id = 1, UserName = "Alice" };
        context.Cache.SetObject(key, user);

        // 获取一个缓存对象
        var fetchedUser = context.Cache.GetObject<User>(key);

        Console.WriteLine($"User Name: {fetchedUser.UserName}");
    }
}

[Serializable]
public class User
{
    public int Id { get; set; }
    public string UserName { get; set; }
}

3. 应用案例和最佳实践

缓存旁路模式

在使用缓存旁路模式时，首先尝试从缓存中获取数据，如果数据不存在，则从数据库中获取数据，并将其存储在缓存中。

var user = context.Cache.FetchObject<User>(key, () => GetUserFromDatabase(userId));

在这里，GetUserFromDatabase 方法只有在缓存中没有找到数据时才会被调用。

数据序列化

CachingFramework.Redis 支持多种序列化机制。根据你的需求选择合适的序列化方法，例如，如果你使用 .NET Core，默认的序列化器是 JsonSerializer。

RedisContext.DefaultSerializer = new JsonSerializer();

如果你需要自定义序列化，可以实现 ISerializer 接口或继承 SerializerBase 类。

连接池管理

为了提高性能和可靠性，应当使用连接池。CachingFramework.Redis 通过 PooledConnectionMultiplexer 类支持连接池。

var myMultiplexer = new PooledConnectionMultiplexer(Common.Config);
var context = new RedisContext(myMultiplexer);

4. 典型生态项目

CachingFramework.Redis 可以与许多其他 .NET 生态项目配合使用，例如：

• ASP.NET Core：在 Web 应用程序中用于缓存页面输出或频繁查询的数据。
• Entity Framework Core：用于缓存数据库查询结果。
• SignalR：配合使用，可以缓存用户连接状态，减少数据库压力。

这些典型生态项目可以帮助开发者构建高效且可扩展的应用程序。