その他

PHP json_decode関数を解説：JSON文字列からPHPデータ型への変換方法と活用例

2025-02-19更新日: 2025-02-19

PHPのjson_decode関数は、JSON形式の文字列をPHPの配列やオブジェクトに変換するために使われます。

API連携などのシーンで役立つこの機能について、実際の環境でどのように利用するかをシンプルに紹介していきます。

目次から探す

基本的な使い方
配列とオブジェクトへの変換
- 配列として取得する方法
- オブジェクトとして取得する方法
エラーチェックと例外処理
- JSONデコード時に発生するエラー
- エラー発生時の対処方法
オプション引数の活用
- depthパラメータの設定と効果
- flagsパラメータの詳細と利用例
まとめ

基本的な使い方

json_decode関数の概要

json_decode関数は、JSON形式の文字列をPHPのデータ型へと変換するための関数です。

JSON文字列を読み取り、PHPのオブジェクトや配列に変換することで、外部から取得したデータを簡単に扱うことができるようになります。

入力されたJSON文字列が正しい形式であれば、対応するPHPのデータ型で返されます。

引数と返り値の確認

引数の役割と型について

json_decode の主な引数は以下のとおりです。

json (string)：変換対象のJSON形式の文字列です。例えば、{"key": "value"} のような形式となります。
assoc (bool)：この引数に true を設定すると、オブジェクトではなく連想配列として返されます。デフォルトは false です。
depth (int)：再帰的な変換の深さを定義します。デフォルトは 512 です。 $depth = 512$
flags (int)：変換時の動作を制御するためのフラグを指定します。例えば、例外を発生させる JSON_THROW_ON_ERROR などがあります。

返り値のデータ型の違い

assoc 引数に渡す値によって返り値の型は変わります。

assoc に false を指定した場合は、返り値は stdClass 型のオブジェクトとなります。
assoc に true を指定すると、返り値は連想配列となります。

返り値はJSON文字列が正しく変換できた場合は対象となるPHPのデータ型が返され、エラーがあった場合は null が返されます。

また、エラー内容は json_last_error関数で確認できます。

サンプルコードによる実践例

以下は json_decode関数を使用してJSON文字列をPHPの配列に変換する例です。

<?php
// JSON形式の文字列を用意
$jsonString = '{"name": "太郎", "age": 30, "city": "東京"}';
// JSON文字列を連想配列で変換
$data = json_decode($jsonString, true);
// 変換結果を確認するためにprint_rで出力
print_r($data);
?>

Array
(
    [name] => 太郎
    [age] => 30
    [city] => 東京
)

配列とオブジェクトへの変換

配列として取得する方法

json_decode関数の第2引数に true を指定することで、JSON文字列を連想配列として取得できます。

連想配列として扱うことで、キーを指定して要素を参照できるため、データの加工や取り出しが容易となります。

以下は配列としてJSONを変換するサンプルコードです。

<?php
// JSON形式の文字列を用意
$jsonString = '{"name": "花子", "age": 25, "city": "大阪"}';
// trueを指定して連想配列に変換
$dataArray = json_decode($jsonString, true);
// 出力して確認
print_r($dataArray);
?>

Array
(
    [name] => 花子
    [age] => 25
    [city] => 大阪
)

オブジェクトとして取得する方法

第2引数に何も指定しなかった場合、または false を指定した場合、変換結果は stdClassオブジェクトとして返されます。

オブジェクトとして扱うことで、プロパティとして値にアクセスすることが可能です。

変換時のメリットと注意点

オブジェクトとして取得する場合、プロパティアクセスが直感的であり、場合によってはクラスメソッドと組み合わせた処理に利用しやすいというメリットがあります。

ただし、以下の点には注意が必要です。

プロパティアクセスは変数名が正確に一致する必要があり、キーの大文字小文字の区別が影響することがあります。
データ展開の際に、存在しないプロパティへのアクセスは null を返すため、存在チェックが必要となります。

以下はオブジェクトとしてJSONを変換するサンプルコードです。

<?php
// JSON形式の文字列を用意
$jsonString = '{"name": "次郎", "age": 28, "city": "名古屋"}';
// オブジェクトとして変換
$dataObject = json_decode($jsonString);
// オブジェクトのプロパティにアクセスして出力
echo "名前: " . $dataObject->name . "\n";
echo "年齢: " . $dataObject->age . "\n";
echo "都市: " . $dataObject->city . "\n";
?>

名前: 次郎
年齢: 28
都市: 名古屋

エラーチェックと例外処理

JSONデコード時に発生するエラー

json_decode関数を使用する際、JSON文字列が正しくない場合やその他の問題が生じた場合、変換が失敗することがあります。

変換エラーが発生した際は、返り値が null となりますが、これだけではエラーの原因が把握できないため、json_last_error関数を使ってエラー内容を確認する必要があります。

エラー定数とその意味

PHPでは、JSONデコード時に次のようなエラー定数が定義されています。

JSON_ERROR_NONE

エラーは発生していない状態です。

JSON_ERROR_DEPTH

再帰の深さが上限に達した場合に発生します。

$depth = 512$ の場合に注意が必要です。

JSON_ERROR_STATE_MISMATCH

不正なまたは誤ったJSONが原因で、データの不整合が発生した場合です。

JSON_ERROR_CTRL_CHAR

制御文字に関するエラーが発生した場合です。

JSON_ERROR_SYNTAX

JSONの構文エラーがある場合に発生します。

エラー定数を用いることで、どのような問題が発生しているのかを特定しやすくなります。

エラー発生時の対処方法

エラーが発生した場合は、以下のような方法で対処することが一般的です。

json_last_error 関数または json_last_error_msg 関数を利用してエラー内容を取得する。
JSON文字列の構文を再確認し、必要に応じてエラーチェックを行う。
JSON_THROW_ON_ERROR フラグを使用して、エラー発生時に例外をスローする方法を検討する。

以下は、エラー検出のためのサンプルコードです。

<?php
// 不正なJSON形式の文字列を用意
$invalidJson = '{"name": "太郎", "age": 30, "city": "東京"'; // 最後の括弧が不足
// JSON文字列をデコード
$result = json_decode($invalidJson, true);
// エラー確認
if (json_last_error() !== JSON_ERROR_NONE) {
    echo "JSON変換エラー: " . json_last_error_msg() . "\n";
}
?>

JSON変換エラー: Syntax error

オプション引数の活用

depthパラメータの設定と効果

depth パラメータは、再帰的に変換する際の最大の深さを設定します。

デフォルトは 512 に設定されており、非常に深い入れ子構造のJSONも基本的に変換できるようになっています。

ただし、明らかに深すぎる構造の場合は、スタックオーバーフローなどの問題を防ぐために、depth を適切な値に設定する必要があります。

例えば、深さを 10 に制限する場合、次のように設定します。

<?php
// 深さを10に設定してJSON文字列をデコード
$jsonString = '{"level1": {"level2": {"level3": "value"}}}';
$data = json_decode($jsonString, true, 10);
// 結果を出力
print_r($data);
?>

Array
(
    [level1] => Array
        (
            [level2] => Array
                (
                    [level3] => value
                )
        )
)

flagsパラメータの詳細と利用例

セキュリティ上の配慮と対策

flags パラメータを利用することで、JSONのデコード動作に細かい制御を加えることができます。

セキュリティ対策として、以下のフラグがよく使用されます。

JSON_THROW_ON_ERROR

変換エラーが発生した場合に例外がスローされるため、エラー処理が明確になります。

エラーチェックを徹底する場合に有用です。

JSON_BIGINT_AS_STRING

非常に大きな数値が含まれている場合に、数値を文字列として扱うオプションです。

大きな整数値を安全に処理することが可能です。

以下は、フラグを使用したサンプルコードです。

<?php
// 正しいJSON形式の文字列を用意
$jsonString = '{"id": 12345678901234567890, "status": "active"}';
// JSON_BIGINT_AS_STRINGおよびJSON_THROW_ON_ERRORを使用してデコード
try {
    $data = json_decode($jsonString, true, 512, JSON_BIGINT_AS_STRING | JSON_THROW_ON_ERROR);
    print_r($data);
} catch (Exception $e) {
    echo "JSON変換中にエラーが発生しました: " . $e->getMessage() . "\n";
}
?>

Array
(
    [id] => "12345678901234567890"
    [status] => active
)

まとめ

本記事では、PHPのjson_decode関数を用いてJSON文字列を配列やオブジェクトに変換する方法、エラー処理およびオプション引数の設定について詳しく説明しました。

基本的な使い方、エラーチェック、各種フラグの利用方法が把握できます。

ぜひ実務に取り入れ、効率的なJSONデータ処理を実現してください。