モンスターハンターライズのスキルシミュレータを作ってみる！ 第4回

　エンドポイントとは、ユーザーが直接アクセスするアプリケーションの出入口のことだ。WEBサイトで云えば、エントリーページとなるindex.htmlやhome.html等がエンドポイントと云えるだろう。今回のアプリケーションでは、アプリケーションの利用者となるエンドユーザ用のエンドポイントとしてindex.phpを準備し、データ管理者用にadmin.phpを、一括データ投入用にbulk.phpをそれぞれ設置する。admin.phpやbulk.phpはいわゆる管理画面的な位置づけになり、エンドユーザからのアクセスを許可しない制限されたエンドポイントとなる想定だ。なお、bulk.phpについては、特にGUIを準備する必要性が乏しいので、コマンドラインから直接データを一括投入できるようなもので事足りると考えている。

コアクラスの製造

　エンドポイントが決まったら、まずはバルクユーザ向けの経路を作って行くことにする。この経路が動くようになれば、データベースに初期データを投入するのが楽になり、その後の開発がしやすくなるからだ。
　そのために真っ先にやらなければならないのが、PHPでデータベースと接続して、PHPからデータベースを操作できるようにすることだ。そこで、アプリケーションの中核として、コアクラスを作り、そのメソッドとしてデータベースハンドラを準備する。

抽象クラスを使う

　アプリケ―ションのコアクラスを作る前に、前段として抽象クラス（Abstract Class）を準備する。抽象クラスとはそれを継承するクラスのひな形となるスキーマ的なクラスで、同様の機能を持っているインターフェースよりも縛りが緩いものだ、という解釈で大まかにはイイと思う。もっと詳しく云うと、抽象クラスやインターフェースで宣言されたメソッドは、継承先のクラスで実装が強制される。さらに抽象クラスでは、通常のメソッドも定義できるため、アプリケーション全体で共通的に使用するような処理をあらかじめ定義しておくことができる。一方で、インターフェースはメソッドの定義はできないが、複数のインターフェースを継承させる「多重継承」ができる。
　アプリケーションの建付け的に、エンドポイントごとにファイナルクラスを準備する予定なので、それらで共通利用するデータベースハンドラについては抽象クラスに定義しておいた方が効率的なのである。他に、データベースハンドラ系の処理はトレイトにしてしまい、各クラスでそのトレイトをuseするという手段もある。今回のアプリケーションの場合、抽象クラスを継承した方が、コードの見通しが良いだろうという判断だ。

　前述のPHPクラスのオートローダ設定にて、PHPのクラスはappsディレクトリから読み込まれるようになっているので、appsディレクトリを作り、抽象クラスとバルクユーザ用のコアクラスのファイルを作成しよう。

mkdir apps
cd apps
touch abstractClass.php bulkCore.php

　とりあえず、実践あるのみだ。抽象クラスとコアクラスを使ったDB接続の試験をしてみよう。最初に抽象クラス側を下記のようにする。

abstractClass.php:

<?php
namespace MHRise\SkillSimulator;

if ( !class_exists( 'abstractClass' ) ) :

abstract class abstractClass {
    protected string $cmd;

    public function __construct(
        private string $dbname,
        private string $dbuser,
        private string $dbpass,
        private int    $dbport = 3306,
    ) {
        $this->cmd = sprintf( 'mysql -u %s -p%s -P %d -D %s', $this->dbuser, $this->dbpass, $this->dbport, $this->dbname );
    }

    abstract public function execute( string $query );
}

endif;

　ちょっとだけ解説しておこう。コンストラクタの部分は、PHP 8で導入されたプロパティ・プロモーションで書いているので、PHP7以前のバージョンではエラーになる。抽象クラスでは、コンストラクタとしてデータベースの接続情報（DSN: Data Source Name）を引数で受けてクラスのプロパティに展開している。抽象メソッドとして、データベースクエリを実行するためのexecute()が宣言されているので、継承先のクラスではこのメソッドの定義が強制される。

抽象クラスを継承するコアクラス

　次に、抽象メソッドを継承するコアクラス側のサンプルをコーディングする。

bulkCore.php:

<?php
namespace MHRise\SkillSimulator;

if ( !class_exists( 'bulkCore' ) ) :

class bulkCore extends abstractClass {
    public function execute( string $query ) {
        $fixed_cmd = $this->cmd . sprintf( ' -t -e "%s"', $query );
        system( $fixed_cmd );
    }
}

endif;

　コアクラスでは、抽象クラスで強制された抽象メソッドexecute()を必ず定義しなければならない。その際、アクセス修飾子（publicやprotected、private）や、引数の数と型も抽象クラス側で定義されたものと一致させる必要がある。
　このサンプルコードでは、文字列としてSQLクエリを受け取って、コマンドラインからSQLクエリを実行するためのコマンドを生成し実行する流れだ。あくまで動作テスト用のサンプル処理なので、値の検証や例外処理等は入れていない。

エンドポイント用ファイルの作成と実行

　そして最後に、エンドポイント用のファイルを準備する。

cd ..
touch bulk.php

　エンドポイントのファイルでは、コアクラスをインスタンス化して、必要なメソッドを実行することになる。

bulk.php:

<?php
require_once( __DIR__ . '/vendor/autoload.php' );

use MHRise\SkillSimulator\bulkCore;

if ( class_exists( 'MHRise\SkillSimulator\bulkCore' ) ) {
    $instance = new bulkCore( 'mhr_simulator_db', 'username', 'password', 3306 );
    $instance->execute( 'show tables' );
} else {
    exit;
}

　クラスをインスタンス化する際に、受け渡すデータベースに接続するためのユーザ名やパスワード、ポート番号等は稼働する環境に準じて変更する必要がある。この例では、接続したデータベースに存在するテーブルの一覧を表示するためのクエリshow tablesを実行する想定だ。
　では、実際にエンドポイントのPHPファイルをコマンドラインから実行してみよう。

> php bulk.php
mysql: [Warning] Using a password on the command line interface can be insecure.
+----------------------------+
| Tables_in_mhr_simulator_db |
+----------------------------+
| armors                     |
| decorations                |
| talismans                  |
| weapons                    |
+----------------------------+

　無事に今回のアプリケーション用に作ったデータベースのテーブル一覧が表示された。なお、MySQLが警告を出しているのは、PHPが内部で実行しているコマンドライン上のmysqlコマンドにパスワードが直接引数で渡されているからだ。

　この一連の処理の流れが、今回のアプリケーションのバックエンドの基本となる。どのエンドポイントを辿って来ても基本的に同じようなクラス連携を経て、データベースとのやり取りが行われるのだ。
　ということで、今回はここまで。

　次回は、バルクユーザ用のエンドポイントbulk.phpを仕上げる。