title: Orleans生命周期

概述

Orleans的一些行为足够复杂，需要有序的启动和关闭。 一些具有这种行为的组件包括Grain、Silo和客户端。 为了解决这个问题，我们引入了一个通用的组件生命周期模式。 该模式由一个可观察的生命周期和生命周期观察者组成，前者负责对组件的启动和关闭阶段发出信号，后者负责在特定阶段执行启动或关闭操作。

也可参见Grain生命周期和Silo生命周期。

可观察生命周期

需要有序启动和关闭的组件可以使用一个可观察的生命周期，它允许其他组件观察其生命周期，并在启动或关闭期间的某个阶段接收通知。

  1.     public interface ILifecycleObservable
  2.     {
  3.         IDisposable Subscribe(string observerName, int stage, ILifecycleObserver observer);
  4.     }

订阅调用注册了一个观察者，以便在启动或停止期间到达某个阶段时进行通知。观察者的名称用于报告。“阶段”表示在启动/关闭序列中的何处，观察者将被通知。生命周期的每个阶段都是可观察的。在启动和停止期间到达该阶段时，所有观察者都会收到通知。各个阶段是按升序启动，降序停止的。观察者可以通过释放返回的IDisposable来取消订阅。

生命周期观察者

需要参与另一个组件的生命周期的组件需要为其启动和关闭行为提供钩子，并订阅可观察的生命周期的某个阶段。

  1.     public interface ILifecycleObserver
  2.     {
  3.         Task OnStart(CancellationToken ct);
  4.         Task OnStop(CancellationToken ct);
  5.     }

OnStart/OnStop将在启动/关闭过程期间到达订阅的阶段时被调用。

辅助工具

为方便起见，我们为常见的生命周期使用模式创建了帮助函数。

扩展函数

我们提供了用于订阅可观察生命周期的扩展函数，它不要求订阅组件实现ILifecycleObserver。相反，这些函数允许组件传入lambda表达式或成员函数，以便在订阅阶段调用。

  1. IDisposable Subscribe(this ILifecycleObservable observable, string observerName, int stage, Func<CancellationToken, Task> onStart, Func<CancellationToken, Task> onStop);
  3. IDisposable Subscribe(this ILifecycleObservable observable, string observerName, int stage, Func<CancellationToken, Task> onStart);

类似的扩展函数允许使用泛型参数来代替观察者名称。

  1. IDisposable Subscribe<TObserver>(this ILifecycleObservable observable, int stage, Func<CancellationToken, Task> onStart, Func<CancellationToken, Task> onStop);
  3. IDisposable Subscribe<TObserver>(this ILifecycleObservable observable, int stage, Func<CancellationToken, Task> onStart);

参与生命周期

一些可扩展点需要一种方法来识别哪些组件对参与生命周期感兴趣。为此，我们引入了一个生命周期参与者标记接口。在探索Silo和Grain生命周期时，将涉及更多关于如何使用这个接口的内容。

  1.     public interface ILifecycleParticipant<TLifecycleObservable>
  2.         where TLifecycleObservable : ILifecycleObservable
  3.     {
  4.         void Participate(TLifecycleObservable lifecycle);
  5.     }

示例

从我们的生命周期测试来看，下面是一个组件在生命周期的多个阶段参加可观察的生命周期的例子：

  1. enum TestStages
  2. {
  3.     Down,
  4.     Initialize,
  5.     Configure,
  6.     Run,
  7. }
  9. class MultiStageObserver : ILifecycleParticipant<ILifecycleObservable>
  10. {
  11.     public Dictionary<TestStages,bool> Started { get; } = new Dictionary<TestStages, bool>();
  12.     public Dictionary<TestStages, bool> Stopped { get; } = new Dictionary<TestStages, bool>();
  14.     private Task OnStartStage(TestStages stage)
  15.     {
  16.         this.Started[stage] = true;
  17.         return Task.CompletedTask;
  18.     }
  20.     private Task OnStopStage(TestStages stage)
  21.     {
  22.         this.Stopped[stage] = true;
  23.         return Task.CompletedTask;
  24.     }
  26.     public void Participate(ILifecycleObservable lifecycle)
  27.     {
  28.         lifecycle.Subscribe<MultiStageObserver>((int)TestStages.Down, ct => OnStartStage(TestStages.Down), ct => OnStopStage(TestStages.Down));
  29.         lifecycle.Subscribe<MultiStageObserver>((int)TestStages.Initialize, ct => OnStartStage(TestStages.Initialize), ct => OnStopStage(TestStages.Initialize));
  30.         lifecycle.Subscribe<MultiStageObserver>((int)TestStages.Configure, ct => OnStartStage(TestStages.Configure), ct => OnStopStage(TestStages.Configure));
  31.         lifecycle.Subscribe<MultiStageObserver>((int)TestStages.Run, ct => OnStartStage(TestStages.Run), ct => OnStopStage(TestStages.Run));
  32.     }
  33. }