Actor-ES框架：Actor编写-ESGrain与ESRepGrain

ESGrain

生命周期

Ray中ESGrain继承自Grain扩展了Grain的生命周期。Grain的生命周期参加文档附录：1-Grain生命周期-译注.md

ESGrain重写了Grain的OnActivateAsync方法。ESGrain的初始化过程如下：

初始化ESGrain中的State
- 调用ReadSnapshotAsync()读快照。
- 如果没有获得快照，调用InitState()根据InitState()中代码初始化ESGrain，InitState()是虚方法，可以被具体的ESGrain重写，以自定义初始化。
读取事件库，重放事件，获得最新的State。

小技巧：在实际开发中，可以重写InitState()，在其中根据关系型数据库中的数据自定义state的初始化。

使用

State

ESGrain的数据存储在State中，当ESGrain被激活后State数据存储在内存中，持久化会存储为快照。定义ESGrain时，需要定义State，实现IState接口，序列化默认使用protocol buffer，State类要添加protocol buffer特性。IState接口定义的是State的基础部分，即示例中的base部分，base之外的是当前actor需要的要存储的数据。

示例代码：

[ProtoContract(ImplicitFields = ImplicitFields.AllFields)] public class AccountState : IState<string> { #region base public string StateId { get; set; } public uint Version { get; set; } public uint DoingVersion { get; set; } public DateTime VersionTime { get; set; } #endregion public decimal Balance { get; set; } }

Event

ESGrain之间通过Event传递数据，Event编写请参考Event编写.md

EventHandles

使用ESGrain引发事件，一般出于两种考虑：1.传递数据到Handler；2.修改State中的数据。修改ESGrain中的数据通过EventHandle中的代码实现。

使用：

实现IEventHandle
在Apply中实现定义要处理的事件。
示例代码：

public class AccountEventHandle : IEventHandle

{

public void Apply(object state, IEvent evt)

{

if (state is AccountState actorState)

{

switch (evt)

{

case AmountAddEvent value: AmountAddEventHandle(actorState, value); break;

case AmountTransferEvent value: AmountTransferEventHandle(actorState, value); break;

default: break;

}

private void AmountTransferEventHandle(AccountState state, AmountTransferEvent evt)

{

state.Balance = evt.Balance;

}

private void AmountAddEventHandle(AccountState state, AmountAddEvent evt)

{

state.Balance = evt.Balance;

}

State中的数据存储在内存中，大量的数据存在State中，在某种角度可以将State看做内存数据库。
Ray中，修改State的数据要通过EventHandle实现（只有一种方式）。

ESGrain种类

Ray默认提供了MongoESGrain和SqlGrain两类。
ESGrain<K, S, W>说明：

K：StateId的类型。
S：ESGrain的State。
W：MessageInfo。

完整ESGrain示例

编写ESGrain时

明确RabbitPub。
明确MongoStorage。
继承MongoESGrain或SqlGrain。
实现ESGrain接口。
如果需要重写OnActivateAsync。
编写感兴趣的Actor方法
如果需要发送事件：1.定义事件；2.编写EventHandler。

[RabbitMQ.RabbitPub("Account", "account")]

[MongoStorage("Test", "Account")]

public sealed class Account : MongoESGrain<String, AccountState, IGrains.MessageInfo>, IAccount

{

protected override string GrainId => this.GetPrimaryKeyString();

static IEventHandle _eventHandle = new AccountEventHandle();

protected override IEventHandle EventHandle => _eventHandle;

public override Task OnActivateAsync()

{

return base.OnActivateAsync();

}

public Task Transfer(string toAccountId, decimal amount)

{

var evt = new AmountTransferEvent(toAccountId, amount, this.State.Balance - amount);

return RaiseEvent(evt).AsTask();

}

public Task AddAmount(decimal amount, string uniqueId = null)

{

var evt = new AmountAddEvent(amount, this.State.Balance + amount);

return RaiseEvent(evt, uniqueId: uniqueId).AsTask();

}

[AlwaysInterleave]

public Task<decimal> GetBalance()

{

return Task.FromResult(this.State.Balance);

}

ESRepGrain

ESGrain默认是主Actor，当单个Actor压力过大时，可以实现该actor的副本actor，副本actor主要用来处理：1.读的操作；2.其他非写的异步操作。

主actor与副本actor之间保持同步的机制：

主actor引发事件，在CoreHandler里将消息传递给副本actor，在副本actor里面重放该事件。
主actor与副本actor持久化的是同一个快照库、事件库。也会从同一个库里激活。

生命周期

与主actor类似。

使用

与ESGrain类似，对比如下：

ESGrain	ESRepGrain
明确RabbitPub	不需要
明确MongoStorage	明确MongoStorage
继承MongoESGrain或SqlGrain	继承MongoESRepGrain或SqlRepGrain
实现ESGrain接口	自定义的副本Actor接口
如果需要重写OnActivateAsync	如果需要重写OnActivateAsync
编写感兴趣的Actor方法	编写感兴趣的Actor方法
如果需要发送事件：1.定义事件；2.编写EventHandler	不会引发事件