【PHP8.x】Random\Randomizer::engineプロパティの使い方

Copy
1<?php
2
3use Random\Randomizer;
4
5/**
6 * Random\Randomizer クラスの engine プロパティの使用例。
7 *
8 * Randomizer が内部で使用している乱数生成エンジンを取得し、そのクラス名を表示します。
9 * Randomizer はPHP 8.2で導入された、安全な乱数を生成するためのクラスです。
10 */
11function demonstrateRandomizerEngineProperty(): void
12{
13    // Randomizer をインスタンス化します。
14    // 引数を指定しない場合、システムで利用可能な最も安全な乱数エンジンが自動的に選択されます。
15    $randomizer = new Randomizer();
16
17    // Randomizer を使用して、指定された範囲でランダムな整数を生成します。
18    $min = 1;
19    $max = 100;
20    $randomNumber = $randomizer->getInt($min, $max);
21    echo "Randomizer を使用して生成された乱数 ({$min}-{$max}): " . $randomNumber . PHP_EOL;
22
23    // `engine` プロパティを使って、Randomizer が現在使用している乱数生成エンジンを取得します。
24    // このプロパティは Random\Engine インターフェースを実装するオブジェクトを返します。
25    $engine = $randomizer->engine;
26
27    // 取得したエンジンのクラス名を表示します。
28    // 通常、デフォルトのエンジンは Random\Engine\Secure クラスです。
29    echo "Randomizer が使用している乱数エンジンのクラス名: " . get_class($engine) . PHP_EOL;
30}
31
32// 関数を実行して、Randomizer の engine プロパティの動作を確認します。
33demonstrateRandomizerEngineProperty();

PHP 8.2で導入されたRandom\Randomizerクラスは、予測不可能な安全な乱数を生成するために設計されています。このクラスのengineプロパティは、Randomizerインスタンスが内部で実際に使用している乱数生成エンジンを取得する目的で利用されます。このプロパティは引数を一切取らず、戻り値としてRandom\Engineインターフェースを実装したオブジェクトを返します。この戻り値は、Randomizerがどのように乱数を生成しているかの具体的な方法を示すエンジンのインスタンスです。

サンプルコードでは、まずRandomizerクラスを引数なしでインスタンス化しています。この場合、PHPはシステムで利用可能な最も安全な乱数エンジンを自動的に選択します。次に、getIntメソッドを用いて指定された範囲でランダムな整数を生成し、Randomizerが正しく機能していることを示しています。その後、$randomizer->engineとしてengineプロパティにアクセスし、現在Randomizerが使用している乱数エンジンオブジェクトを取得しています。最後に、get_class()関数を使って取得したエンジンのクラス名を表示しており、デフォルト設定では通常Random\Engine\Secureといった安全なエンジンが選ばれていることを確認できます。このengineプロパティを利用することで、Randomizerがどのような乱数生成源に依存しているかをプログラムから明確に把握することが可能になります。

Copy
1<?php
2
3// 乱数生成のユースケースと、使用される乱数生成エンジンを確認するクラス
4class RandomGeneratorService
5{
6    /**
7     * ランダムなトークンを生成し、その際に使用される乱数生成エンジンを表示します。
8     *
9     * このメソッドは、PHP 8で導入されたRandom\Randomizerクラスを使用して、
10     * 暗号学的に安全な乱数生成を行い、その内部でどのRandom\Engineが
11     * 使用されているかを確認する方法を示します。
12     *
13     * システムエンジニアリングでは、セキュリティトークンやユニークIDの生成など、
14     * 安全な乱数が必要とされる場面が多くあります。
15     *
16     * @param int $byteLength 生成するランダムなバイト列の長さ。
17     *                        結果の文字列はこの2倍の長さになります（1バイトが2文字の16進数となるため）。
18     * @return string 生成されたランダムな16進数文字列
19     */
20    public function generateSecureTokenAndShowEngine(int $byteLength = 16): string
21    {
22        // Random\Randomizerのインスタンスを作成します。
23        // 引数なしの場合、PHPはデフォルトで暗号学的に安全なエンジン（Random\Engine\Secure）を使用します。
24        $randomizer = new Random\Randomizer();
25
26        // Randomizerを使って、指定されたバイト数のランダムなバイト列を生成します。
27        $randomBytes = $randomizer->getBytes($byteLength);
28
29        // 生成されたバイト列を16進数表現の文字列に変換します。
30        $secureToken = bin2hex($randomBytes);
31
32        // Randomizerインスタンスが現在使用している乱数生成エンジンを取得します。
33        // 'engine'プロパティはRandom\Engineインターフェースを実装するオブジェクトを返します。
34        $usedEngine = $randomizer->engine;
35
36        // 生成されたトークンと、使用されている乱数生成エンジンのクラス名を表示します。
37        echo "生成されたセキュリティトークン: " . $secureToken . PHP_EOL;
38        echo "使用されている乱数生成エンジン: " . get_class($usedEngine) . PHP_EOL;
39
40        return $secureToken;
41    }
42}
43
44// サンプルコードの実行
45// システムエンジニアリングの文脈で、安全なトークン生成の例として使用できます。
46$service = new RandomGeneratorService();
47$service->generateSecureTokenAndShowEngine(32); // 32バイト（64文字の16進数）のトークンを生成
48
49?>

PHP 8で導入されたRandom\Randomizerクラスは、予測不可能な乱数を生成するための柔軟で安全な方法を提供します。このクラスのengineプロパティは、現在Randomizerインスタンスが内部で使用している具体的な「乱数生成エンジン」を取得するために利用されます。このプロパティに引数はなく、戻り値としてRandom\Engineインターフェースを実装するオブジェクトを返します。これにより、どのようなアルゴリズムで乱数が生成されているかを確認できます。

サンプルコードでは、まずRandom\Randomizerのインスタンスを作成し、generateSecureTokenAndShowEngineメソッド内でセキュリティトークンを生成しています。引数なしでRandomizerを初期化した場合、PHPはデフォルトで暗号学的に安全なRandom\Engine\Secureエンジンを使用します。次に、getBytesメソッドで指定された長さのランダムなバイト列を生成し、bin2hex関数でそれを16進数形式の文字列（セキュリティトークン）に変換しています。

その後、$randomizer->engineと記述することで、このRandomizerインスタンスが利用している乱数生成エンジンを取得し、get_class()関数でそのエンジンのクラス名を表示しています。システムエンジニアリングにおいて、ユーザー認証用のトークンや一意のIDなど、安全で予測困難な乱数が必要とされる場面は多々あります。このengineプロパティは、乱数生成のセキュリティ要件を満たしているかを確認する際に役立ちます。