サーバープロトコル作成ガイド

プロトコル選択

詳細パターンとコード例: references/protocol-patterns.md を参照。

Request-Response型の作成手順

Step 1: プロトコルクラスを作成

moorestech_server/Assets/Scripts/Server.Protocol/PacketResponse/ に新規ファイルを作成。

csharp
1using System;
2using System.Collections.Generic;
3using MessagePack;
4using Server.Protocol;
5
6namespace Server.Protocol.PacketResponse
7{
8    public class YourProtocol : IPacketResponse
9    {
10        public const string ProtocolTag = "va:yourProtocol";
11
12        private readonly ISomeDependency _dependency;
13
14        public YourProtocol(ServiceProvider serviceProvider)
15        {
16            _dependency = serviceProvider.GetService<ISomeDependency>();
17        }
18
19        public ProtocolMessagePackBase GetResponse(byte[] payload)
20        {
21            var data = MessagePackSerializer.Deserialize<YourRequestMessagePack>(payload);
22            // ビジネスロジック
23            return new YourResponseMessagePack(/* result */);
24        }
25
26        #region MessagePack
27
28        [MessagePackObject]
29        public class YourRequestMessagePack : ProtocolMessagePackBase
30        {
31            // Key(0)=Tag, Key(1)=SequenceId は基底クラスで予約済み
32            [Key(2)] public int SomeField { get; set; }
33
34            [Obsolete("デシリアライズ用のコンストラクタです。基本的に使用しないでください。")]
35            public YourRequestMessagePack() { }
36
37            public YourRequestMessagePack(int someField)
38            {
39                Tag = ProtocolTag;
40                SomeField = someField;
41            }
42        }
43
44        [MessagePackObject]
45        public class YourResponseMessagePack : ProtocolMessagePackBase
46        {
47            [Key(2)] public string ResultData { get; set; }
48
49            [Obsolete("デシリアライズ用のコンストラクタです。基本的に使用しないでください。")]
50            public YourResponseMessagePack() { }
51
52            public YourResponseMessagePack(string resultData)
53            {
54                Tag = ProtocolTag;
55                ResultData = resultData;
56            }
57        }
58
59        #endregion
60    }
61}

Step 2: PacketResponseCreatorに登録

moorestech_server/Assets/Scripts/Server.Protocol/PacketResponseCreator.cs のコンストラクタに追加:

csharp
1_packetResponseDictionary.Add(YourProtocol.ProtocolTag, new YourProtocol(serviceProvider));

Step 3: テストを作成

/creating-server-tests スキルを使用してテストを作成。配置先: Tests/CombinedTest/Server/PacketTest/

Step 4: コンパイル確認

MCPツールまたはunity-test.shでコンパイルを確認。

Event型の作成手順

Step 1: イベントパケットクラスを作成

moorestech_server/Assets/Scripts/Server.Event/EventReceive/ に新規ファイルを作成。

csharp
1using System;
2using Game.Context;
3using MessagePack;
4using Server.Event;
5
6namespace Server.Event.EventReceive
7{
8    public class YourEventPacket
9    {
10        public const string EventTag = "va:event:yourEvent";
11        private readonly EventProtocolProvider _eventProtocolProvider;
12
13        public YourEventPacket(EventProtocolProvider eventProtocolProvider)
14        {
15            _eventProtocolProvider = eventProtocolProvider;
16            // ゲームイベントを購読（UniRx .Subscribe）
17            ServerContext.SomeEvent.OnSomething.Subscribe(OnSomething);
18        }
19
20        private void OnSomething(SomeEventData eventData)
21        {
22            var messagePack = new YourEventMessagePack(eventData.Value);
23            var payload = MessagePackSerializer.Serialize(messagePack);
24
25            // 全プレイヤー: AddBroadcastEvent / 特定プレイヤー: AddEvent(playerId, ...)
26            _eventProtocolProvider.AddBroadcastEvent(EventTag, payload);
27        }
28
29        #region MessagePack
30
31        [MessagePackObject]
32        public class YourEventMessagePack
33        {
34            // EventのMessagePackはProtocolMessagePackBaseを継承しない。Key(0)から開始
35            [Key(0)] public string Value { get; set; }
36
37            [Obsolete("デシリアライズ用のコンストラクタです。基本的に使用しないでください。")]
38            public YourEventMessagePack() { }
39
40            public YourEventMessagePack(string value)
41            {
42                Value = value;
43            }
44        }
45
46        #endregion
47    }
48}

Step 2: イベントパケットを初期化

イベントを発火する責任を持つシステムのコンストラクタでインスタンス化し、フィールドに保持する（GC防止）。

例: ブロック配置イベント → BlockUpdateSystemで初期化、レールノード作成イベント → RailGraphDatastore関連で初期化。

Step 3: テストを作成

/creating-server-tests スキルを使用。配置先: Tests/CombinedTest/Server/PacketTest/Event/

Step 4: コンパイル確認

MCPツールまたはunity-test.shでコンパイルを確認。

注意事項

• タグの一意性を必ず確認する（既存タグと重複しないこと）
• MessagePackのKey番号: Request/ResponseはKey(2)から、EventデータはKey(0)から
• [Obsolete]付き引数なしコンストラクタは省略不可
• イベント購読はUniRxの.Subscribe()を使用（/csharp-event-pattern参照）
• コードのコメントは日本語・英語の2行セット