ゲームサーバーロジックを実装する過程でログインする場合とユーザーがアイテムを獲得したとき、データベースにアクセスして情報を取得または保存する動作を処理しようとします。このときデータベースを操作するインタフェースを統一しようとするのですが、ゲームロジックを処理する立場ではデータベース操作の内容を具体的に知る必要がないからです。

この場合、Commandパターンを使用してください。要求する側では、具体的な動作には関心を持つ必要がない場合に Command パターンを使用します。呼び出し方法をインタフェースを通じて統一して同じように扱い、さまざまなタスクを同じ方法で要求できるようにします。

以下のコードは例のために作られたもので、具体的な動作はしない擬似コードです。Futureパターンを利用して非同期的に結果をもたらして使用できるようにしました。

						
						  public interface ICommand
						  {
							  Task Execute();
						  }
						  
						  public class LoginCommand : ICommand
						  {
							  private string _username;
							  private string _password;
						  
							  public LoginCommand(string username, string password)
							  {
								  _username = username;
								  _password = password;
							  }
						  
							  public async Task Execute()
							  {
								  // TODO: ログイン処理
								  return true;
							  }
						  }
						  
						  public class SaveItemCommand : ICommand
						  {
							  private string _username;
							  private string _item;
						  
							  public SaveItemCommand(string username, string item)
							  {
								  _username = username;
								  _item = item;
							  }
						  
							  public async Task Execute()
							  {
								  // TODO: アイテム保存処理
								  return true;
							  }
						  }
						
					  

今回の例では簡単に必要な実装で仕上げましたが、Commandパターンはインタフェースを統一するだけでなく、いくつかの追加的な利点があります。以下は、Commandパターンを使用することで得られる利点です。

• 分離とカプセル化：Commandパターンを使用すると、要求を実行するオブジェクトと要求を発生するオブジェクトを分離できます。これにより、要求を実行するロジックをカプセル化して、さまざまな要求を同じ方法で処理できます。
• 再利用と組み合わせ：Commandオブジェクトを再利用してさまざまな操作を実行できます。また、複数のCommandオブジェクトを組み合わせて複雑な操作を実行できます。
• 遅延実行：Commandパターンを使用すると、すぐに要求を実行せずに後で実行できます。これにより、遅延実行、予約実行などの機能を実装することができます。
• キャンセルと再実行：Commandパターンを使用すると、実行した要求をキャンセルまたは再実行できます。これにより Undo/Redo 機能を実装できます。
• ログと履歴：Commandパターンを使用すると、実行した要求をログに記録または保存できます。これにより、システムの状態を復元したり、問題を診断したりできます
• 並列および非同期処理：Commandパターンを使用すると、要求を並列に処理したり非同期に処理したりできます。これにより、システムのパフォーマンスを向上させることができます。
• スケーラビリティ：Commandパターンを使用すると、新しいリクエストを簡単に追加できます。これにより、システムのスケーラビリティを向上させることができます。
• テストの容易さ：Commandパターンを使用すると、要求を独立してテストできます。これにより、システムのテストの容易さを向上させることができます。

このため、Commandパターンは、リクエストを実行するロジックをカプセル化、再利用、拡張するのに役立ちます。

Active Objectパターン

今まで説明した材料を利用して、Active Objectパターンについて調べてみましょう。

Active Objectパターンは、並行性の問題を解決するために使用される設計パターンです。このパターンは、オブジェクトのメソッド呼び出しを非同期的に処理するように設計されています。Active Objectパターンは要求をキューに格納し、別のスレッドでキューに格納された要求を順次処理します。これにより、並行性の問題を解決し、オブジェクトの状態を安全に管理できます。

以下のコードは、ゲームサーバーと呼ばれる仮想シナリオでActive Objectを利用する例です。2つのイベントを処理しています。ユーザーがゲームサーバーにログインしたときに発生するOnLogin()と、ユーザーがiTepを取得したときにデータベースにバックアップしたいOnSaveItem()イベントを扱っています。

OnLogin() イベントでは、ユーザーのパスワードをデータベースで確認し、その結果を利用してログイン処理を進めています。したがって、非同期的に実行されるデータベース検証タスクをawaitを利用して待ち、その結果を使用するプロセスです。

一方、OnSaveItem() の場合には、あえてデータベース処理結果を待つ必要がない場合を説明しています。 ゲームロジックはメモリで行われ、後でデータベースにバックアップを取るシナリオです。 データベースへの保存中に発生するエラーなどの処理はカプセル化され、GameServerでは注意を払わないようにします。これにより関心事を徹底的に分離しています。

ActiveObjectに非同期的に操作を要求するだけなので、OnSaveItem()ではasync/awaitを使用する必要はありません。

						
						  public class GameServer
						  {
							  private static ActiveObject _activeObject = new ActiveObject();
						  
							  public static async void OnLogin(Connection connection, string username, string password)
							  {
								  var command = new LoginCommand(username, password);
								  var loginTask = _activeObject.Enqueue(command);
								  var result = await loginTask;
								  if (!result) {
									  connection.SendLoginFailed();
									  return;
								  }
						  
								  connection.SendLoginSuccess();
						  
								  // ログイン完了処理が必要
							  }
						  
							  public static void OnSaveItem(Connection connection, string username, string item)
							  {
								  var command = new SaveItemCommand(username, item);
								  _activeObject.Enqueue(command);
						  
								  // キャラクターの在庫にアイテムを追加
							  }
						  }
						
					  

以下のコードはActiveObjectクラスの実装コードです。このクラスは、Commandパターンを使用して非同期的にコマンドを実行する役割を果たします。

						
						  using CommandTaskTuple = Tuple>;
			
							public class ActiveObject
							{
								private BlockingCollection _queue = new BlockingCollection();
							
								public ActiveObject()
								{
									Task.Run(() =>
									{
										foreach (var tuple in _queue.GetConsumingEnumerable())
										{
											var command = tuple.Item1;
											var tcs = tuple.Item2;
											var result = command.Execute().Result;
											tcs.SetResult(result);
										}
									});
								}
							
								public Task Enqueue(ICommand command)
								{
									var tcs = new TaskCompletionSource();
									_queue.Add(Tuple.Create(command, tcs));
									return tcs.Task;
								}
							}
						
					  

• このコードは、Active Objectパターンを実装したActiveObjectクラスです。このクラスは非同期的にコマンドを実行する役割を果たします。ActiveObjectクラスは、次のコンポーネントで構成されています。
• BlockingCollection：このクラスはスレッドセーフなコレクションで、複数のスレッドで同時にアクセスするときに発生する可能性のある並行性の問題を解決します。このクラスを使用すると、スレッドがキューにエントリを追加または削除したときに同期を自動的に処理します。これにより、要求されたタスクを安全に保存して処理できます。
• Guarded Suspensionパターン：このパターンは、スレッドが特定の条件が満たされるのを待つようにするパターンです。ActiveObject クラスでは、BlockingCollection を使用してこのパターンを実装しています。キューにコマンドが追加されるまでスレッドが待機します。
• ActiveObject() コンストラクタ: このコンストラクタは別のスレッドを起動し、キューに格納されたコマンドを順次実行します。キューからコマンドを取得し、Execute メソッドを呼び出してコマンドを実行し、その結果を TaskCompletionSource オブジェクトに設定します。これにより、非同期的にコマンドを実行して結果を返すことができます。
• Enqueue() メソッド: このメソッドは、コマンドをキューに格納する役割を果たします。コマンドとその結果を表すTaskCompletionSource オブジェクトを作成し、キューに保存します。そしてTaskCompletionSourceを利用して、まだ実行されていないCommand のフューチャに対応するTask オブジェクトを返します。
• TaskCompletionSource： このクラスは、非同期操作の結果を表す Task オブジェクトを生成し、その結果を設定するために使用されます。 これにより、非同期操作の完了を表示して結果を返すことができます。

以下は、Active Objectパターンを使用することで得られる利点です。

• 並行性制御：Active Objectパターンを使用すると、並行性の問題を解決し、オブジェクトの状態を安全に管理できます。
• 非同期処理：Active Objectパターンを使用すると、オブジェクトのメソッド呼び出しを非同期的に処理できます。 これにより、システムの応答性を向上させることができます。
• コードの簡潔さ：Active Objectパターンを使用すると、並行性制御と非同期処理のためのコードを簡潔に作成できます。
• スケーラビリティ：Active Objectパターンを使用すると、新しい要求を簡単に追加できます。 これにより、システムのスケーラビリティを向上させることができます。

このため、Active Objectパターンは並行性の問題を解決し、非同期処理用のコードを簡潔に記述するのに役立ちます。

並行性問題を解決するActive Objectパターン

例をできるだけ簡単で説明しやすく設定しようとしました。 実戦であれば、Command生成部分までも隠して、以下のような形で構成するのも大丈夫です。

						
						  public class GameServer
						  {
							  private static DatabaseController _databaseController = new DatabaseController();
						  
							  public static async void onLogin(Connection connection, string username, string password)
							  {
								  var result = await _databaseController.Login(username, password);
								  if (!result)
								  {
									  connection.SendLoginFailed();
									  return;
								  }
						  
								  connection.SendLoginSuccess();
						  
								  // ログイン完了処理が必要
							  }
						  
							  public static async void onSaveItem(Connection connection, string username, string item)
							  {
								  _databaseController.SaveItem(username, item);
						  
								  // キャラクターの在庫にアイテムを追加
							  }
						  }
						
					  

このポストでは、並行性の問題を解決するActive Objectパターンについて学びました。このパターンは、オブジェクトのメソッド呼び出しを非同期的に処理するように設計されており、リクエストをキューに格納し、別のスレッドでキューに格納されたリクエストを順次処理します。これにより、並行性の問題を解決し、オブジェクトの状態を安全に管理できます。

Active Object パターンは、ゲームサーバーなどのマルチユーザー環境で効果的に使用できます。このパターンを使用すると、ユーザーの要求を非同期的に処理し、同時に発生する複数の要求を安全に管理できます。

次回のポストでは、他の並行性パターンを紹介します。これからもどうぞよろしくお願いします。ありがとうございました。