Orleans 知多少 | 4. 有狀態的Grain

引言

Orleans 的優勢之一就是：支持有狀態服務的水平擴展。那這一節我們就來看看如何來了解下有狀態的Grain。

第一個有狀態的Grain

先來看下上節中定義的Grain：SessionControlGrain

public class SessionControlGrain : Grain, ISessionControlGrain
{
    private List<string> LoginUsers { get; set; } = new List<string>();

    public Task Login(string userId)
    {
        //獲取當前Grain的身份標識(因為ISessionControlGrain身份標識為string類型，GetPrimaryKeyString());
        var appName = this.GetPrimaryKeyString();

        LoginUsers.Add(userId);

        Console.WriteLine($"Current active users count of {appName} is {LoginUsers.Count}");
        return Task.CompletedTask;
    }

    public Task Logout(string userId)
    {
        //獲取當前Grain的身份標識
        var appName = this.GetPrimaryKey();
        LoginUsers.Remove(userId);

        Console.WriteLine($"Current active users count of {appName} is {LoginUsers.Count}");
        return Task.CompletedTask;
    }

    public Task<int> GetActiveUserCount()
    {
        return Task.FromResult(LoginUsers.Count);
    }
}

上面的Grain中定義屬性private List<string> LoginUsers { get; set; } = new List<string>();用來保存登錄狀態，其是保存在內存中的，一旦服務奔潰或重啟，維護的狀態數據就會丟失。
很顯然，這在真實應用場景中不被允許。

在第一節中，已經對有狀態和無狀態有了解釋，關鍵的區別在於：狀態數據的是否持久化。因此上面針對ISessionControlGrain的實現SessionControlGrain是無狀態的。

那接下來就來看看如何用有狀態的Grain來實現！

針對統計登錄用戶的需求來說，其中的狀態數據就是在線用戶列表，所以可以直接定義一個LoginState來將行為和數據解耦。

/// <summary>
/// 登錄狀態
/// </summary>
public class LoginState
{
    public List<string> LoginUsers { get; set; } = new List<string>();

    public int Count => LoginUsers.Count;
}

緊接着就可以重新實現一個ISessionControlGrain，如下：

/// <summary>
/// 有狀態的Grain
/// </summary>
public class SessionControlStateGrain : Grain<LoginState>, ISessionControlGrain
{
    public Task Login(string userId)
    {
        var appName = this.GetPrimaryKeyString();
        this.State.LoginUsers.Add(userId);
        this.WriteStateAsync();

        Console.WriteLine($"Current active users count of {appName} is {this.State.Count}");
        return Task.CompletedTask;
    }

    public Task Logout(string userId)
    {
        //獲取當前Grain的身份標識
        var appName = this.GetPrimaryKey();
        this.State.LoginUsers.Remove(userId);
        this.WriteStateAsync();

        Console.WriteLine($"Current active users count of {appName} is {this.State.Count}");
        return Task.CompletedTask;
    }

    public Task<int> GetActiveUserCount()
    {
        return Task.FromResult(this.State.Count);
    }
}

對比兩個Grain的實現，有狀態的Grain主要有以下變化：

1. 繼承自Grain<T>，其中T用來指定當前Grain的附屬狀態對象。
2. Grain中通過this.State來操作狀態
3. 通過調用this.WriteStateAsync();來顯式持久化狀態。

那Grain的狀態保存到哪里去了呢？

Grain 狀態倉庫（Grain Storage）

持久化方式

開發環境下，可使用內存作為Grain的狀態倉庫。僅需在構建Orleans Silo時配置AddMemoryGrainStorageAsDefault()即可，如下所示：

return Host.CreateDefaultBuilder()
    .UseOrleans((builder) =>
        {
            builder.UseLocalhostClustering()
                .AddMemoryGrainStorageAsDefault()
                .Configure<ClusterOptions>(options =>
                {
                    options.ClusterId = "Hello.Orleans";
                    options.ServiceId = "Hello.Orleans";
                })
                .Configure<EndpointOptions>(options => options.AdvertisedIPAddress = IPAddress.Loopback)
                .ConfigureApplicationParts(parts =>
                    parts.AddApplicationPart(typeof(ISessionControlGrain).Assembly).WithReferences());
        }
    )

存在內存中，只是為了方便開發，顯然在生產環境中是萬萬不可的。因此，可選擇其他存儲介質進行持久化。比如數據庫等，Orleans 官方維護的狀態持久化提供者有以下幾種：

• Microsoft.Orleans.Persistence.AdoNet ：封裝了對SQL 數據庫的支持，目前支持SQL Server、MySQL/MariaDB、PostgreSQL、Oracle。可參考 ADO.NET Grain Persistence。
• Microsoft.Orleans.Persistence.AzureStorage：封裝了對Azure 存儲介質的支持，比如 Azure Blob Storage, Azure Table Storage, 以及 Azure CosmosDB。 可參考 Azure Storage Grain Persistence。
• Microsoft.Orleans.Persistence.DynamoDB ：封裝了對 Amazon DynamoDB 的支持。可參考Amazon DynamoDB Grain Persistence。

當然除此之外，社區也維護系列開源項目支持將狀態數據持久化到其他介質。
接下來就來講解如何持久化狀態數據到SQL Server 數據庫。

持久化到 SQL Server

SqlServer的配置並沒有想象的那樣簡單，根據官方文檔： Configuring ADO.NET Providers、 ADO.NET Database Configuration，你會發現需要執行以下幾步：

1. Orleans Server 端添加對Microsoft.Orleans.Persistence.AdoNet NuGet包的引用
2. 添加SQL Server 客戶端驅動System.Data.SqlClient NuGet包的引用
3. 創建SQL Server數據庫，可使用VS 自帶的localdb。
4. 依次執行以下腳本,SQLServer-Main.sql、SQLServer-Persistence.sql 創建用於存儲相關狀態表。
5. 添加配置代碼

為了簡化配置，我做了一個簡單的包裝項目Orleans.AdoNet.Extensions，以簡化SqlServer、MySql、Oracle和PostgreSql 的配置。以Sql Server 為例，僅需：

1. 通過Nuget包管理器安裝Orleans.AdoNet.SqlServer包
2. 安裝后會打開一個readme.txt，復雜全部，並執行到數據庫
3. 服務端添加以下配置即可。

Host.CreateDefaultBuilder()
    .UseOrleans((builder) =>
     {
         var connectionString =
             @"Data Source=(localdb)\MSSQLLocalDB;Initial Catalog=Hello.Orleans;Integrated Security=True;Pooling=False;Max Pool Size=200;MultipleActiveResultSets=True";
         
        //use AdoNet for Persistence
        builder.AddSqlServerGrainStorageAsDefault(options =>
        {
            options.ConnectionString = connectionString;
            options.UseJsonFormat = true;
        }); 

重新運行項目，查詢數據庫，你會發現狀態數據，實際上是持久化到Storage表中了。如下圖所示：

代碼已上傳至stategrain:Orleans/Hello.Orleans