Class: ServerStatusHeartbeat

30秒ごとにオンライン人数・CPU・TPS・MSPT を plugin_server_status にUPSERTする。

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

クラス説明

30秒ごとにオンライン人数・CPU・TPS・MSPT を plugin_server_status にUPSERTする。
join/quit時は即時に軽く更新（1秒クールダウン）。

責務と見どころ

重点クラスの詳細解説

30秒ごとにオンライン人数・CPU・TPS・MSPT を plugin_server_status にUPSERTする。status パッケージの 小〜中規模クラスで、スケジューラを確認する起点です。全面展開版では、他の重点クラスと同じ章立てで読めるように補強しています。

最初に追う読む順番

  1. ServerStatusHeartbeat
    依存オブジェクトと初期状態を束ね、このクラスが担当するランタイムの前提を固めます。
  2. ensureTable
    不足テーブル・設定・内部状態を先に揃える入口です。変更を入れる前提条件の確認地点になります。
  3. start
    定期処理や公開 API の起動地点で、外部から見える挙動がここから立ち上がります。
  4. bind
    定期処理や公開 API の起動地点で、外部から見える挙動がここから立ち上がります。
  5. stop
    後片付けと停止の出口です。残骸や再ログイン後の不整合はここを確認します。
  6. beatSoon
    beatSoon の主要処理を担当します。
  7. beatOnceSync
    同期で人数/TPS取得 → 非同期でDB書き込み
  8. collectMetrics
    collectMetrics の主要処理を担当します。

内部サブシステムの地図

終了処理と掃除

停止時やフロー終端で残る実体・タスク・キャッシュを戻す出口です。

主なメソッド
stop
主なフィールド
periodSeconds timerTask

永続化と状態同期

DB テーブルとの境界です。スキーマ変更や保存漏れの切り分けはここから行います。

主なメソッド
ensureTable
主なフィールド
periodSeconds timerTask

非同期処理と定期実行

メインスレッド境界とバックグラウンド処理が交差します。重い処理やタイミング起因の不具合を追うときの要所です。

主なメソッド
start
主なフィールド
periodSeconds timerTask

イベント受理と主処理

Bukkit イベントや内部イベントを受けたあと、どの状態を更新するかをまとめています。

主なメソッド
beatSoon beatOnceSync
主なフィールド
periodSeconds timerTask

代表フロー詳解

初期化と起動の流れ

  1. ServerStatusHeartbeat
  2. start
  3. ensureTable
  4. bind

このクラスが前提状態を揃え、外部から利用可能な形まで立ち上がる流れです。新規依存の追加や起動失敗の調査はまずここから追います。

通常運用の中心フロー

  1. ServerStatusHeartbeat
  2. ensureTable
  3. start
  4. bind
  5. stop
  6. beatSoon

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

反映・保存・終了の流れ

  1. stop

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

変更時の注意点

  • Bukkit 実体やワールド状態を触る処理はスレッド境界を崩さないようにしてください。重い計算だけを分離し、実体操作は既存の同期経路へ寄せるのが安全です。
  • DB スキーマと実装が密結合です。列追加や型変更を行うときは ensure / load / save 系をセットで見直し、古いデータとの互換も確認してください。

外部接点

主な永続化テーブル

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

plugin_server_statusfailedSET

フィールド

VisibilityTypeName役割
privateJavaPluginpluginプラグイン本体参照です。
privateDataSourcedsDB 接続元を保持します。
privateStringserverIdserverId の状態を保持します。
privatelongperiodSecondsperiodSeconds の状態を保持します。
privateBukkitTasktimerTask非同期処理やスケジューラ制御に使うハンドルです。
privatelonglastImmediateWriteAtlastImmediateWriteAt の状態を保持します。

コンストラクタ / 初期化

Signature説明主要呼び出し
public ServerStatusHeartbeat(JavaPlugin plugin, DataSource ds, String serverId, long periodSeconds)依存オブジェクトや初期状態を受け取り、このクラスの動作を開始できる状態へ組み立てます。max

メソッド索引

NameVisibilityKind説明
ServerStatusHeartbeatpublicコンストラクタ依存オブジェクトや初期状態を受け取り、このクラスの動作を開始できる状態へ組み立てます。
startpublicメソッドonEnable から呼ぶ
stoppublicメソッド動作中の処理やリソースを安全に停止・解放します。
beatSoonprivateメソッドbeatSoon の主要処理を担当します。
beatOnceSyncprivateメソッド同期で人数/TPS取得 → 非同期でDB書き込み
collectMetricsprivateメソッドcollectMetrics の主要処理を担当します。
ensureTableprivateメソッド必要なテーブル・状態・前提条件が揃っているかを確認し、不足分を補います。
writeHeartbeatprivateメソッドDB への問い合わせまたは更新処理を担当します。
bindprivateメソッドbind の主要処理を担当します。

メソッド詳細

ServerStatusHeartbeat

コンストラクタpublic
public ServerStatusHeartbeat(JavaPlugin plugin, DataSource ds, String serverId, long periodSeconds)

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

引数

  • JavaPlugin plugin
  • DataSource ds
  • String serverId
  • long periodSeconds

throws

なし

主要な呼び出し順

max

start

メソッドpublic
public void start()

onEnable から呼ぶ

引数

  • 引数なし

throws

なし

主要な呼び出し順

ensureTablebeatOnceSyncgetServergetSchedulerrunTaskTimergetPluginManagerregisterEventsonJoin

stop

メソッドpublic
public void stop()

動作中の処理やリソースを安全に停止・解放します。

引数

  • 引数なし

throws

なし

主要な呼び出し順

cancel

beatSoon

メソッドprivate
private void beatSoon()

beatSoon の主要処理を担当します。

引数

  • 引数なし

throws

なし

主要な呼び出し順

currentTimeMillisgetServergetSchedulerrunTask

beatOnceSync

メソッドprivate
private void beatOnceSync()

同期で人数/TPS取得 → 非同期でDB書き込み

引数

  • 引数なし

throws

なし

主要な呼び出し順

getOnlinePlayerssizecollectMetricsgetServergetSchedulerrunTaskAsynchronouslywriteHeartbeat

collectMetrics

メソッドprivate
private Metrics collectMetrics(int online)

collectMetrics の主要処理を担当します。

引数

  • int online

throws

なし

主要な呼び出し順

getOperatingSystemMXBeangetProcessCpuLoadgetSystemCpuLoadcollectTickMetricstps1mtps5mtps15mmsptAvg

ensureTable

メソッドprivate
private void ensureTable()

必要なテーブル・状態・前提条件が揃っているかを確認し、不足分を補います。

引数

  • 引数なし

throws

なし

主要な呼び出し順

getConnectioncreateStatementexecuteUpdateplugin_server_statusgetLoggerwarninggetMessage

writeHeartbeat

メソッドprivate
private void writeHeartbeat(Metrics m)

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

引数

  • Metrics m

throws

なし

主要な呼び出し順

getConnectiongetMetaDatagetDatabaseProductNametoLowerCasecontainsprepareStatementplugin_server_statusbind

bind

メソッドprivate
private void bind(PreparedStatement ps, Metrics m) throws SQLException

bind の主要処理を担当します。

引数

  • PreparedStatement ps
  • Metrics m

throws

SQLException

主要な呼び出し順

setStringserverIdsetIntonlineprocessCpusetNullsetDoublesystemCpu

代表的な処理フロー

  1. 初期化フロー
    ServerStatusHeartbeat → max
    依存オブジェクトや初期状態を受け取り、このクラスの動作を開始できる状態へ組み立てます。
  2. start フロー
    start → ensureTable → beatOnceSync → getServer → getScheduler → runTaskTimer
    onEnable から呼ぶ
  3. ensureTable フロー
    ensureTable → getConnection → createStatement → executeUpdate → plugin_server_status → getLogger
    必要なテーブル・状態・前提条件が揃っているかを確認し、不足分を補います。
  4. stop フロー
    stop → cancel
    動作中の処理やリソースを安全に停止・解放します。
  5. bind フロー
    bind → setString → serverId → setInt → online → processCpu
    bind の主要処理を担当します。
  6. collectMetrics フロー
    collectMetrics → getOperatingSystemMXBean → getProcessCpuLoad → getSystemCpuLoad → collectTickMetrics → tps1m
    collectMetrics の主要処理を担当します。

外部との接点

Web ルート

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

SQL / テーブル

plugin_server_statusfailedSET

関連クラス

補足