Harbour.RedisSessionStateStore 技术文档

本文档旨在帮助用户安装、配置和使用 Harbour.RedisSessionStateStore，这是一个基于 Redis 的 SessionStateStoreProvider，用 C# 编写，并使用 ServiceStack.Redis。

1. 安装指南

Harbour.RedisSessionStateStore 可以通过以下两种方式进行安装：

1. 使用 NuGet 安装：

   PM> Install-Package Harbour.RedisSessionStateStore
   

2. 从源代码构建并安装：

   msbuild .\build\build.proj
   

2. 项目使用说明

要配置您的应用程序使用 Harbour.RedisSessionStateStore，需要修改 web.config 文件以使用该会话状态提供程序：

<system.web>
  <sessionState mode="Custom" customProvider="RedisSessionStateProvider">
    <providers>
      <clear />
      <add name="RedisSessionStateProvider" 
           type="Harbour.RedisSessionStateStore.RedisSessionStateStoreProvider" 
           host="localhost:6379" clientType="pooled" />
    </providers>
  </sessionState>
</system.web>

此配置将使用 PooledRedisClientManager 并使用默认的主机和端口（localhost:6379）。如果您希望设置自定义的主机/端口，可以使用 host 属性。如果您希望将客户端管理器类型更改为 BasicRedisClientManager，可以将 clientType 设置为 "basic"。

如果需要配置自定义的 IClientsManager（例如，如果您正在使用 IoC 容器或者希望在整个应用程序中只有一个 IClientsManager），可以在应用程序启动时进行如下配置：

private IRedisClientsManager clientManager;

protected void Application_Start()
{
    this.clientManager = new PooledRedisClientManager("localhost:6379");
    RedisSessionStateStoreProvider.SetClientManager(this.clientManager);

    RedisSessionStateStoreProvider.SetOptions(new RedisSessionStateStoreOptions()
    {
        KeySeparator = ":",
        OnDistributedLockNotAcquired = sessionId =>
        {
            Console.WriteLine($"会话 \"{0}\" 无法建立分布式锁。这很可能意味着您需要增加 " +
                              $"DistributedLockAcquireSeconds/DistributedLockTimeoutSeconds。", sessionId);
        }
    });
}

protected void Application_End()
{
    this.clientManager.Dispose();
}

3. 项目API使用文档

本项目的主要API包括：

• RedisSessionStateStoreProvider.SetClientManager(IRedisClientsManager clientManager)：用于设置客户端管理器。
• RedisSessionStateStoreProvider.SetOptions(RedisSessionStateStoreOptions options)：用于配置会话状态存储的选项。

RedisSessionStateStoreOptions 类提供了以下配置选项：

• KeySeparator：键分隔符。
• OnDistributedLockNotAcquired：当无法获取分布式锁时调用的回调函数。

4. 项目安装方式

项目的安装方式已在“安装指南”一节中详细说明，请参考上述步骤进行安装。

通过本文档的介绍，用户应能顺利安装并使用 Harbour.RedisSessionStateStore。如有其他问题，请参考项目在 GitHub 上的 Wiki 页面或直接在 Issues 中提出。