Online Status Service に関するサービス層・業務処理を担当します。

6Fields
1Constructors
10Methods
252Lines
Package
com.example.rankingplugin
Source
OnlineStatusService.java
Kind
class
Roles
イベント駆動DB / 永続化非同期 / スケジューラ初期化 / ブートストラップサービス層
このクラスにも章立て解説を追加しています。 自動抽出の一覧だけでなく、下の『重点クラスの詳細解説』で読む順番・内部サブシステム・変更時の注意点まで追えます。 全クラス章立てガイドを見る

クラス説明

クラス直前の Javadoc は見つかりませんでした。ソースとメソッド構成から責務を補完しています。

責務と見どころ

重点クラスの詳細解説

Online Status Service に関するサービス層・業務処理を担当します。(root) パッケージの 小〜中規模クラスで、運用中の主ループ・永続化境界・スケジューラを確認する起点です。全面展開版では、他の重点クラスと同じ章立てで読めるように補強しています。

最初に追う読む順番

  1. OnlineStatusService
    依存オブジェクトと初期状態を束ね、このクラスが担当するランタイムの前提を固めます。
  2. onJoin
    運用中の中心ループです。イベント受理から状態更新までの主経路を追えます。
  3. onQuit
    運用中の中心ループです。イベント受理から状態更新までの主経路を追えます。
  4. updateOnlinePlayers
    結果を反映・永続化する境界です。表示だけ直って保存が壊れる系の切り分けに向きます。
  5. cleanupExpired
    後片付けと停止の出口です。残骸や再ログイン後の不整合はここを確認します。
  6. clearServerPresence
    DB への問い合わせまたは更新処理を担当します。
  7. isOnlineHere
    条件判定を行い、後続処理の分岐に使える真偽値を返します。
  8. isOnlineElsewhere
    条件判定を行い、後続処理の分岐に使える真偽値を返します。

内部サブシステムの地図

起動・前提準備

初期テーブル、依存状態、定期処理の点灯など、このクラスが動き始める前提をまとめています。

主なメソッド
主なフィールド

運用中の主ループ

イベント受理、定期監視、判定、進行更新など、実際に挙動を生む中心ロジックです。

主なメソッド
主なフィールド

状態反映と永続化

メモリ状態と保存状態を揃え、結果を次の呼び出しや画面表示へ繋ぐ部分です。

主なメソッド
主なフィールド

代表フロー詳解

通常運用の中心フロー

  1. onJoin
  2. onQuit
  3. updateOnlinePlayers

イベント受理、判定、状態更新、通知までの主経路です。体感不具合や想定外の分岐はこの流れのどこで止まるかを見ると切り分けやすいです。

反映・保存・終了の流れ

  1. updateOnlinePlayers
  2. cleanupExpired

結果を保持し、必要なら永続化し、最後に掃除まで行う出口です。画面更新だけ合って保存が壊れるケースや残骸が残るケースの確認に向きます。

変更時の注意点

外部接点

主な永続化テーブル

SQL 文字列から抽出できた主要テーブルです。スキーマ変更時の確認用です。

user_statuslast_seen

フィールド

VisibilityTypeName役割
privateJavaPluginpluginプラグイン本体参照です。
privateHikariDataSourcedsDB 接続元を保持します。
privateStringserverIdserverId の状態を保持します。
privateintEXPIRY_SECEXPIRY_SEC の状態を保持します。
privatelongCACHE_TTL_MSキャッシュまたは直近計算結果を保持します。
privateMap<String, CacheEntry>cacheキャッシュまたは直近計算結果を保持します。

コンストラクタ / 初期化

Signature説明主要呼び出し
public OnlineStatusService(JavaPlugin plugin, HikariDataSource ds)依存オブジェクトや初期状態を受け取り、このクラスの動作を開始できる状態へ組み立てます。resolve → getConnection → createStatement → executeUpdate → user_status → getLogger

メソッド索引

NameVisibilityKind説明
OnlineStatusServicepublicコンストラクタ依存オブジェクトや初期状態を受け取り、このクラスの動作を開始できる状態へ組み立てます。
onJoinpublicイベント処理イベント発生時の分岐と後続処理を担当します。
onQuitpublicイベント処理イベント発生時の分岐と後続処理を担当します。
updateOnlinePlayersprivateメソッド状態を永続化または更新し、最新状態へ反映します。
clearServerPresenceprivateメソッドDB への問い合わせまたは更新処理を担当します。
cleanupExpiredprivateメソッドDB への問い合わせまたは更新処理を担当します。
isOnlineHerepublicメソッド条件判定を行い、後続処理の分岐に使える真偽値を返します。
isOnlineElsewherepublicメソッド条件判定を行い、後続処理の分岐に使える真偽値を返します。
getOnlineServerspublicメソッド必要な状態を取得し、呼び出し側で利用しやすい形へ返します。
getOnlineServersBatchpublicメソッド必要な状態を取得し、呼び出し側で利用しやすい形へ返します。

メソッド詳細

OnlineStatusService

コンストラクタpublic
public OnlineStatusService(JavaPlugin plugin, HikariDataSource ds)

依存オブジェクトや初期状態を受け取り、このクラスの動作を開始できる状態へ組み立てます。

引数

throws

なし

主要な呼び出し順

resolvegetConnectioncreateStatementexecuteUpdateuser_statusgetLoggersevereprintStackTrace

onJoin

イベント処理public
public void onJoin(PlayerJoinEvent e)

イベント発生時の分岐と後続処理を担当します。

引数

throws

なし

主要な呼び出し順

getPlayergetNameisBlanksingletoncurrentTimeMillisgetSchedulerrunTaskAsynchronouslyupdateOnlinePlayers

onQuit

イベント処理public
public void onQuit(PlayerQuitEvent e)

イベント発生時の分岐と後続処理を担当します。

引数

throws

なし

主要な呼び出し順

getPlayergetNameisBlankremovegetSchedulerrunTaskAsynchronouslyclearServerPresence

updateOnlinePlayers

メソッドprivate
private void updateOnlinePlayers(Collection<String> playerNames)

状態を永続化または更新し、最新状態へ反映します。

引数

throws

なし

主要な呼び出し順

nowuser_statusgetConnectionprepareStatementsetStringsetTimestampvalueOfisBlank

clearServerPresence

メソッドprivate
private void clearServerPresence(String playerName)

DB への問い合わせまたは更新処理を担当します。

引数

throws

なし

主要な呼び出し順

getConnectionprepareStatementsetStringexecuteUpdategetLoggerwarninggetMessage

cleanupExpired

メソッドprivate
private void cleanupExpired()

DB への問い合わせまたは更新処理を担当します。

引数

throws

なし

主要な呼び出し順

getConnectionprepareStatementnowminusSecondssetTimestampvalueOfexecuteUpdategetLogger

isOnlineHere

メソッドpublic
public boolean isOnlineHere(String playerName)

条件判定を行い、後続処理の分岐に使える真偽値を返します。

引数

throws

なし

主要な呼び出し順

getOnlineServerscontains

isOnlineElsewhere

メソッドpublic
public boolean isOnlineElsewhere(String playerName)

条件判定を行い、後続処理の分岐に使える真偽値を返します。

引数

throws

なし

主要な呼び出し順

getOnlineServersisEmptysizecontains

getOnlineServers

メソッドpublic
public Set<String> getOnlineServers(String playerName)

必要な状態を取得し、呼び出し側で利用しやすい形へ返します。

引数

throws

なし

主要な呼び出し順

isBlankemptySetcurrentTimeMillisnowminusSecondsgetConnectionprepareStatementsetString

getOnlineServersBatch

メソッドpublic
public Map<String, Set<String>> getOnlineServersBatch(Collection<String> players)

必要な状態を取得し、呼び出し側で利用しやすい形へ返します。

引数

throws

なし

主要な呼び出し順

isEmptyemptyMapcurrentTimeMillisisBlanksizenowminusSecondsappend

代表的な処理フロー

  1. 初期化フロー
    OnlineStatusService → resolve → getConnection → createStatement → executeUpdate → user_status
    依存オブジェクトや初期状態を受け取り、このクラスの動作を開始できる状態へ組み立てます。
  2. onJoin フロー
    onJoin → getPlayer → getName → isBlank → singleton → currentTimeMillis
    イベント発生時の分岐と後続処理を担当します。
  3. onQuit フロー
    onQuit → getPlayer → getName → isBlank → remove → getScheduler
    イベント発生時の分岐と後続処理を担当します。
  4. updateOnlinePlayers フロー
    updateOnlinePlayers → now → user_status → getConnection → prepareStatement → setString
    状態を永続化または更新し、最新状態へ反映します。
  5. cleanupExpired フロー
    cleanupExpired → getConnection → prepareStatement → now → minusSeconds → setTimestamp
    DB への問い合わせまたは更新処理を担当します。
  6. getOnlineServers フロー
    getOnlineServers → isBlank → emptySet → currentTimeMillis → now → minusSeconds
    必要な状態を取得し、呼び出し側で利用しやすい形へ返します。

外部との接点

Web ルート

このクラス内に目立つ Web ルート定義は見つかりませんでした。

SQL / テーブル

user_statuslast_seen

関連クラス

補足