.NET分佈式Orleans - 3 - Grain放置

在Orleans 7中，Grain放置是指確定將Grain對象放置在Orleans集羣中的哪些物理節點上的過程。

Grain是Orleans中的基本單位，代表應用程序中的邏輯單元或實體。Grain放置策略是一種機制，用於根據不同的因素，將Grain對象放置在合適的節點上，以實現負載均衡、最小化網絡延遲和提高容錯性。

Grain放置的概念

Grain放置是指將Grain對象放置在Orleans集羣中的物理節點上的過程。每個Grain對象都有一個唯一的標識符，Orleans根據Grain對象的標識符以及放置策略來決定將Grain對象放置在哪個節點上。

Grain放置的依據

Orleans 7中Grain放置的依據主要包括：

• 負載均衡：確保集羣中的每個節點負載儘可能均衡，避免某些節點負載過重。
• 網絡拓撲：考慮物理網絡拓撲結構，將Grain對象放置在合適的物理節點上，以減少通信延遲。
• 容錯性：確保Grain對象在集羣中的高可用性和容錯性，避免單點故障。

Grain放置策略

Orleans 7中常見的Grain放置策略包括：

• RandomPlacement：隨機選擇一個可用節點來放置Grain對象。這也是默認的策略。
• ActivationCountBasedPlacement：根據節點上已激活的Grain對象數量選擇當前負載最輕的節點來放置Grain對象，以實現負載均衡。
• PreferLocalPlacement：優先將Grain對象放置在發起調用的本地節點上，以減少跨節點通信的延遲。
• CustomPlacement：允許用戶根據特定需求自定義Grain放置策略。

配置默認放置策略

Orleans 默認將使用隨機放置。 可以通過在配置期間註冊實現 PlacementStrategy 來重寫默認放置策略：

siloBuilder.ConfigureServices(services =>
    services.AddSingleton<PlacementStrategy, MyPlacementStrategy>());

自定義標記屬性以節省網絡開銷

如果希望將不同Client的Grain對象放置在同一個Silo上，以節省網絡開銷，可以使用自定義標記屬性和自定義放置策略來實現。

下面的代碼是個例子，在一個遊戲中，可以爲每個玩家定義一個唯一的標記屬性，然後使用自定義放置策略確保具有相同標記屬性的Grain對象被放置在同一個Silo上。

這樣，同一遊戲中不同玩家的Grain對象就可以在同一個Silo上處理，減少了跨網絡的通信開銷。

public interface IPlayerGrain : IGrainWithStringKey
{
    Task<string> GetPlayerInfo();
}

[SameGamePlacementStrategy]
public class PlayerGrain : Grain, IPlayerGrain
{
    public Task<string> GetPlayerInfo()
    {
        return Task.FromResult($"Player ID: {this.GetPrimaryKeyString()}");
    }
}

// 自定義 IPlacementDirector，用於指定將相同遊戲中的不同玩家放置在同一個 Silo 上
public class SameGamePlacementDirector : IPlacementDirector
{
    public Task<SiloAddress> OnAddActivation(
        PlacementStrategy strategy,
        PlacementTarget target,
        IPlacementContext context)
    {
        // 獲取遊戲 ID，這裏簡單假設遊戲 ID 是整數類型
        int gameId = int.Parse(target.GrainIdentity.Key.ToString().Split('#')[0]);
        // 將遊戲 ID 映射到 Silo 的哈希值
        int hashCode = gameId.GetHashCode();
        // 獲取 Silo 集羣中的 Silo 列表
        var silos = context.GetCompatibleSilos(target).ToArray();
        // 計算 Silo 的索引
        int index = Math.Abs(hashCode % silos.Length);
        // 返回被選中的 Silo 地址
        return Task.FromResult(silos[index]);
    }
}
// 自定義 PlacementStrategy，用於指定使用自定義的 IPlacementDirector
[Serializable]
public sealed class SameGamePlacementStrategy : PlacementStrategy
{

}

[AttributeUsage(AttributeTargets.Class, AllowMultiple = false)]
public sealed class SameGamePlacementStrategyAttribute : PlacementAttribute
{
    public SameGamePlacementStrategyAttribute() : base(new SameGamePlacementStrategy())
    {
    }
}
class Program
{
    static async Task Main(string[] args)
    {
        var host = Host.CreateDefaultBuilder()
            .ConfigureServices((context, services) =>
            {
                services.AddOrleans(builder =>
                {
                    builder
                        .UseLocalhostClustering()
                        .Configure<ClusterOptions>(options =>
                        {
                            options.ClusterId = "dev";
                            options.ServiceId = "OrleansExample";
                        })
                        .AddMemoryGrainStorage("playerGrainStorage")
                        .AddPlacementDirector<SameGamePlacementStrategy>(sp => new SameGamePlacementDirector()); ;
                }); ;

            })
            .ConfigureLogging(l => l.AddConsole())
            .Build();

        await host.StartAsync();

        var client = host.Services.GetRequiredService<IClusterClient>();
        var gameId = "123";
        var pId = gameId + "#" + Guid.NewGuid().ToString("N");
        var a = await client.GetGrain<IPlayerGrain>(pId).GetPlayerInfo();

        Console.ReadKey();

        await host.StopAsync();
    }
}