Orleans 解决并发之痛（二）：Grain 状态

Grains 是 Orleans 应用程序的构建块，它们是彼此孤立的原子单位，分布的，持久的，一个典型的 Grain 是有状态和行为的一个单实例，每个 Grain 实例的在单线程内执行，Grain 之间共享数据通过消息传递，Grains 是由 Silo 自动化管理。

Grain 之间传递消息过程中也可能出现死锁的情况，如：Grain A 发送消息给 Grain B，并等待它的完成，此时 Grain B 发送一个消息给 Grain A，也等待其完成，这时候出现相互等待而造成死锁。Orleans 对 Grain 之间产生的死锁问题解决也是非常简单的，只需要在 Grain上加 [Reentrant] 属性，具体可查看官方 Concurrency。

Grain 状态有好几种存储方式，比如：AzureTableStorage、AzureBlobStorage、SQLStorage、MemoryStorage 等，我们还可以自定义存储。MemoryStorage 在测试项目使用没问题，但实际生产环境要使用其他持久存储的方式，因为一旦一个 Silo 被关闭，内存存储的状态将会消失。

在分布式下，State 的使用可以减少很多对数据库层面的压力。当然也不是所有的 Grain 都推荐使用 State，还是看实际业务需求。我们可以想象一个场景，一个商品的库存如果保存在 State 中，所有请求都共享这个 State，在判断是否有剩余商品的时候是不是就不需要每次都去查询数据库了？

定义接口

public interface IPersonGrain : IGrainWithStringKey
{
  Task SayHelloAsync();
}

实现接口

public class PersonGrain : Grain, IPersonGrain
{
  public Task SayHelloAsync()
  {
    string primaryKey = this.GetPrimaryKeyString();

    Console.WriteLine($"{primaryKey} said hello!");

    return Task.CompletedTask;
  }
}

为了实现状态存储，我们需要创建一个 class：

public class PersonGrainState
{
  public bool SaidHello { get; set; }
}

修改代码，实现的 PersonGrain 不应该再继承 Grain，而是 Grain

[StorageProvider(ProviderName = "OrleansStorage")]
public class PersonGrain : Grain, IPersonGrain
{
  public async Task SayHelloAsync()
  {
    string primaryKey = this.GetPrimaryKeyString();

    bool saidHelloBefore = this.State.SaidHello;
    string saidHelloBeforeStr = saidHelloBefore ? " already" : null;

    Console.WriteLine($"{primaryKey}{saidHelloBeforeStr} said hello!");

    this.State.SaidHello = true;
    await this.WriteStateAsync();
  }
}

第一次调用这个方法的时候 this.State.SaidHello 为 false，输出 xxx said hello! 。然后我们通过 WriteStateAsync 修改 SaidHello 为 true，当第二次被调用的时候，从 State 里取出的 SaidHello 已经变成了 true，则输出 xxx already said hello!

Orleans 提供了非常简单的 API 来处理持久化装状态，看方法名就知道什么意思了，WriteStateAsync()、ReadStateAsync() 、 ClearStateAsync()。

同时在 PersonGrain 加了一个 StorageProvider 属性，参数 ProviderName 赋值为 OrleansStorage，这里需要对 Silo 的配置文件（OrleansConfiguration.xml）做调整，添加 StorageProviders 配置，Type 表示存储方式，Name 表示名称，程序内指定的 ProviderName 需要和配置中这个名称保持一致。

注意：
当 Name为Default 时，如果某个 Grain 使用 Default 来存储，可以不需要加 StorageProvider 属性。StorageProviders 下可以有多个 Provider，每个 Provider 的 Type 可以不一样，每个 Grain 指定的存储方式也可以不一样，ProviderName 指定是谁就用谁存储。

为了验证 Grain 之间是独立的，在 Client 加入以下代码：

 var joe = GrainClient.GrainFactory.GetGrain("Joe");
joe.SayHelloAsync();
joe.SayHelloAsync();

var sam = GrainClient.GrainFactory.GetGrain("Sam");
sam.SayHelloAsync();
sam.SayHelloAsync();

测试结果：

Test Result

SQL Server 持久存储 State

上面提到 State 以内存存储的方式并不适合生产环境，那下面我们使用 SQL Server 来实现。

在 Silo 程序集中安装依赖包：

Install-Package Microsoft.Orleans.OrleansSqlUtils
Install-Package System.Data.SqlClient

创建数据库和表：

在 SQL Server 中创建一个数据库，命名如：OrleansStorage（随意）；
在解决方案下找到目录：packages\Microsoft.Orleans.OrleansSqlUtils.1.5.0\lib\net461\SQLServer，目录下有一个 .sql 文件，在 OrleansStorage 数据库下执行这个 sql 脚本即可；

修改 OrleansConfiguration.xml 的 StorageProviders 节点为：

重新启动 Silo 和 Client：

执行完成后查看数据库中表 Storage 的内容，数据的值是二进制是方式存储。

storage

之后不管重启多少次，输出的结果都是 xxx already saild hello! 。

参考链接：

Actor 模型
Orleans
案例 Demo-OrleansState