Rock-Paper-Paperオンラインゲームの例を使用してJavaサーバーを作成するためのReddwarf：Server

RedDwarf-Javaでオンラインゲームを開発するためのサーバープラットフォームの記事で、ゲームサーバーを作成するためのこのプラットフォームの機能について説明しました。 この記事では、RedDwarfを使用してサーバーを作成する方法を例に示します。
例として、ゲーム「Rock-Paper-Scissors」のオンライン実装を作成することが決定されました。
この記事では、サーバーを作成して起動しようとします。 次の記事では、このサーバー用の小さなクライアントを作成し、そのパフォーマンスを確認します。

仕事の準備

まず、ここから sgs-server-dist-0.10.2.zipアーカイブにあるReddwarfサーバーをダウンロードし、sgs-server-dist-0.10.2フォルダーにコンテンツを解凍する必要があります。

プロジェクト作成

お気に入りの開発環境でプロジェクトを作成します。
プロジェクトはシンプルになるため、Mavenは使用しません。
開発には、sgs-server-dist-0.10.2 \ lib \ディレクトリにあるsgs-server-api-0.10.2.jarライブラリが必要です

META-INFフォルダーを作成します。これには、マニフェストファイルMANIFEST.MFが含まれている必要があります。 これがないと、プラットフォームはプロジェクトjarファイルでの作業を拒否します。 私のファイルには1行しか含まれていません：
マニフェストバージョン：1.0

また、META-INFフォルダーにapp.propertiesファイルを作成する必要があります。 このファイルには、サーバーの起動設定が含まれています。 プロジェクトの場合、ファイルには次のプロパティが含まれています。

#  .        com.sun.sgs.app.name=RockPaperScissors # ,   AppListener      com.sun.sgs.app.listener=hello.reddwarf.server.Server #  ,        com.sun.sgs.app.root=data 

これは、最低限必要なオプションのセットです。 開発中に、次のプロパティが引き続き有用な場合があります。

• com.sun.sgs.impl.transport.tcp.listen.port-サーバーがリッスンするポート（デフォルトでは62964）
• com.sun.sgs.app.authenticators-認証を担当するクラスの名前（認証プロセスはゲームロジックから削除され、独立したモジュールとして使用できます）
• com.sun.sgs.impl.service.session.allow.new.login-別のクライアントから接続されたプレーヤーが接続できるようにするかどうか。 trueの場合、ゲーム内にいる人がスローします。 falseの場合、別のクライアントからの接続を許可しません。

その他のプロパティの詳細については、 ドキュメントをご覧ください。

ゲームアーキテクチャ

ゲームには次のエンティティが必要です。
サーバー -プレイヤーのリストをオンラインで保存し、接続の処理を処理するクラス。
プレーヤー - プレーヤーを表します。 プレイヤーには次の属性があります：名前（同じログイン）とポイント数。 戦闘に参加できます。
バトル -バトルです。 このオブジェクトでは、プレーヤーの応答を待って勝者を決定します。 2人のプレーヤーへのリンクが含まれています。
武器は、直接石、はさみ、紙などの武器の単純な列挙です。

クラス図の形式で描かれている場合、次のことがわかります。


すべてのゲームエンティティ（武器を除く）は、サーバーの実行中にトランザクション性を提供する内部データベースに格納され、相互に参照するため、java.io.Serializableおよびcom.sun.sgs.app.ManagedObjectインターフェイスを実装する必要があります。

サーバークラス。 プレーヤーの初期化と接続

Serverクラスはサーバーの起動ポイントであるため、com.sun.sgs.app.AppListenerインターフェイスを実装する必要があります。

void initialize(Properties props)は、サーバーの最初の起動時に呼び出されます。 作業に必要な初期値で内部データベースを満たします。 重要な機能：サーバーが停止（または強制終了）してから再起動した場合、このメソッドは呼び出されません。 内部データベースはサーバーが起動するまで保存され、停止した瞬間から作業を続けることができます。

ClientSessionListener loggedIn(ClientSession session)は、認証が成功した後に呼び出され、プレーヤーを表すオブジェクトを返す必要があります。 この例では、これはPlayerになります。

サーバーに接続されているすべてのプレーヤーは、特別なコレクションに保存されます。 Reddwarfには、ゲームエンティティ用のScalableHashMapの特別なコレクションがあります。 このコレクションの利点は、変更されると、完全にではなく部分的にブロックされることです（内部データベースのロックを意味します）。 また、Serverオブジェクトでは、コレクション自体ではなく、コレクションへのリンク（ManagedReference）を保存します。

言葉から行為に移ると、次のコードが得られます。

 package hello.reddwarf.server; import java.io.Serializable; import com.sun.sgs.app.*; import com.sun.sgs.app.util.ScalableHashMap; import java.util.Properties; /** *  .     , *        . */ public class Server implements AppListener, Serializable, ManagedObject { public ManagedReference<ScalableHashMap<String, Player>> onlinePlayersRef; @Override public void initialize(Properties props) { //      ScalableHashMap<String, Player> onlinePlayers = new ScalableHashMap<String, Player>(); onlinePlayersRef = AppContext.getDataManager().createReference(onlinePlayers); } @Override public ClientSessionListener loggedIn(ClientSession session) { String name = session.getName(); //  .      ,    Player player = loadOrRegister(name); //   .  -  ,    //   -     player.setSession(session); //    ,    player.connected(); //     - onlinePlayersRef.get().put(player.name, player); return player; } } 

データベースを操作するには、DataManagerを使用します。これにより、データベースへの書き込み、データベースからの読み取り、ManagedReferenceリンクの作成が可能になります。 データベースはキーと値のストレージであるため、「player」というプレフィックスの付いたプレーヤーの名前がキーとして使用され、Playerオブジェクト全体が値にシリアル化されます。 ベースからプレーヤーをロードする関数を作成します（プレーヤーがデータベースに見つからない場合は作成します）。

  private Player loadOrRegister(String name) { try { return (Player) AppContext.getDataManager().getBindingForUpdate("player." + name); } catch (NameNotBoundException e) { //       - //   ,       Player player = new Player(name, this); AppContext.getDataManager().setBinding("player." + name, player); return player; } } 

プレーヤーのクラスとプロトコル

次はPlayerクラスを作成する番です。 このクラスはプレーヤーを表し、プラットフォームから着信メッセージの通知を受け取ります。 それでは、プロトコルについて話しましょう。 Reddwarfを使用すると、着信および発信メッセージをバイトの配列として処理でき、プロトコルの実装はゲーム開発者の裁量に任されます。 ゲーム「じゃんけん」では、単純なテキストプロトコルを使用します。

（ server- > client） SCORE <number> -サーバーはプレイヤーにポイント数を伝えます
（クライアント->サーバー） PLAY-ゲームを開始するためのプレーヤーのリクエスト
（サーバー->クライアント） BATLE <名前> -指定されたプレイヤーとの戦いが始まりました
（サーバー->クライアント） エラー -戦闘のプレイヤーが見つかりませんでした（サーバーに誰もいないか、すべての戦闘に参加していません）
（クライアント->サーバー） ROCK-プレイヤーは「Stone」と言います
（クライアント->サーバー） SCISSORS-プレイヤーは「はさみ」と言います
（クライアント->サーバー） 紙 -プレイヤーは「紙」と言います
（サーバー->クライアント） DRAW-描画
（サーバー->クライアント） WON-プレーヤーが勝ちました
（サーバー->クライアント） LOST-プレイヤーが失われました

プロトコルから、プレーヤーのアクションと機能のシーケンスを理解できるため、これについて個別に説明することはしません。

このコードを使用して、テキストをバイトにエンコードしたり、その逆を行うことができます。

 package hello.reddwarf.server; import java.nio.ByteBuffer; public class Messages { public static ByteBuffer encodeString(String s) { return ByteBuffer.wrap(s.getBytes()); } public static String decodeString(ByteBuffer message) { byte[] bytes = new byte[message.remaining()]; message.get(bytes); return new String(bytes); } } 

次に、プレーヤーのオブジェクトの作成に進みます。
プレーヤーは次のフィールドを保持します。

• 名
• 点数
• サーバーリンク（オンラインプレーヤーのリストにアクセスするため）
• セッションへのリンク（クライアントにメッセージを送信するため）
• 戦闘へのリンク（プレイヤーが戦闘中の場合、そうでない場合はnull）

 package hello.reddwarf.server; import com.sun.sgs.app.*; import com.sun.sgs.app.util.ScalableHashMap; import java.io.Serializable; import java.nio.ByteBuffer; import java.util.*; public class Player implements Serializable, ManagedObject, ClientSessionListener { private final static Random random = new Random(); public final String name; private int score; //   ,        private ManagedReference<ClientSession> sessionRef; //        - private ManagedReference<Server> serverRef; //    .      -    null private ManagedReference<Battle> battleRef; public Player(String name, Server server) { this.name = name; serverRef = AppContext.getDataManager().createReference(server); score = 0; } @Override public void receivedMessage(ByteBuffer byteBuffer) { //          String message = Messages.decodeString(byteBuffer); if (message.equals("PLAY")) { play(); } else if (message.equals("ROCK")) { answer(Weapon.ROCK); } else if (message.equals("PAPER")) { answer(Weapon.PAPER); } else if (message.equals("SCISSORS")) { answer(Weapon.SCISSORS); } } @Override public void disconnected(boolean b) { serverRef.get().disconnect(this); } private void answer(Weapon weapon) { if (battleRef != null) { battleRef.getForUpdate().answer(this, weapon); } } private void play() { logger.info("Choosing enemy for "+name); //          Player target = getRandomPlayer(); if (target != null && target.battleRef == null) { Battle battle = new Battle(this, target); this.sessionRef.get().send(Messages.encodeString("BATTLE " + target.name)); target.sessionRef.get().send(Messages.encodeString("BATTLE " + this.name)); target.battleRef = AppContext.getDataManager().createReference(battle); this.battleRef = target.battleRef; battle.start(); } else { this.sessionRef.get().send(Messages.encodeString("ERROR")); } } /** *    (  ) *     ,  null * @return    null,    */ private Player getRandomPlayer() { ScalableHashMap<String,Player> onlineMap = serverRef.get().onlinePlayersRef.get(); Set<String> namesSet = new HashSet<String>(onlineMap.keySet()); namesSet.remove(name); if (namesSet.isEmpty()) { return null; } else { ArrayList<String> namesList = new ArrayList<String>(namesSet); String randomName = namesList.get(random.nextInt(namesList.size())); return onlineMap.get(randomName); } } public void connected() { //      ,     sessionRef.get().send(Messages.encodeString("SCORE " + score)); } /** *  ,      */ public void battleResult(Battle.Result result) { switch (result) { case DRAW: score+=1; sessionRef.get().send(Messages.encodeString("DRAW")); break; case WON: score+=2; sessionRef.get().send(Messages.encodeString("WON")); break; case LOST: sessionRef.get().send(Messages.encodeString("LOST")); break; } sessionRef.get().send(Messages.encodeString("SCORE " + score)); battleRef = null; } public void setSession(ClientSession session) { sessionRef = AppContext.getDataManager().createReference(session); } } 

武器および戦闘クラス

武器の列挙は非常に単純であり、コメントは不要です。

 package hello.reddwarf.server; public enum Weapon { ROCK, PAPER, SCISSORS; boolean beats(Weapon other) { return other != null && this != other && this.ordinal() == (other.ordinal() + 1) % values().length; } } 

戦いに移ります。

戦闘には一意の識別子があり、2人のプレイヤーへのリンク、その回答、およびアクティビティフラグが含まれています。

戦闘が作成されると、別のタスクが起動され、5秒で戦闘が完了します。
この時間が経過すると、戦闘の結果が合計されます。 プレイヤーの1人だけが答えを出した場合、両方の場合、勝者と見なされます-勝者は通常の規則「じゃんけん」に従って決定されます。

タスクは、AppContext.getTaskManager（）を使用して取得できるTaskManagerサービスを使用して実行されます。 このマネージャーを使用すると、個別のトランザクションで実行されるタスクをすぐに実行するか、指定した期間の後に実行するか、定期的に実行できます。 予想どおり、すべてのタスクは内部データベースにも保存されます。つまり、サーバーの再起動後に実行されます。

したがって、クラスコードはBattleです。

 package hello.reddwarf.server; import com.sun.sgs.app.AppContext; import com.sun.sgs.app.ManagedObject; import com.sun.sgs.app.ManagedReference; import com.sun.sgs.app.Task; import java.io.Serializable; import java.util.concurrent.atomic.AtomicInteger; public class Battle implements ManagedObject, Serializable { //   5  private static final long BATTLE_TIME_MS = 5000; enum Result { DRAW, WON, LOST } private boolean active; private ManagedReference<Player> starterPlayerRef; private ManagedReference<Player> invitedPlayerRef; private Weapon starterWeapon = null; private Weapon invitedWeapon = null; public Battle(Player starterPlayer, Player invitedPlayer) { starterPlayerRef = AppContext.getDataManager().createReference(starterPlayer); invitedPlayerRef = AppContext.getDataManager().createReference(invitedPlayer); active = false; } /** *  . *  ,  BATTLE_TIME_MS    . */ public void start(){ active = true; AppContext.getTaskManager().scheduleTask(new BattleTimeout(this), BATTLE_TIME_MS); } /** *    . *  ,  . * @param player -  * @param weapon -   */ public void answer(Player player, Weapon weapon){ if (active) { if (player.name.equals(starterPlayerRef.get().name)) { starterWeapon = weapon; } else { invitedWeapon = weapon; } } } /** *  . *  . */ private void finish() { active = false; Player starterPlayer = starterPlayerRef.getForUpdate(); Player invitedPlayer = invitedPlayerRef.getForUpdate(); if (starterWeapon != null && starterWeapon.beats(invitedWeapon)) { starterPlayer.battleResult(Result.WON); invitedPlayer.battleResult(Result.LOST); } else if (invitedWeapon != null && invitedWeapon.beats(starterWeapon)) { invitedPlayer.battleResult(Result.WON); starterPlayer.battleResult(Result.LOST); } else { starterPlayer.battleResult(Result.DRAW); invitedPlayer.battleResult(Result.DRAW); } AppContext.getDataManager().removeObject(this); } /** * ,      . */ private static class BattleTimeout implements Serializable, Task { private ManagedReference<Battle> battleRef; public BattleTimeout(Battle battle) { battleRef = AppContext.getDataManager().createReference(battle); } @Override public void run() throws Exception { battleRef.getForUpdate().finish(); } } } 

このコードを読むと、「内部BattleTimeoutクラスが静的になり、バトルへのリンクを明示的に保存するのはなぜですか？ 非静的として宣言し、バトルフィールドに直接アクセスできます。」
実際、非静的内部クラスは親バトルへのリンクを暗黙的な形式で保存し、それを介してバトルにアクセスします。 ただし、Reddwarfプラットフォーム（トランザクション）の機能は、別のトランザクションからManagedObject（Battle）に直接アクセスすることを禁止しています。この場合、例外がスローされます。 別のトランザクション内のオブジェクトへの直接参照は正しくありません。 静的な内部クラスのみを使用するというプラットフォーム作成者の推奨事項は、これに関連しています。

また、参照による管理対象オブジェクトの受信に注意したいと思います。
ManagedReferenceの上記のコードは、get（）メソッドとgetForUpdate（）の両方を使用します。
原則として、get（）のみを使用できます。 getForUpdate（）を使用すると、サーバーは、トランザクションが完了する前にどのオブジェクトが変更されるかを知り、競合するトランザクションが検出された場合、少し前にタスクをキャンセルできます。 これにより、get（）を使用した場合に比べて速度がいくらか向上します。

最後に、サーバーの準備がほぼ整いました。
ロギングを少し追加し（簡単にするためにjava.util.loggingを使用します）、プロジェクトをビルドできます。
アセンブリの結果として、jarファイル、たとえばdeploy.jarを取得する必要があります。
これらすべてを手動で収集したくない場合は、完成したdeploy.jarファイルをここから取得できます 。
このファイルはsgs-server-dist-0.10.2 \ distに配置する必要があります。
sgs-server-dist-0.10.2ディレクトリに移動したら、次のコマンドを実行します。

 java -jar bin/sgs-boot.jar 

その結果、コンソールに次のように表示されます。

  02, 2012 9:45:19 PM com.sun.sgs.impl.kernel.Kernel <init> INFO: The Kernel is ready, version: 0.10.2.1  02, 2012 9:45:19 PM com.sun.sgs.impl.service.data.store.DataStoreImpl <init> INFO: Creating database directory : C:\sgs-server-dist-0.10.2.1\data\dsdb  02, 2012 9:45:19 PM com.sun.sgs.impl.service.watchdog.WatchdogServerImpl registerNode INFO: node:com.sun.sgs.impl.service.watchdog.NodeImpl[1,health:GREEN,backup:(none)]@black registered  02, 2012 9:45:19 PM hello.reddwarf.server.Server initialize INFO: Starting new Rock-Paper-Scissors Server. Initialized database.  02, 2012 9:45:19 PM com.sun.sgs.impl.kernel.Kernel startApplication INFO: RockPaperScissors: application is ready 

やった！ サーバーが起動しました！ これで、クライアントに対処できます。
Rock-Paper-Paperオンラインゲームの例を使用したReddwarf：Client

参照資料

サーバーAPI Javadoc
コミュニティドキュメント
プロジェクトフォーラム