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

chester·chen發表於2024-03-26
分散式

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));
}

相關文章