Orleans 7.0中如何正确注册GrainService？

问题背景 #

在Orleans 7.0中尝试注册自定义GrainService，已实现IAlfaGrainService接口、AlfaGrainService服务类，以及用于Grain调用的AlfaGrainServiceClient客户端类和调用该客户端的AlfaGrain。使用.AddGrainService<AlfaGrainService>()注册并注入客户端后，启动应用时出现无法找到AlfaGrainService合适构造函数的错误，推测是GrainServiceFactory无法实例化带多参数的构造函数，且旧版官方文档不适用于当前场景。

核心原因 #

Orleans 7.0对GrainService的构造函数注入规则进行了调整：不再支持直接通过DI容器注入任意依赖，要求GrainService必须使用包含GrainServiceContext的构造函数签名，额外依赖需通过该上下文的ServiceProvider获取。

正确实现步骤 #

1. 调整GrainService构造函数：必须包含GrainServiceContext参数并传递给基类，额外依赖从context.ServiceProvider中获取
2. 正确注册服务与客户端：通过siloBuilder.AddGrainService<T>()注册GrainService，同时将客户端类注册到DI容器
3. 客户端正确获取GrainService代理：通过IGrainFactory获取GrainService的代理实例，使用正确的GrainId标识

代码示例 #

1. 修改AlfaGrainService构造函数 #

public class AlfaGrainService : GrainService, IAlfaGrainService
{
    private readonly ILogger<AlfaGrainService> _logger;
    private readonly IMyDependency _myDependency;

    // 必须包含GrainServiceContext参数，并传递给基类
    public AlfaGrainService(GrainServiceContext context, ILogger<AlfaGrainService> logger)
        : base(context)
    {
        _logger = logger;
        // 从ServiceProvider获取额外依赖
        _myDependency = context.ServiceProvider.GetRequiredService<IMyDependency>();
    }

    // 实现IAlfaGrainService接口方法
    public Task<string> GetMessageAsync()
    {
        return Task.FromResult($"来自AlfaGrainService的消息: {_myDependency.GetValue()}");
    }
}

2. 服务注册（Program.cs） #

var builder = WebApplication.CreateBuilder(args);

builder.Host.UseOrleans(siloBuilder =>
{
    siloBuilder
        // 注册GrainService
        .AddGrainService<AlfaGrainService>()
        .ConfigureServices(services =>
        {
            // 注册GrainService客户端，供Grain注入使用
            services.AddTransient<IAlfaGrainServiceClient, AlfaGrainServiceClient>();
            // 注册自定义依赖
            services.AddSingleton<IMyDependency, MyDependency>();
        });
});

var app = builder.Build();
app.Run();

3. AlfaGrainServiceClient实现 #

public class AlfaGrainServiceClient : IAlfaGrainServiceClient
{
    private readonly IGrainFactory _grainFactory;

    public AlfaGrainServiceClient(IGrainFactory grainFactory)
    {
        _grainFactory = grainFactory;
    }

    public async Task<string> GetMessageAsync()
    {
        // 使用GrainId标识GrainService，主键通常为服务名称
        var grainService = _grainFactory.GetGrain<IAlfaGrainService>(GrainId.Create("AlfaGrainService"));
        return await grainService.GetMessageAsync();
    }
}

4. Grain中调用客户端 #

public class AlfaGrain : Grain, IAlfaGrain
{
    private readonly IAlfaGrainServiceClient _client;

    public AlfaGrain(IAlfaGrainServiceClient client)
    {
        _client = client;
    }

    public async Task<string> GetGrainServiceMessageAsync()
    {
        return await _client.GetMessageAsync();
    }
}

关键注意点 #

• GrainService必须继承GrainService基类，构造函数必须包含GrainServiceContext
• 禁止在GrainService构造函数中直接注入除GrainServiceContext、ILogger<T>之外的依赖，必须通过context.ServiceProvider获取
• GrainService的GrainId需保持唯一，通常使用服务类名称作为主键
• 客户端必须通过IGrainFactory获取GrainService代理，不能直接实例化GrainService类

内容的提问来源于stack exchange，提问作者Petofi