编写并运行 Actors

了解有关使用 .NET SDK 编写和运行 Actors

编写 Actors

ActorHost

ActorHost：

是所有 Actors 的必需构造函数参数
由运行时提供
必须传递给基类的构造函数
包含了允许该 actor 实例与运行时通信的所有状态

internal class MyActor : Actor, IMyActor, IRemindable
{
    public MyActor(ActorHost host) // Accept ActorHost in the constructor
        : base(host) // Pass ActorHost to the base class constructor
    {
    }
}

因为 ActorHost 包含了actor独有的状态，所以你不需要将实例传递到代码的其他部分。建议仅在测试中创建自己的 ActorHost 实例。

使用依赖输入

Actors支持将额外的参数通过构造函数进行依赖注入。您定义的任何其他参数都将从依赖注入容器中得到它们的值。

internal class MyActor : Actor, IMyActor, IRemindable
{
    public MyActor(ActorHost host, BankService bank) // Accept BankService in the constructor
        : base(host)
    {
        ...
    }
}

一个 actor 类型应该有一个单独的 public 构造函数。演员基础设施使用 ActivatorUtilities 模式来构造演员实例。

您可以在 Startup.cs 中使用依赖注入来注册类型，以使它们可用。了解更多关于不同的类型注册方式。

// In Startup.cs
public void ConfigureServices(IServiceCollection services)
{
    ...

    // Register additional types with dependency injection.
    services.AddSingleton<BankService>();
}

每个 actor 实例都有自己的依赖注入范围，并在执行操作后在内存中保留一段时间。在此期间，也会考虑与 actor 相关联的依赖注入范围是活动的。当 actor 被停用时，将释放该作用域。

如果一个actor在构造函数中注入一个 IServiceProvider ，该actor将收到一个与它的作用域相关联的 IServiceProvider 的引用。 IServiceProvider 可以用来在将来动态地解析服务。

internal class MyActor : Actor, IMyActor, IRemindable
{
    public MyActor(ActorHost host, IServiceProvider services) // Accept IServiceProvider in the constructor
        : base(host)
    {
        ...
    }
}

在使用这种模式时，要注意避免创建许多实现 IDisposable 的 transient 服务的实例。由于与一个 actor 相关联的作用域可以被认为是长期有效的，所以你可以在内存中积累许多服务。查看更多信息，请参阅依赖注入指南。

IDisposable 和 actors

Actor 可以实现 IDisposable 或 IAsyncDisposable。建议您依靠依赖关系注入进行资源管理，而不是在应用程序代码中实现释放功能。在极少数情况下，在确实有必要的情况下提供处置支持。

日志

在一个 actor 类中，你可以通过基类 Actor 上的属性访问 ILogger 的实例。该实例连接到 ASP.NET Core 日志系统，应该用于 actor 内部的所有日志记录。阅读有关日志记录的更多信息。您可以配置各种不同的日志格式和输出接收器。

您应该使用 结构化日志 与 命名的占位符 类似于下面的示例：

public Task<MyData> GetDataAsync()
{
    this.Logger.LogInformation("Getting state at {CurrentTime}", DateTime.UtcNow);
    return this.StateManager.GetStateAsync<MyData>("my_data");
}

在日志记录时，避免使用格式字符串如：$"获取状态于 {DateTime.UtcNow}"

日志应该使用named placeholder syntax，它提供了更好的性能和与日志系统的集成。

使用显式的actor类型名称

默认情况下，客户端所看到的actor的_type_来自actor实现类的_name_。默认名称将是类名 (不含命名空间)。

如果需要，你可以通过向actor实现类附加一个 ActorAttribute 特性来指定一个显式的类型名称。

[Actor(TypeName = "MyCustomActorTypeName")]
internal class MyActor : Actor, IMyActor
{
    // ...
}

在上面的示例中，名称将是 MyCustomActorTypename。

无需更改以运行时注册 actor类型的代码，只需通过属性提供值。

在服务器上托管 Actors

注册 Actor

Actor 注册是 Startup.cs 中 ConfigureServices 的一部分。您可以通过ConfigureServices方法使用依赖注入注册服务。注册一组 actor 类型是 actor 服务的注册的一部分。

在 ConfigureServices 中，您可以:

注册 actor 运行时 (AddActors)
注册 actor 类型 (options.Actors.RegisterActor<>)
配置 actor 运行时设置 options
注册额外的服务类型以便将依赖注入到Actors中（services）

// In Startup.cs
public void ConfigureServices(IServiceCollection services)
{
    // Register actor runtime with DI
    services.AddActors(options =>
    {
        // Register actor types and configure actor settings
        options.Actors.RegisterActor<MyActor>();
        
        // Configure default settings
        options.ActorIdleTimeout = TimeSpan.FromMinutes(10);
        options.ActorScanInterval = TimeSpan.FromSeconds(35);
        options.DrainOngoingCallTimeout = TimeSpan.FromSeconds(35);
        options.DrainRebalancedActors = true;
    });

    // Register additional services for use with actors
    services.AddSingleton<BankService>();
}

配置 JSON 选项

演员运行时使用System.Text.Json来进行：

将数据序列化到状态存储
处理来自弱类型客户端的请求

默认情况下，actor运行时使用基于JsonSerializerDefaults.Web的设置。

您可以将 JsonSerializerOptions 配置为 ConfigureServices 的一部分：

// In Startup.cs
public void ConfigureServices(IServiceCollection services)
{
    services.AddActors(options =>
    {
        ...
        
        // Customize JSON options
        options.JsonSerializerOptions = ...
    });
}

Actor 和路由

ASP.NET Core对于actors的托管支持使用了endpoint routing系统。 .NET SDK 不提供支持托管 Actors 的早期 ASP.NET Core版本的遗留路由系统。

由于 actors 使用端点路由，因此 actors HTTP 处理程序是中间件管道的一部分。下面是一个使用 actors 设置中间件管道的 Configure 方法的最小示例。

// in Startup.cs
public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    if (env.IsDevelopment())
    {
        app.UseDeveloperExceptionPage();
    }

    app.UseRouting();

    app.UseEndpoints(endpoints =>
    {
        // Register actors handlers that interface with the Dapr runtime.
        endpoints.MapActorsHandlers();
    });
}

调用 UseRouting 和 UseEndpoints 是配置路由所必需的。通过在中间件内部添加MapActorsHandlers，将Actors配置为管道的一部分。

这是一个最小的示例，它对 Actor 功能与以下功能一起存在是有效的：

Controllers
Razor Pages
Blazor
gRPC 服务
Dapr 发布/订阅处理
其他端点，如健康检查

有问题的中间件

某些中间件可能会干扰 Dapr 请求到 actor 处理程序的路由。特别是，对于Dapr的默认配置，UseHttpsRedirection是有问题的。 Dapr 默认会通过未加密的 HTTP 发送请求，然后会被 UseHttpsRedirection 中间件阻止。这个中间件目前不能与 Dapr 一起使用。

// in Startup.cs
public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    if (env.IsDevelopment())
    {
        app.UseDeveloperExceptionPage();
    }

    // INVALID - this will block non-HTTPS requests
    app.UseHttpsRedirection();
    // INVALID - this will block non-HTTPS requests

    app.UseRouting();

    app.UseEndpoints(endpoints =>
    {
        // Register actors handlers that interface with the Dapr runtime.
        endpoints.MapActorsHandlers();
    });
}

下一步

试试运行和使用 virtual actors 示例.

Feedback

Was this page helpful?

Glad to hear it! Please tell us how we can improve.

Sorry to hear that. Please tell us how we can improve.