【PHP8.x】JSON_BIGINT_AS_STRING定数の使い方

Copy
1<?php
2
3/**
4 * JSON_BIGINT_AS_STRING 定数の使用例を示します。
5 *
6 * この定数は json_decode() で大きな整数をデコードする際に、
7 * 数値としてではなく文字列として扱うことを指示し、精度損失を防ぎます。
8 * PHPの整数型が扱える範囲を超える大きな数値データをJSONから安全にデコードするために使用されます。
9 */
10function demonstrateJsonBigintAsStringOption(): void
11{
12    // PHPの整数型では精度を保てない大きな整数を含むJSON文字列の例
13    // 9007199254740992 は JavaScript の Number.MAX_SAFE_INTEGER (9007199254740991) を超える値
14    $jsonString = '{"id": 1, "big_number": 9007199254740992, "name": "Example Data"}';
15
16    echo "--- 元のJSON文字列 ---" . PHP_EOL;
17    echo $jsonString . PHP_EOL . PHP_EOL;
18
19    // 1. JSON_BIGINT_AS_STRING オプションなしでデコード
20    // 大きな数値は浮動小数点数に変換され、精度が失われる可能性があります。
21    echo "--- オプションなしでデコードした場合 ---" . PHP_EOL;
22    $decodedWithoutOption = json_decode($jsonString, true); // true で連想配列としてデコード
23    echo "big_number の型と値:" . PHP_EOL;
24    var_dump($decodedWithoutOption['big_number']);
25    echo "（注意: 浮動小数点数に変換され、精度が失われる可能性があります）" . PHP_EOL . PHP_EOL;
26
27    // 2. JSON_BIGINT_AS_STRING オプションを使用してデコード
28    // 大きな数値が文字列としてデコードされ、精度が完全に保持されます。
29    echo "--- JSON_BIGINT_AS_STRING オプションありでデコードした場合 ---" . PHP_EOL;
30    // json_decode() の第4引数 (flags) に JSON_BIGINT_AS_STRING を指定
31    $decodedWithOption = json_decode($jsonString, true, 512, JSON_BIGINT_AS_STRING);
32    echo "big_number の型と値:" . PHP_EOL;
33    var_dump($decodedWithOption['big_number']);
34    echo "（結果: 文字列としてデコードされ、精度が保持されています）" . PHP_EOL . PHP_EOL;
35    
36    // 全体のデコード結果の比較 (参考)
37    echo "--- 全体のデコード結果の比較 ---" . PHP_EOL;
38    echo "オプションなしの場合:" . PHP_EOL;
39    var_dump($decodedWithoutOption);
40    echo "JSON_BIGINT_AS_STRING オプションありの場合:" . PHP_EOL;
41    var_dump($decodedWithOption);
42}
43
44// 関数の実行
45demonstrateJsonBigintAsStringOption();
46

JSON_BIGINT_AS_STRINGは、PHPでJSONデータをデコードする際に使用する定数の一つです。この定数自体は引数を取らず、内部的に整数型の値を持っています。その主な役割は、json_decode()関数がJSON文字列をPHPのデータ型に変換する際、特に大きな整数値の取り扱いに関する挙動を変更することにあります。

PHPの整数型（int）には扱える数値の範囲に限りがあり、JSONに含まれる非常に大きな整数値がこの範囲を超えた場合、デフォルトでは精度が失われる可能性のある浮動小数点数（float）としてデコードされることがあります。

サンプルコードでは、まずこの定数を使用しない場合の挙動を示しています。オプションなしでJSONをデコードすると、PHPのint型で扱えない大きな数値はfloat型として解釈され、本来の値から変化してしまう可能性が生じます。

次に、json_decode()関数の第4引数（flags）にJSON_BIGINT_AS_STRING定数を指定した場合の挙動が示されています。この定数を指定することで、json_decode()はJSON内の大きな整数値を数値型としてではなく、厳密な文字列型としてデコードします。これにより、値の桁数が多くても正確な数値を文字列として完全に保持できるため、精度損失を確実に防ぐことが可能です。大規模な数値データやIDなどを扱うAPI連携などで、データの正確性を保つために非常に有効なオプションです。

Copy
1<?php
2
3/**
4 * 大きな整数値を含むJSON文字列をデコードする際に、
5 * その整数値を文字列として安全に扱う方法を示すPHPのサンプルコードです。
6 *
7 * `JSON_BIGINT_AS_STRING` 定数を`json_decode()`関数のオプションとして使用することで、
8 * PHPの整数型（int）の範囲を超えるような大きな整数値が、浮動小数点数（float）として
9 * 扱われ、精度が失われることを防ぎ、文字列として確実に取得できます。
10 * これは、特に外部システムから大きなID値などが含まれるJSONデータを
11 * PHPアプリケーションへ「インポート」する際に重要なオプションです。
12 *
13 * @param string $jsonString デコード対象のJSON文字列。
14 * @return void デコード結果を標準出力に出力します。
15 */
16function decodeBigIntJsonAsString(string $jsonString): void
17{
18    // JSON_BIGINT_AS_STRING オプションを指定してJSONをデコードします。
19    // これにより、JSON内の大きな整数値は文字列型としてデコードされます。
20    // デフォルトでは、PHP_INT_MAXを超える整数はfloatとして扱われます。
21    $decodedData = json_decode($jsonString, true, 512, JSON_BIGINT_AS_STRING);
22
23    if (json_last_error() !== JSON_ERROR_NONE) {
24        echo "JSONデコードエラー: " . json_last_error_msg() . "\n";
25        return;
26    }
27
28    echo "--- 元のJSONデータ ---\n";
29    echo $jsonString . "\n\n";
30
31    echo "--- デコード結果 (JSON_BIGINT_AS_STRING 使用) ---\n";
32    var_dump($decodedData);
33
34    // デコードされたデータの'id'フィールドの型と値を確認します。
35    echo "\n'id'フィールドの型と値の確認:\n";
36    if (isset($decodedData['id'])) {
37        var_dump($decodedData['id']);
38    } else {
39        echo "「id」フィールドが見つかりませんでした。\n";
40    }
41}
42
43// 例として、PHPの64ビット整数型の最大値 (PHP_INT_MAX) を超える
44// 大きなIDを持つJSONデータを用意します。
45// この値は通常、floatとしてデコードされると精度を失う可能性があります。
46$jsonWithLargeId = '{"id": 9223372036854775808, "name": "Sample User", "timestamp": 1678886400000}';
47
48// 関数を呼び出し、大きな整数値が文字列としてデコードされることを確認します。
49decodeBigIntJsonAsString($jsonWithLargeId);

このPHPのサンプルコードは、JSON_BIGINT_AS_STRING定数を使用して、大きな整数値を含むJSONデータを安全にデコードする方法を示しています。PHPの整数型（int）で扱える数値には上限があり、それ以上の大きな整数値がJSONデータに含まれる場合、デフォルトでは浮動小数点数（float）としてデコードされ、精度が失われる可能性があります。

JSON_BIGINT_AS_STRING定数をjson_decode()関数のオプションとして指定すると、JSON内の大きな整数値はPHPの文字列型として扱われるようになります。これにより、PHPのint型の範囲を超えるIDやタイムスタンプなどの大きな数値を、正確な値として「インポート」し、プログラム内で安全に利用することが可能になります。

サンプルコード内のdecodeBigIntJsonAsString関数は、引数としてデコードしたいJSON文字列$jsonStringを受け取ります。この関数は、JSON_BIGINT_AS_STRINGオプションを指定してJSONをデコードし、その結果と、デコードされたidフィールドの型および値を標準出力に出力します。戻り値はvoidで、直接的な結果は返しません。特に、外部システムから提供される大きなID値などを含むJSONデータをPHPアプリケーションで扱う際に、このオプションはデータの正確性を保つために非常に重要です。