Orleans 微软基于 Actor 的分布式框架

一、Actor模型工作原理

        Actor模型是一种并发编程模型，它基于消息传递实现，是一种轻量级的并发模型。在Actor模型中，每个Actor都是一个独立的执行单元，它可以接收和发送消息，并且可以执行一些本地操作，但是不能直接访问其他Actor的状态。

Actor模型的基本工作原理如下：
1.每个Actor都有一个唯一的标识符，它可以接收和发送消息。
2.Actor之间通过消息传递进行通信，每个Actor都有一个消息队列，用于存储接收到的消息。
3.Actor可以执行一些本地操作，但是不能直接访问其他Actor的状态。如果它想要访问其他Actor的状态，它必须通过发送消息的方式向其他Actor请求数据。
4.当一个Actor接收到一条消息时，它会根据消息处理逻辑执行相应的操作，并且可以向其他Actor发送消息。
5.Actor之间的通信是异步的，也就是说，发送消息的Actor不需要等待接收消息的Actor处理完消息才能继续执行。
6.在Actor模型中，所有的操作都是基于消息传递实现的，这种方式可以避免竞态条件和死锁等并发问题。

        总的来说，Actor模型通过将并发问题分解成多个独立的执行单元，实现了一种非常灵活和高效的并发编程模型。它可以避免一些常见的并发问题，例如竞态条件和死锁，并且可以很好地应对分布式系统中的并发问题。

二、Orleans简介

        Orleans是微软开源的分布式基于Actor的模型框架。

        Orleans 是一个跨平台框架，用于构建可靠且可缩放的分布式应用程序。 分布式应用程序定义为跨多个进程的应用，通常使用对等通信来超越硬件边界。 Orleans 从单个本地服务器扩展到了云中成百上千的分布式、高度可用的应用程序。 Orleans 将熟悉的概念和 C# 习语扩展到了多服务器环境。 Orleans 在设计上可弹性缩放。 当主机加入群集时，它可以接受新的激活。 当主机因纵向缩减或计算机故障而退出群集时，该主机上的先前激活将根据需要在其余主机上重新激活。 Orleans 群集可以纵向缩减为单个主机。 用于启用弹性缩放的相同属性也会启用容错。 群集可自动检测故障并快速从故障中恢复。

        Orleans 的主要设计目标之一是通过提供一组通用模式和 API 来简化分布式应用程序开发的复杂性。 熟悉单一服务器应用程序开发的开发人员可以轻松地改为使用 Orleans 构建可复原、可缩放的云原生服务和其他分布式应用程序。 因此，Orleans 经常被称为“分布式 .NET”，并且是用于构建云原生应用的首选框架。

        在现在的计算机环境下，多线程编程是不可避免的。多线程带来的很多好处，也带来的很多编程上的弊端。如：在多线程环境下，如何保持操作数据的原子性就成了一个问题。

        Orleans采用的办法就是利用Actor模型原理，设计一个类，保证这个类从“创建”过程到“销毁”过程，以及“中途调用它的方法”的执行过程，这三个“过程”不管何时何地调用，都会在同一个线程中运行。这样的话，我就可以放心大胆的去修改，调用这个类的方法，而不用担心这个指向这个类的变量出现“脏读”的情况。

        Orleans模型里，每一个Actor有专门的类代表它，叫做Grain，这个grain类就是模拟通信场景中的”人”。

1、什么是Grain

        Grain 是多个 Orleans 基元中的一个。 就执行组件模型而言，grain 是一个虚拟执行组件。 任何 Orleans 应用程序中的基本构建块都是一个 grain。 grain 是由用户定义的标识、行为和状态组成的实体。 考虑 grain 的以下视觉表示形式：

 

        grain 标识是用户定义的键有多种类型可用，使 grain 始终可供调用。grain 能够包含可存储在任何存储系统中的易失性或持久性状态数据。 因此，grain 隐式将应用程序状态分区，实现自动可伸缩性并简化从故障中恢复的过程。 当 grain 处于活动状态时，grain 状态将保存在内存中，从而降低延迟并减轻数据存储的负载。

        Grain 的实例化由 Orleans 运行时按需自动执行。 有一段时间未使用的 grain 会自动从内存中删除以释放资源。 之所以能够做到这一点，是因为 grain 具有稳定的标识，无论它们是否已加载到内存中，都可以调用它们。 这样还能以透明方式从故障中恢复，因为调用方在任何时间点都不需要知道在哪个服务器上实例化了 grain。 Grain 具有受管理的生命周期，Orleans 运行时负责按需激活/取消激活和放置/定位 grain。 这样，开发人员就可以按照所有 grain 都在内存中的情况那样编写代码。

        Orleans为了解决多线程带来的“资源竞争”等问题，在Orleans框架内，它保证每个grain类符合以下行为规范：

　　A． 发往同一个grain类实例的任何消息都会在固定线程内执行。
　　B． grain类按照接受消息的先后，依次处理消息。在任意时间点，一个grain实例只处理一个消息。
　　C． grain实例内的字段属性，只能由实例本身访问。外界不能访问。

 2、什么是Silo

        silo 是 Orleans 基元的另一个示例。 silo 承载一个或多个 grain。 Orleans 运行时实现应用程序的编程模型。

        通常，一组 silo 作为一个群集运行，以实现可伸缩性和容错。 作为群集运行时，silo 会相互协调，以分配工作并检测故障以及从故障中恢复。 运行时使承载在群集中的 grain 能够相互通信，就如同它们在单个进程中一样。 下图可视化了群集、silo 和 grain 之间的关系：

上图显示了群集、silo 和 grain 之间的关系。 可以组建任意数量的群集，每个群集包含一个或多个 silo，而每个 silo 包含一个或多个 grain。

除了核心编程模型以外，silo 还为 grain 提供一组运行时服务，例如计时器、提醒（持久计时器）、持久性、事务、流等。

3、可以用Orleans做什么

        Orleans 是用于构建云原生应用的框架，每当你构建最终需要缩放的 .NET 应用时，请考虑使用 Orleans。 Orleans 的用途看似数不胜数，但下面是一些最常见的用途：游戏、银行、聊天应用、GPS 跟踪、股票交易、购物车、投票应用等。 Microsoft 在 Azure、Xbox、Skype、Halo、PlayFab、Gears of War 和其他许多内部服务中都使用了 Orleans。 Orleans 的许多功能使之可以轻松用于各种应用程序。

 三、使用Orleans的简单示例

创建项目，利用Grain实现一个简单的URL缩短器

#创建新web项目
dotnet new web -o UrlShortener -f net7.0

#进入项目文件夹，打开编辑器
cd UrlShortener
code .

 在项目中添加orleans组件

#将 Orleans 添加到项目
dotnet add package Microsoft.Orleans.Server -v 7.0.0

在program.cs文件头部添加引用

using Microsoft.AspNetCore.Http.Extensions;
using Orleans.Runtime;

1、创建grain类

        首先在program.cs文件底部，添加一个继承自IGrainWithStringKey的接口，实现设置和读取。

public interface IUrlShortenerGrain : IGrainWithStringKey
{
    Task SetUrl(string shortenedRouteSegment, string fullUrl);
    Task GetUrl();
}

然后创建 UrlShortenerGrain类，并实现此接口

public class UrlShortenerGrain : Grain, IUrlShortenerGrain
{
    private KeyValuePair _cache;

    public Task SetUrl(string shortenedRouteSegment, string fullUrl)
    {
        _cache = new KeyValuePair(shortenedRouteSegment, fullUrl);
        return Task.CompletedTask;
    }

    public Task GetUrl()
    {
        return Task.FromResult(_cache.Value);
    }
}

2、创建和配置接收器 

在 Program 类的顶部，重构 builder 代码以使用 Orleans。 完成的代码应如下例所示：

var builder = WebApplication.CreateBuilder();

builder.Host.UseOrleans(siloBuilder =>
{
    siloBuilder.UseLocalhostClustering();
});

var app = builder.Build();

        接下来，需要检索粒度工厂的实例。 Orleans 提供了一个默认的粒度工厂，它使用粒度的标识符来管理粒度的创建和检索。 调用 var app = builder.Build(); 后，添加以下代码行以获取粒度工厂，并将其存储在名为 grainFactory 的变量中：

var grainFactory = app.Services.GetRequiredService();

3、创建长URL接收路由

将原输出“Hello, world”的代码改成接受长URL并准备返回短URL

app.MapGet("/shorten/{*path}",
    async (IGrainFactory grains, HttpRequest request, string path) =>
{
    return Results.Ok();
});

此时返回一个200的空值，将它改进返回短URL路径。

app.MapGet("/shorten/{*path}",
async (IGrainFactory grains, HttpRequest request, string path) =>
{
    var shortenedRouteSegment = Guid.NewGuid().GetHashCode().ToString("X");
    var shortenerGrain = grains.GetGrain(shortenedRouteSegment);
    await shortenerGrain.SetUrl(shortenedRouteSegment, path);
    var resultBuilder = new UriBuilder(request.GetEncodedUrl())
    {
        Path = $"/go/{shortenedRouteSegment}"
    };

    return Results.Ok(resultBuilder.Uri);
});

上述代码执行了几个任务：

• 首先，使用一个 GUID 从其哈希代码创建一个随机的缩短路由段作为十六进制字符串。
• 然后，粒度工厂使用缩短的路由段作为标识符来创建新粒度。
• 粒度实例存储缩短的路由段和原始目标 URL，以便稍后可以进行检索。
• 最后，组装一个包含缩短的路由段的新 URL 并返回给用户。

4、 创建访问短URL时重定向到对应长URL的路由路径

app.MapGet("/go/{shortenedRouteSegment}",
    async (IGrainFactory grains, string shortenedRouteSegment) =>
{
    var shortenerGrain = grains.GetGrain(shortenedRouteSegment);
    var url = await shortenerGrain.GetUrl();

    return Results.Redirect(url);
});

此代码执行以下任务来处理用户的请求。

• 使用短URL名作为键从grains工厂拉取保存所提供短URL的重定向信息的grain。
• 从grain中检索完整的 URL 字符串。
• 如果找到适当的 URL，则将用户重定向到该地址，否则返回 404。

5、运行测试

dotnet run

 如访问{localhost}/shorten/https://blog.csdn.net/zhujisoft，得到短路径"http://localhost:5205/go/AB39050D"

访问短路径http://localhost:5205/go/AB39050D，则可以重定向到长URL地址，利用grain实现简单的转换功能。

 6、状态保持，尝试用grain保存数据

可以定义要保持状态的对象，具体做法是在grain构造函数中声明这些对象并使用 PersistentState属性进行修饰。 使用此属性修饰的对象有权访问前面介绍的 API 方法。
PersistentState属性 接受两个参数：

• Name：定义状态对象的名称。
• StorageName：定义应将对象保存到的存储提供程序。

public class UrlShortenerGrain : Grain, IUrlShortenerGrain
{
    private readonly IPersistentState> _cache;

    public UrlShortenerGrain(
        [PersistentState(
            stateName: "url",
            storageName: "urls")]
            IPersistentState> state)
    {
        _cache = state;
    }
}

7、配置grain存储方法

builder.Host.UseOrleans(siloBuilder =>
{
    siloBuilder.UseLocalhostClustering();
    siloBuilder.AddAzureBlobGrainStorage("urls",
        // Recommended: Connect to Blob Storage using DefaultAzureCredential
        options =>
        {
            options.ConfigureBlobServiceClient(new Uri("https://.blob.core.windows.net"),
                new DefaultAzureCredential());
        });
        // Connect to Blob Storage using Connection strings
        // options => options.ConfigureBlobServiceClient(connectionString));
});

         存储提供程序示例包括传统 SQL 数据库、各种 Azure 服务（例如 Blob 存储）和其他云资源（例如 Amazon DynamoDb）。 这些提供程序通过各种 NuGet 包提供。 Orleans 还提供扩展点来添加自己的存储提供程序。

为简单起见，本例中使用内存存储

builder.Host.UseOrleans(siloBuilder =>
{
    siloBuilder.UseLocalhostClustering();
    siloBuilder.AddMemoryGrainStorage("urls");
});

更新grain构造函数和使用方法

public async Task SetUrl(string shortenedRouteSegment, string fullUrl)
{
    _cache.State = new KeyValuePair(shortenedRouteSegment, fullUrl);
    await _cache.WriteStateAsync();
}

public Task GetUrl()
{
    return Task.FromResult(_cache.State.Value);
}

自此，应用程序现支持持久状态。

四、参考文章

1、Orleans 简介 - Training | Microsoft Learn

2、简介 - Training | Microsoft Learn

3、actor模型工作原理-腾科IT教育官网

4、Orleans简介_c# orleans 框架 组成部分_liyan530的博客-CSDN博客