Reliable Services 入门

项目
08/12/2024

Azure Service Fabric 应用程序包含一个或多个运行代码的服务。本指南说明如何使用 Reliable Services 同时创建无状态与有状态的 Service Fabric 应用程序。

查看此页面，观看还将介绍如何创建无状态 Reliable Services 的培训视频。

基本概念

了解几个基本概念，即可开始使用 Reliable Services：

服务类型：这是你的服务实现。它由编写的可扩展 StatelessService 的类、其中使用的任何其他代码或依赖项以及名称和版本号定义。
命名服务实例：若要运行服务，需要创建服务类型的命名实例，就像创建类类型的对象实例一样。服务实例具有使用“fabric:/”方案（如“fabric:/MyApp/MyService”）的 URI 形式的名称。
服务主机：创建的命名服务实例需要在主机进程内运行。服务宿主是可以运行服务实例的进程。
服务注册：通过注册可将所有对象融合在一起。只有在服务宿主中将服务类型注册 Service Fabric 运行时，Service Fabric 才能创建该类型的可运行实例。

创建无状态服务

无状态服务是目前在云应用程序中作为基准的服务类型。该服务之所以被视为无状态，是因为它本身不包含需要可靠存储或高度可用的数据。如果无状态服务的实例关闭，其所有内部状态都会丢失。在这种类型的服务中，必须将状态保存到外部存储（如 Azure 表或 SQL 数据库），才能实现高可用性和可靠性。

以管理员身份启动 Visual Studio 2017 或 Visual Studio 2019，并新建一个名为 HelloWorld 的 Service Fabric 应用程序项目：

使用“新建项目”对话框新建 Service Fabric 应用程序

然后，使用 .NET Core 2.0 创建一个名为 HelloWorldStateless 的无状态服务项目：

在第二个对话框中，创建无状态服务项目

解决方案现在包含两个项目：

HelloWorld。这是包含服务的应用程序项目。它还包含应用程序清单，用于描述该应用程序以及一些帮助你部署应用程序的 PowerShell 脚本。
HelloWorldStateless。这是服务项目。其中包含无状态服务实现。

实现服务

打开服务项目中的 HelloWorldStateless.cs 文件。在 Service Fabric 中，服务可以运行任一业务逻辑。服务 API 为代码提供两个入口点：

名为 RunAsync 的开放式入口点方法，可在其中开始执行任何工作负荷，包括长时间运行的计算工作负荷。

protected override async Task RunAsync(CancellationToken cancellationToken)
{
    ...
}

一个通信入口点，可在其中插入所选的通信堆栈，例如 ASP.NET Core。这就是可以开始接收来自用户和其他服务请求的位置。

protected override IEnumerable<ServiceInstanceListener> CreateServiceInstanceListeners()
{
    ...
}

在本教程中，我们将重点放在 RunAsync() 入口点方法上。这是可以立即开始运行代码的位置。项目模板包括 RunAsync() 的示例实现，该实现递增滚动计数。

注意

有关如何使用通信堆栈的详细信息，请参阅使用 ASP.NET Core 与服务通信

RunAsync

protected override async Task RunAsync(CancellationToken cancellationToken)
{
    // TODO: Replace the following sample code with your own logic
    //       or remove this RunAsync override if it's not needed in your service.

    long iterations = 0;

    while (true)
    {
        cancellationToken.ThrowIfCancellationRequested();

        ServiceEventSource.Current.ServiceMessage(this.Context, "Working-{0}", ++iterations);

        await Task.Delay(TimeSpan.FromSeconds(1), cancellationToken);
    }
}

当服务实例已放置并且可以执行时，平台将调用此方法。对于无状态服务，这就意味着打开服务实例。需要关闭服务实例时，将提供取消标记进行协调。在 Service Fabric 中，服务的整个生存期内可能多次出现服务实例的这一打开-关闭循环。发生这种情况的原因多种多样，包括：

系统可能会移动服务实例以实现资源平衡。
代码中发生错误。
应用程序或系统升级。
基础硬件遇到中断。

系统将管理此业务流程，以便保持服务的高度可用和适当平衡。

RunAsync() 不应阻止同步。 RunAsync 实现应返回 Task，或等待任意长时间运行或阻止的操作以允许运行时继续。请注意，上一示例中的 while(true) 循环中使用了返回 Task 的 await Task.Delay()。如果必须同步阻止工作负荷，应使用 RunAsync 实现中的 Task.Run() 安排新的 Task。

取消工作负荷是一项由所提供的取消标记协调的协同操作。系统会等任务结束后（成功完成、取消或出现故障）再执行下一步操作。当系统请求取消时，请务必接受取消标记，完成所有任务，并尽快退出 RunAsync()。

在此无状态服务示例中，计数存储在本地变量中。不过，由于这是无状态服务，因此，所存储的值仅在其所在服务实例的当前生命周期中存在。当服务移动或重新启动时，值就会丢失。

创建有状态服务

Service Fabric 引入了一种新的有状态服务。有状态服务能够可靠地在服务本身内部保持状态，并与使用它的代码共置。 Service Fabric 无需将状态保存到外部存储，便可实现状态的高可用性。

要将计数器值从无状态转换为即使在服务移动或重新启动时仍高度可用并持久存在，你需要有状态服务。

在同一个 HelloWorld 应用程序中，通过右键单击应用程序项目中的服务引用并选择“添加”->“新建 Service Fabric 服务”，可以添加一个新的服务。

向 Service Fabric 应用程序添加服务

选择“.NET Core 2.0”->“有状态服务”并将其命名为 HelloWorldStateful。单击“确定” 。

使用“新建项目”对话框新建 Service Fabric 有状态服务

应用程序现在应该有两个服务：无状态服务 HelloWorldStateless 和有状态服务 HelloWorldStateful。

有状态服务具有与无状态服务相同的入口点。主要区别是是否有能够可靠地存储状态的状态提供程序。 Service Fabric 附带名为可靠集合的状态提供程序实现，可让你通过可靠状态管理器创建复制的数据结构。有状态可靠服务默认使用此状态提供程序。

打开 HelloWorldStateful 中的 HelloWorldStateful.cs，该文件包含以下 RunAsync 方法：

protected override async Task RunAsync(CancellationToken cancellationToken)
{
    // TODO: Replace the following sample code with your own logic
    //       or remove this RunAsync override if it's not needed in your service.

    var myDictionary = await this.StateManager.GetOrAddAsync<IReliableDictionary<string, long>>("myDictionary");

    while (true)
    {
        cancellationToken.ThrowIfCancellationRequested();

        using (var tx = this.StateManager.CreateTransaction())
        {
            var result = await myDictionary.TryGetValueAsync(tx, "Counter");

            ServiceEventSource.Current.ServiceMessage(this.Context, "Current Counter Value: {0}",
                result.HasValue ? result.Value.ToString() : "Value does not exist.");

            await myDictionary.AddOrUpdateAsync(tx, "Counter", 0, (key, value) => ++value);

            // If an exception is thrown before calling CommitAsync, the transaction aborts, all changes are
            // discarded, and nothing is saved to the secondary replicas.
            await tx.CommitAsync();
        }

        await Task.Delay(TimeSpan.FromSeconds(1), cancellationToken);
    }

RunAsync

RunAsync() 在有状态服务和无状态服务中的运行方式类似。只不过在有状态服务中，平台将先代表用户执行额外的工作，再执行 RunAsync()。这项工作可能包括确保可靠状态管理器和可靠集合随时可供使用。

可靠集合与可靠状态管理器

var myDictionary = await this.StateManager.GetOrAddAsync<IReliableDictionary<string, long>>("myDictionary");

IReliableDictionary 是一种字典实现，可用于将状态可靠地存储在服务中。利用 Service Fabric 和可靠集合，可以将数据直接存储在服务中而无需外部持久性存储。可靠集合可让数据具备高可用性。 Service Fabric 通过创建和管理服务的多个副本来实现此目的。它还提供一个抽象 API，消除了管理这些副本及其状态转换所存在的复杂性。

可靠集合可以存储任何 .NET 类型（包括自定义类型），但需要注意以下几点：

Service Fabric 通过跨节点复制状态，使状态具备高可用性；而可靠集合会将数据存储到每个副本上的本地磁盘中。这意味着可靠集合中存储的所有内容都必须可序列化。默认情况下，可靠集合使用 DataContract 进行序列化，因此，在使用默认序列化程序时，务必确保类型受数据协定序列化程序的支持。
在可靠集合上提交事务时，将复制对象以实现高可用性。存储在可靠集合中的对象保留在服务的本地内存中。这意味着你有对象的本地引用。

切勿转变这些对象的本地实例而不在事务中的可靠集合上执行更新操作。这是因为对对象的本地实例的更改将不会自动复制。必须将对象重新插回字典中，或在字典上使用其中一个更新方法。

可靠状态管理器管理可靠集合。无论何时何地，都可以根据名称向可靠状态管理器请求服务中的某个可靠集合。可靠状态管理器可确保能取回引用。不建议将可靠集合实例的引用存储在类成员变量或属性中。请特别小心，确保在服务生命周期中随时会引用设置为某个实例。可靠状态管理器会代为处理此工作，且已针对重复访问对其进行优化。

事务和异步操作

using (ITransaction tx = this.StateManager.CreateTransaction())
{
    var result = await myDictionary.TryGetValueAsync(tx, "Counter-1");

    await myDictionary.AddOrUpdateAsync(tx, "Counter-1", 0, (k, v) => ++v);

    await tx.CommitAsync();
}

可靠集合具有与其 System.Collections.Generic 和 System.Collections.Concurrent 对应项相同的许多操作，但语言集成查询 (LINQ) 除外。可靠集合上的操作是异步的。这是因为可靠集合的写入操作执行 I/O 操作，以将数据复制并保存到磁盘。

可靠集合操作是事务性的，因此可以跨多个可靠集合和操作保持状态的一致。例如，可以在单个事务中，将工作项从 Reliable Queue 取消排队、对其执行操作并将结果保存在 Reliable Dictionary 中。这被视为原子操作，它可以保证整个操作要么成功，要么回滚。如果将项取消排队之后、保存结果之前发生错误，则会回滚整个事务，并且项将保留在队列中以供处理。