🎉 feat(event): 添加GenerateSerializer和IdAttribute

Author: feijie999

examples/Transfer.Grains/Snapshot/AccountSnapshot.cs

@@ -1,12 +1,26 @@
-using Vertex.Abstractions.Serialization;
+using Orleans;
+using Vertex.Abstractions.Serialization;
 using Vertex.Transaction.Abstractions.Snapshot;
 
 namespace Transfer.Grains.Snapshot
 {
+    /// <summary>
+    /// 账户快照类
+    /// </summary>
+    [GenerateSerializer]
     public class AccountSnapshot : ITxSnapshot<AccountSnapshot>
     {
+        /// <summary>
+        /// 账户余额
+        /// </summary>
+        [Id(0)]
         public decimal Balance { get; set; }
 
+        /// <summary>
+        /// 克隆当前快照
+        /// </summary>
+        /// <param name="serializer">序列化器</param>
+        /// <returns>克隆的账户快照</returns>
         public AccountSnapshot Clone(ISerializer serializer)
         {
             return new AccountSnapshot
@@ -15,4 +29,4 @@ public AccountSnapshot Clone(ISerializer serializer)
             };
         }
     }
-}
+}

src/Vertex.Abstractions/Event/EventDocument.cs

@@ -1,17 +1,26 @@
-namespace Vertex.Abstractions.Event
+using Orleans;
+
+namespace Vertex.Abstractions.Event
 {
+    [GenerateSerializer]
     public class EventDocument<TPrimaryKey>
     {
+        [Id(0)]
         public string FlowId { get; set; }
 
+        [Id(1)]
         public TPrimaryKey ActorId { get; set; }
 
+        [Id(2)]
         public string Name { get; set; }
 
+        [Id(3)]
         public string Data { get; set; }
 
+        [Id(4)]
         public long Timestamp { get; set; }
 
+        [Id(5)]
         public long Version { get; set; }
     }
-}
+}

src/Vertex.Abstractions/Event/EventDocumentDto.cs

@@ -1,15 +1,23 @@
-namespace Vertex.Abstractions.Event
+using Orleans;
+
+namespace Vertex.Abstractions.Event
 {
+    [GenerateSerializer]
     public class EventDocumentDto
     {
+        [Id(0)]
         public string Name { get; set; }
 
+        [Id(1)]
         public string Data { get; set; }
 
+        [Id(2)]
         public string FlowId { get; set; }
 
+        [Id(3)]
         public long Timestamp { get; set; }
 
+        [Id(4)]
         public long Version { get; set; }
     }
 }

src/Vertex.Abstractions/Event/EventMeta.cs

@@ -1,23 +1,29 @@
-using Orleans.Concurrency;
+using Orleans;
 
 namespace Vertex.Abstractions.Event
 {
     /// <summary>
-    /// Record the meta information of the event
+    /// 记录事件的元信息
     /// </summary>
-    [Orleans.Immutable]
-    public record EventMeta
+    [GenerateSerializer]
+    public class EventMeta
     {
+        /// <summary>
+        /// 流程ID
+        /// </summary>
+        [Id(0)]
         public string FlowId { get; set; }
 
         /// <summary>
-        /// Used to describe the sequence of events produced by an actor
+        /// 用于描述由演员生成的事件序列
         /// </summary>
+        [Id(1)]
         public long Version { get; init; }
 
         /// <summary>
-        /// Records the timestamp generated by the event, accurate to seconds
+        /// 记录事件生成的时间戳，精确到秒
         /// </summary>
+        [Id(2)]
         public long Timestamp { get; init; }
     }
-}
+}

src/Vertex.Abstractions/Event/EventUnit.cs

@@ -1,15 +1,20 @@
-namespace Vertex.Abstractions.Event
+using Orleans;
+
+namespace Vertex.Abstractions.Event
 {
     /// <summary>
     /// A typed wrapper for an event that contains details about the event.
     /// </summary>
     /// <typeparam name="TPrimaryKey">The type of the entity's key.</typeparam>
+    [GenerateSerializer]
     public class EventUnit<TPrimaryKey>
     {
-        public IEvent Event { get; set; }
+        [Id(0)]
+        public TPrimaryKey ActorId { get; set; }
 
+        [Id(1)]
         public EventMeta Meta { get; set; }
-
-        public TPrimaryKey ActorId { get; set; }
+        
+        public IEvent Event { get; set; }
     }
 }

src/Vertex.Abstractions/Snapshot/SnapshotMeta.cs

@@ -1,17 +1,47 @@
-namespace Vertex.Abstractions.Snapshot
+using Orleans;
+
+namespace Vertex.Abstractions.Snapshot
 {
+    /// <summary>
+    /// 快照元数据类
+    /// </summary>
+    [GenerateSerializer]
     public record SnapshotMeta<TPrimaryKey>
     {
+        /// <summary>
+        /// 演员ID
+        /// </summary>
+        [Id(0)]
         public TPrimaryKey ActorId { get; set; }
 
+        /// <summary>
+        /// 正在处理的版本
+        /// </summary>
+        [Id(1)]
         public long DoingVersion { get; set; }
 
+        /// <summary>
+        /// 版本
+        /// </summary>
+        [Id(2)]
         public long Version { get; set; }
 
+        /// <summary>
+        /// 最小事件时间戳
+        /// </summary>
+        [Id(3)]
         public long MinEventTimestamp { get; set; }
 
+        /// <summary>
+        /// 最小事件版本
+        /// </summary>
+        [Id(4)]
         public long MinEventVersion { get; set; }
 
+        /// <summary>
+        /// 是否是最新的
+        /// </summary>
+        [Id(5)]
         public bool IsLatest { get; set; }
     }
-}
+}

src/Vertex.Abstractions/Snapshot/SnapshotUnit.cs

@@ -1,10 +1,15 @@
-namespace Vertex.Abstractions.Snapshot
+using Orleans;
+
+namespace Vertex.Abstractions.Snapshot
 {
+    [GenerateSerializer]
     public record SnapshotUnit<TPrimaryKey, T>
         where T : ISnapshot
     {
+        [Id(0)]
         public SnapshotMeta<TPrimaryKey> Meta { get; set; }
 
+        [Id(1)]
         public T Data { get; set; }
     }
 }

src/Vertex.Abstractions/Snapshot/SubSnapshot.cs

@@ -1,11 +1,26 @@
-namespace Vertex.Abstractions.Snapshot
+using Orleans;
+
+namespace Vertex.Abstractions.Snapshot
 {
+    /// <summary>
+    /// 子快照类
+    /// </summary>
+    [GenerateSerializer]
     public record SubSnapshot<TPrimaryKey>
     {
+        [Id(0)]
         public TPrimaryKey ActorId { get; set; }
 
+        /// <summary>
+        /// 正在处理的版本
+        /// </summary>
+        [Id(1)]
         public long DoingVersion { get; set; }
 
+        /// <summary>
+        /// 版本
+        /// </summary>
+        [Id(2)]
         public long Version { get; set; }
     }
-}
+}

src/Vertex.Abstractions/Vertex.Abstractions.csproj

@@ -2,6 +2,7 @@
 <Sdk Name="Microsoft.Build.CentralPackageVersions" />
   <ItemGroup>
     <PackageReference Include="Microsoft.Orleans.Core.Abstractions" />
+    <PackageReference Include="Microsoft.Orleans.CodeGenerator" />
   </ItemGroup>
 
 </Project>

src/Vertex.Runtime/Options/ActorOptions.cs

@@ -1,20 +1,26 @@
-namespace Vertex.Runtime.Options
+using Orleans;
+
+namespace Vertex.Runtime.Options
 {
+    [GenerateSerializer]
     public class ActorOptions
     {
         /// <summary>
         /// Event Version interval of RayGrain saving snapshot
         /// </summary>
+        [Id(0)]
         public int SnapshotVersionInterval { get; set; } = 500;
 
         /// <summary>
         /// The minimum event Version interval for saving snapshots when RayGrain is deactivated
         /// </summary>
+        [Id(1)]
         public int MinSnapshotVersionInterval { get; set; } = 1;
 
         /// <summary>
         /// The amount of data read each time when reading events in batches
         /// </summary>
+        [Id(2)]
         public int EventPageSize { get; set; } = 2000;
     }
 }