【PHP8.x】uniqid()関数の使い方

Copy
1<?php
2
3/**
4 * uniqid関数を使って数字のみのユニークIDを生成します。
5 *
6 * uniqid関数はデフォルトで英数字を含む文字列を生成するため、
7 * この関数では数字以外の文字を除去して「数字のみ」のIDを作成します。
8 *
9 * @param string $prefix 生成するIDのプレフィックス。
10 * @param bool $moreEntropy よりエントロピーの高いIDを生成するかどうか。
11 * @return string 数字のみで構成されたユニークID。
12 */
13function generateNumericUniqueId(string $prefix = "", bool $moreEntropy = false): string
14{
15    // uniqid関数でユニークIDを生成します。
16    // 例: "65b05a6109968" や "65b05a61099688.08722210" (more_entropy=trueの場合)
17    $uniqueId = uniqid($prefix, $moreEntropy);
18
19    // 生成されたIDから数字以外の文字（英字、小数点など）を全て除去し、数字のみにします。
20    $numericId = preg_replace('/[^0-9]/', '', $uniqueId);
21
22    return $numericId;
23}
24
25// --- 使用例 ---
26
27// 基本的な数字のみのユニークIDを生成
28$id1 = generateNumericUniqueId();
29echo "生成された数字のみのID (基本): " . $id1 . PHP_EOL;
30
31// プレフィックスと高いエントロピーを指定して生成
32// 高いエントロピーを指定すると、IDの長さを長くし、衝突の可能性を低減します。
33$id2 = generateNumericUniqueId("app_", true);
34echo "生成された数字のみのID (プレフィックス付き、高エントロピー): " . $id2 . PHP_EOL;
35
36// 複数のIDを生成して、それぞれが異なることを確認
37// uniqidはマイクロ秒単位で一意性を保証するため、短時間でも異なるIDが生成されます。
38$id3 = generateNumericUniqueId();
39usleep(100); // わずかに処理を遅延させ、異なるIDが生成される可能性を高めます
40$id4 = generateNumericUniqueId();
41
42echo "別のID 1: " . $id3 . PHP_EOL;
43echo "別のID 2: " . $id4 . PHP_EOL;
44
45?>

PHPのuniqid関数は、現在のマイクロ秒に基づいたユニークなID文字列を生成するために使用されます。この関数は、データベースの主キーや一時ファイル名など、システム内で重複しない識別子が必要な場合に非常に便利です。uniqid関数はデフォルトで英数字とピリオドを含むIDを生成しますが、提供されたサンプルコードでは「数字のみ」で構成されたユニークIDを作成する方法を示しています。

サンプルコード内のgenerateNumericUniqueId関数は、まずuniqid関数で元のIDを生成します。その後、PHPの正規表現置換関数であるpreg_replaceを使って、生成されたIDから数字以外の文字（英字や小数点など）を全て取り除き、結果として純粋な数字のみで構成されたIDを返します。

uniqid関数には二つの引数があります。一つ目の$prefixは、生成されるIDの先頭に任意の文字列を追加したい場合に指定します。これにより、どのシステムや用途で生成されたIDであるかを識別しやすくなります。二つ目の$more_entropyをtrueに設定すると、IDにシステム固有の追加情報（より詳細な時間情報など）を含めることでIDの長さを長くし、重複する可能性をさらに低減させ、より高い一意性を保証します。この引数をtrueにした場合でも、サンプルコードの処理によって最終的な戻り値は常に数字のみのユニークIDとなります。uniqid関数はマイクロ秒単位で動作するため、非常に短い間隔で連続して呼び出しても異なるIDが生成されやすい特性を持っています。

Copy
1<?php
2
3/**
4 * uniqid関数の使用例：プレフィックスとエントロピーの調整による桁数の変化.
5 */
6
7// プレフィックスなし、エントロピーなし（デフォルト）
8$id1 = uniqid();
9echo "ID 1: " . $id1 . " (Length: " . strlen($id1) . ")\n"; // 例: ID 1: 64b3e0e0d2c86 (Length: 13)
10
11// プレフィックスあり、エントロピーなし
12$id2 = uniqid("prefix_");
13echo "ID 2: " . $id2 . " (Length: " . strlen($id2) . ")\n"; // 例: ID 2: prefix_64b3e0e0d2c87 (Length: 20)
14
15// プレフィックスなし、エントロピーあり
16$id3 = uniqid("", true);
17echo "ID 3: " . $id3 . " (Length: " . strlen($id3) . ")\n"; // 例: ID 3: 64b3e0e0d2c885.45678901 (Length: 23)
18
19// プレフィックスあり、エントロピーあり
20$id4 = uniqid("prefix_", true);
21echo "ID 4: " . $id4 . " (Length: " . strlen($id4) . ")\n"; // 例: ID 4: prefix_64b3e0e0d2c899.56789012 (Length: 30)
22

PHPのuniqid()関数は、一意なIDを生成するために使用されます。この関数は、文字列型のIDを返し、引数によって生成されるIDの形式を調整できます。

第一引数$prefixは、IDの先頭に付加するプレフィックスを指定する文字列です。プレフィックスを指定することで、生成されるIDの識別性を高めることができます。省略した場合、プレフィックスは付加されません。

第二引数$more_entropyは、より高いエントロピー（予測不可能性）をIDに付加するかどうかを決定するブール値です。trueを指定すると、IDの末尾に小数点と追加のランダムな文字列が付加され、IDの長さが長くなります。false（デフォルト）を指定すると、追加のエントロピーは付加されません。

サンプルコードでは、uniqid()関数を様々な引数の組み合わせで使用し、生成されるIDの長さがどのように変化するかを示しています。プレフィックスの有無や、エントロピーの有無によって、生成されるIDの桁数が変わることを確認できます。

例えば、プレフィックスもエントロピーも指定しない場合、IDの長さは13桁になります。プレフィックスを指定すると、プレフィックスの文字数分だけIDの長さが増加します。エントロピーをtrueに設定すると、IDの末尾にランダムな文字列が付加されるため、IDの長さが大幅に増加します。

uniqid()関数は、データベースのレコードIDや、ファイル名など、一意な識別子が必要な場面で役立ちます。

Copy
1<?php
2
3/**
4 * uniqid関数の使用例と、IDの重複に関する注意点を示します。
5 *
6 * uniqid関数は現在のマイクロ秒に基づいて「ほぼ」ユニークなIDを生成しますが、
7 * 以下の点に注意が必要です。
8 * - 同じマイクロ秒内で複数回呼び出された場合、同じIDが生成される可能性があります。
9 * - 高負荷な環境や分散システムでは、衝突のリスクがさらに高まります。
10 * - グローバルなユニーク性やセキュリティが求められる場面では、UUID (Universally Unique Identifier) など
11 *   より堅牢なID生成方法の検討を推奨します。
12 */
13function demonstrateUniqidUsage(): void
14{
15    echo "--- uniqid関数の基本的な使用例 ---\n";
16
17    // 1. 基本的なユニークIDの生成（プレフィックスなし）
18    // デフォルトでは現在のマイクロ秒を基にIDを生成します。
19    $basicId = uniqid();
20    echo "基本ID: " . $basicId . "\n";
21
22    // 2. プレフィックス（接頭辞）付きのユニークID生成
23    // IDの識別に役立ち、多少のユニーク性向上にも寄与しますが、主目的ではありません。
24    $prefixedId = uniqid('user_');
25    echo "プレフィックス付きID: " . $prefixedId . "\n";
26
27    // 3. エントロピー（ランダム性）を追加したユニークID生成
28    // 第二引数に 'true' を指定することで、システムの擬似乱数ジェネレーターを利用し、
29    // より高いランダム性をIDに追加します。これにより、同じマイクロ秒内での衝突の可能性を大幅に低減できます。
30    $moreEntropyId = uniqid('', true);
31    echo "エントロピー追加ID: " . $moreEntropyId . "\n";
32
33    echo "\n--- IDの重複に関する注意点 ---\n";
34
35    // 高速に連続してIDを生成した場合の重複可能性のデモンストレーション
36    // 同じPHP実行プロセス内で、非常に短い時間（同じマイクロ秒内）に呼び出されると、
37    // エントロピーが追加されていない場合はIDが重複する可能性があります。
38    // (実際の実行環境やタイミングによっては重複しないこともあります)
39    $idFast1 = uniqid();
40    $idFast2 = uniqid();
41    echo "連続生成1 (エントロピーなし): " . $idFast1 . "\n";
42    echo "連続生成2 (エントロピーなし): " . $idFast2 . "\n";
43    if ($idFast1 === $idFast2) {
44        echo ">>> 注意: 連続生成でIDが重複しました！\n";
45    } else {
46        echo "連続生成でIDは重複しませんでした。\n";
47    }
48
49    // エントロピーを追加した場合でも、グローバルなユニーク性は保証されません。
50    // 大規模なシステムや、複数のサーバーにまたがるシステム、長期的なユニーク性が必要なデータには
51    // データベースのオートインクリメントIDや、UUIDv4 (RFC 4122) のような
52    // 衝突率が統計的に非常に低いID生成方法の利用を検討してください。
53    echo "\nPHPのuniqidは、主にローカル環境での一時的なファイル名やセッションIDなど、\n";
54    echo "「ほぼユニーク」で十分な場面に適しています。\n";
55    echo "真にユニークで予測不可能なIDが必要な場合は、UUIDライブラリの使用をお勧めします。\n";
56}
57
58// 関数を実行して、uniqidの動作と注意点を確認します。
59demonstrateUniqidUsage();

PHPのuniqid関数は、現在のマイクロ秒に基づき「ほぼ」ユニークなIDを文字列として生成します。

第一引数$prefixには、生成されるIDの先頭に追加する文字列を指定でき、IDの識別を助けます。第二引数$more_entropyにtrueを設定すると、システムの擬似乱数を利用してより高いランダム性がIDに追加され、同じマイクロ秒内でのIDの衝突確率を大幅に低減できます。

しかし、この関数は同じマイクロ秒内で複数回呼び出された場合、特に$more_entropyがfalseのときに、同じIDを生成する可能性があります。そのため、高負荷な環境や分散システム、あるいはグローバルなユニーク性が厳密に求められる場面では、衝突のリスクがあります。

サンプルコードでは、プレフィックスなし、プレフィックス付き、エントロピー追加のID生成例を示し、エントロピーなしで連続生成した際にIDが重複する可能性をデモンストレーションしています。真にユニークで予測不可能なIDが必要な場合は、UUID（Universally Unique Identifier）のような、より堅牢なID生成方法を検討することをお勧めします。uniqidは、主に一時的なファイル名やローカルなセッションIDなど、「ほぼユニーク」で十分な用途に適しています。