.NET分佈式Orleans - 4 - 計時器和提醒

Timer是什麼

Timer 是一種用於創建定期粒度行爲的機制。

與標準的 .NET System.Threading.Timer 類相似，Orleans 的 Timer 允許在一段時間後執行特定的操作，或者在特定的時間間隔內重複執行操作。

它在分佈式系統中具有重要作用，特別是在處理需要週期性執行的任務時非常有用。

Timer的注意事項

1. 計時器回調不會改變空閒激活的狀態，不能用於推遲其他空閒激活的停用。

2. Grain.RegisterTimer 中傳遞的時間段取決於上次回調完成到下一次回調開始的時間，因此回調的頻率會受到執行時間的影響。

3. 每次 asyncCallback 調用都會作爲單獨輪次的激活，並且不會與同一激活的其他輪次同時運行。

代碼示例

public class PlayerGrain : Grain, IPlayerGrain
{
    public Task<string> GetPlayerInfo()
    {
        var timer = RegisterTimer(DoSomething, null, TimeSpan.FromSeconds(1), TimeSpan.FromSeconds(2));
        return Task.FromResult($"Player ID: {this.GetPrimaryKeyString()}");
    }

    private async Task DoSomething(object state)
    {
        // 在這裏定義要執行的操作
        await Task.Delay(5000);
        Console.WriteLine($"{DateTime.Now.ToString("yyyy-MM-dd HH:mm:ss")} Timer Triggered: {this.GetPrimaryKeyString()}");
    }
}

Reminder與Timer的區別

提醒（Reminder）是一種在 Orleans 中用於處理週期性任務的機制，與計時器類似，但具有一些重要區別：

1. 永久性觸發：提醒是永久性的，除非明確取消，否則會在幾乎所有情況下（包括部分或完整羣集重啓）繼續觸發。

2. 定義的持久性：提醒的定義會寫入存儲，但具體的事件及其時間不會。這意味着如果羣集在提醒應該觸發時關閉，它將錯過該提醒，只會在下次提醒的觸發時被重新激活。

3. 關聯於Grain：提醒是與Grain關聯的，而不是與任何特定激活Grain。如果提醒的觸發時，粒度沒有與之關聯的激活，則會創建該Grain，並在下次觸發時重新激活。

4. 消息傳遞：提醒的傳遞通過消息發生，受到與所有其他粒度方法相同的交錯語義的約束。

5. 適用場景：提醒通常不適用於高頻計時器，其週期應該以分鐘、小時或天爲單位。相比之下，提醒更適用於週期性任務的處理，例如定期執行清理任務或發送通知等。

如果想使用reminder，需要安裝nuget包

<PackageReference Include="Microsoft.Orleans.Reminders" Version="8.0.0" />

並開啓reminder

silBuilder.UseInMemoryReminderService();

Grain需要實現接口 IRemindable ，並使用this.RegisterOrUpdateReminder 註冊reminder

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

public class PlayerGrain : Grain, IPlayerGrain
{
    public Task<string> GetPlayerInfo()
    {
        this.RegisterOrUpdateReminder("myReminder", TimeSpan.FromSeconds(5), TimeSpan.FromMinutes(1));
        return Task.FromResult($"Player ID: {this.GetPrimaryKeyString()}");
    }

    public Task ReceiveReminder(string reminderName, TickStatus status)
    {
        Console.WriteLine($"{DateTime.Now.ToString("yyyy-MM-dd HH:mm:ss")} Reminder Triggered: {this.GetPrimaryKeyString()}");return Task.CompletedTask;
    }
}

Timer 和 Reminder 場景

使用定時器（Timer）的場景：

1. 對激活狀態的要求不高：如果激活被停用或發生故障時，計時器停止運行不會產生重大影響，或者這種行爲可接受。
2. 較小的分辨率：如果需要較小的時間間隔來執行任務，例如以秒或分鐘爲單位。
3. 計時器回調與 Grain 生命週期相關：如果需要在 Grain 的生命週期事件（如OnActivateAsync()）或者調用粒度方法時啓動計時器回調。

使用提醒（Reminder）的場景：

1. 持久性要求：當需要確保週期性行爲在激活和任何故障中都存在時，提醒是一個更好的選擇。因爲提醒是永久性的，除非明確取消，否則會在幾乎所有情況下繼續觸發。
2. 較大的時間間隔：當執行不常見的任務，例如以分鐘、小時或天爲單位的週期性任務時，提醒更爲適合。

依賴注入創建Timer與Reminder

將 ITimerRegistry 或 IReminderRegistry 注入粒度的構造函數中，也可以創建Timer與Reminder

public PlayerGrain(ITimerRegistry timerRegistry,
IReminderRegistry reminderRegistry,
IGrainContext grainContext)
{
    timerRegistry.RegisterTimer(grainContext,DoSomething,null, TimeSpan.FromSeconds(1), TimeSpan.FromSeconds(2));
    reminderRegistry.RegisterOrUpdateReminder(grainContext.GrainId,"testreminder",TimeSpan.FromSeconds(5), TimeSpan.FromMinutes(1));
}