json_decode
(PHP 5 >= 5.2.0, PHP 7, PECL json >= 1.2.0)
json_decode — 对 JSON 格式的字符串进行解码
说明 ¶
json_decode ( string $json [, bool $assoc = false [, int $depth = 512 [, int $options = 0 ]]] ) : mixed
接受一个 JSON 编码的字符串并且把它转换为 PHP 变量
参数 ¶
json
待解码的 json string 格式的字符串。
这个函数仅能处理 UTF-8 编码的数据。
注意: PHP 实现了 JSON 的一个超集,参考 » RFC 7159.
assoc
当该参数为 true 时,将返回 array 而非 object 。depth
指定递归深度。options
由 JSON_BIGINT_AS_STRING, JSON_INVALID_UTF8_IGNORE, JSON_INVALID_UTF8_SUBSTITUTE, JSON_OBJECT_AS_ARRAY, JSON_THROW_ON_ERROR 组成的掩码。 这些常量的行为在JSON constants页面有进一步描述。
返回值 ¶
通过恰当的 PHP 类型返回在 json 中编码的数据。值true, false 和 null 会相应地返回 true, false 和 null。 如果 json 无法被解码, 或者编码数据深度超过了递归限制的话,将会返回null 。
更新日志 ¶
| 版本 | 说明 |
|---|---|
| 7.3.0 | JSON_THROW_ON_ERROR options was added. |
| 7.2.0 | JSON_INVALID_UTF8_IGNORE, and JSON_INVALID_UTF8_SUBSTITUTE options were added. |
| 7.1.0 | An empty JSON key (“”) can be encoded to the empty object property instead of using a key with value _empty_. |
| 7.0.0 | Rejected RFC 7159 incompatible number formats - top level (07, 0xff, .1, -.1) and all levels ([1.], [1.e1]) |
| 7.0.0 | An empty PHP string or value that after casting to string is an empty string (NULL, FALSE) results in JSON syntax error. |
| 5.6.0 | Invalid non-lowercased variants of the true, false and null literals are no longer accepted as valid input, and will generate warnings. |
| 5.4.0 | JSON_BIGINT_AS_STRING, and JSON_OBJECT_AS_ARRAY options were added. |
| 5.4.0 | The options parameter was added. |
| 5.3.0 | Added the optional depth. The default recursion depth was increased from 128 to 512 |
| 5.2.3 | The nesting limit was increased from 20 to 128 |
| 5.2.1 | Added support for JSON decoding of basic types. |
范例 ¶
示例 #1 json_decode() 的例子
`<?php
$json = ‘{“a”:1,”b”:2,”c”:3,”d”:4,”e”:5}’;
var_dump(json_decode($json));
var_dump(json_decode($json, true));
?>`
以上例程会输出:
object(stdClass)#1 (5) {
[“a”] => int(1)
[“b”] => int(2)
[“c”] => int(3)
[“d”] => int(4)
[“e”] => int(5)
}
array(5) {
[“a”] => int(1)
[“b”] => int(2)
[“c”] => int(3)
[“d”] => int(4)
[“e”] => int(5)
}
示例 #2 Accessing invalid object properties
Accessing elements within an object that contain characters not permitted under PHP’s naming convention (e.g. the hyphen) can be accomplished by encapsulating the element name within braces and the apostrophe.
`<?php
$json = ‘{“foo-bar”: 12345}’;
$obj = json_decode($json);
print $obj->{‘foo-bar’}; // 12345
?><br />**示例 #3 common mistakes using json_decode()**<br /><?php
// the following strings are valid JavaScript but not valid JSON
// the name and value must be enclosed in double quotes
// single quotes are not valid
$bad_json = “{ ‘bar’: ‘baz’ }”;
json_decode($bad_json); // null
// the name must be enclosed in double quotes
$bad_json = ‘{ bar: “baz” }’;
json_decode($bad_json); // null
// trailing commas are not allowed
$bad_json = ‘{ bar: “baz”, }’;
json_decode($bad_json); // null
?><br />**示例 #4deptherrors**<br /><?php
// Encode the data.
$json = json_encode(
array(
1 => array(
‘English’ => array(
‘One’,
‘January’
),
‘French’ => array(
‘Une’,
‘Janvier’
)
)
)
);
// Define the errors.
$constants = getdefined_constants(true);
$json_errors = array();
foreach ($constants[“json”] as $name => $value) {
if (!strncmp($name, “JSON_ERROR“, 11)) {
$json_errors[$value] = $name;
}
}
// Show the errors for different depths.
foreach (range(4, 3, -1) as $depth) {
var_dump(json_decode($json, true, $depth));
echo ‘Last error: ‘, $json_errors[json_last_error()], PHP_EOL, PHP_EOL;
}
?>`
以上例程会输出:
array(1) {
[1]=>
array(2) {
[“English”]=>
array(2) {
[0]=>
string(3) “One”
[1]=>
string(7) “January”
}
[“French”]=>
array(2) {
[0]=>
string(3) “Une”
[1]=>
string(7) “Janvier”
}
}
}
Last error: JSON_ERROR_NONE
NULL
Last error: JSON_ERROR_DEPTH
示例 #5 json_decode() of large integers
`<?php
$json = ‘{“number”: 12345678901234567890}’;
var_dump(json_decode($json));
var_dump(json_decode($json, false, 512, JSON_BIGINT_AS_STRING));
?>`
以上例程会输出:
object(stdClass)#1 (1) {
[“number”]=>
float(1.2345678901235E+19)
}
object(stdClass)#1 (1) {
[“number”]=>
string(20) “12345678901234567890”
}
注释 ¶
注意: The JSON spec is not JavaScript, but a subset of JavaScript. 注意: In the event of a failure to decode, json_last_error() can be used to determine the exact nature of the error.
参见 ¶
- json_encode() - 对变量进行 JSON 编码
- json_last_error() - 返回最后发生的错误
json_encode
(PHP 5 >= 5.2.0, PHP 7, PECL json >= 1.2.0)
json_encode — 对变量进行 JSON 编码
说明 ¶
json_encode ( mixed $value [, int $options = 0 [, int $depth = 512 ]] ) : string|false
返回字符串,包含了 value 值 JSON 形式的表示。
编码受传入的 options 参数影响,此外浮点值的编码依赖于 serialize_precision。
参数 ¶
value
待编码的 value ,除了 资源(resource) 类型之外,可以为任何数据类型。
所有字符串数据的编码必须是 UTF-8。
注意: PHP 实现了 JSON 的一个超集,参考 » RFC 7159.
options
由以下常量组成的二进制掩码: JSON_FORCE_OBJECT, JSON_HEX_QUOT, JSON_HEX_TAG, JSON_HEX_AMP, JSON_HEX_APOS, JSON_INVALID_UTF8_IGNORE, JSON_INVALID_UTF8_SUBSTITUTE, JSON_NUMERIC_CHECK, JSON_PARTIAL_OUTPUT_ON_ERROR, JSON_PRESERVE_ZERO_FRACTION, JSON_PRETTY_PRINT, JSON_UNESCAPED_LINE_TERMINATORS, JSON_UNESCAPED_SLASHES, JSON_UNESCAPED_UNICODE, JSON_THROW_ON_ERROR。 关于 JSON 常量详情参考 JSON 常量页面。depth
设置最大深度。 必须大于0。
返回值 ¶
成功则返回 JSON 编码的 string 或者在失败时返回 false 。
更新日志 ¶
| 版本 | 说明 |
|---|---|
| 7.3.0 | options 参数新增 JSON_THROW_ON_ERROR 常量。 |
| 7.2.0 | options 参数新增 JSON_INVALID_UTF8_IGNORE 和 JSON_INVALID_UTF8_SUBSTITUTE 常量。 |
| 7.1.0 | options 参数新增 JSON_UNESCAPED_LINE_TERMINATORS 常量。 |
| 7.1.0 | 对 Double 的值进行编码时,使用 serialize_precision 代替 precision。 |
范例 ¶
示例 #1 json_encode() 例子
`<?php
$arr = array (‘a’=>1,’b’=>2,’c’=>3,’d’=>4,’e’=>5);
echo json_encode($arr);
?>`
以上例程会输出:
{“a”:1,”b”:2,”c”:3,”d”:4,”e”:5}
示例 #2 json_encode() 函数中 options 参数的用法
`<?php
$a = array(‘
echo “Normal: “, json_encode($a), “\n”;
echo “Tags: “, json_encode($a, JSON_HEX_TAG), “\n”;
echo “Apos: “, json_encode($a, JSON_HEX_APOS), “\n”;
echo “Quot: “, json_encode($a, JSON_HEX_QUOT), “\n”;
echo “Amp: “, json_encode($a, JSON_HEX_AMP), “\n”;
echo “Unicode: “, json_encode($a, JSON_UNESCAPED_UNICODE), “\n”;
echo “All: “, json_encode($a, JSON_HEX_TAG | JSON_HEX_APOS | JSON_HEX_QUOT | JSON_HEX_AMP | JSON_UNESCAPED_UNICODE), “\n\n”;
$b = array();
echo “Empty array output as array: “, json_encode($b), “\n”;
echo “Empty array output as object: “, json_encode($b, JSON_FORCE_OBJECT), “\n\n”;
$c = array(array(1,2,3));
echo “Non-associative array output as array: “, json_encode($c), “\n”;
echo “Non-associative array output as object: “, json_encode($c, JSON_FORCE_OBJECT), “\n\n”;
$d = array(‘foo’ => ‘bar’, ‘baz’ => ‘long’);
echo “Associative array always output as object: “, json_encode($d), “\n”;
echo “Associative array always output as object: “, json_encode($d, JSON_FORCE_OBJECT), “\n\n”;
?>`
以上例程会输出:
Normal: [“
Tags: [“\u003Cfoo\u003E”,”‘bar’”,”\”baz\””,”&blong&”,”\u00e9”]
Apos: [“
Quot: [“
Amp: [“
Unicode: [“
All: [“\u003Cfoo\u003E”,”\u0027bar\u0027”,”\u0022baz\u0022”,”\u0026blong\u0026”,”é”]
Empty array output as array: []
Empty array output as object: {}
Non-associative array output as array: [[1,2,3]]
Non-associative array output as object: {“0”:{“0”:1,”1”:2,”2”:3}}
Associative array always output as object: {“foo”:”bar”,”baz”:”long”}
Associative array always output as object: {“foo”:”bar”,”baz”:”long”}
示例 #3 选项 JSON_NUMERIC_CHECK 例子<?php<br />echo "Strings representing numbers automatically turned into numbers".PHP_EOL;<br />$numbers = array('+123123', '-123123', '1.2e3', '0.00001');<br />var_dump(<br /> $numbers,<br /> json_encode($numbers, JSON_NUMERIC_CHECK)<br />);<br />echo "Strings containing improperly formatted numbers".PHP_EOL;<br />$strings = array('+a33123456789', 'a123');<br />var_dump(<br /> $strings,<br /> json_encode($strings, JSON_NUMERIC_CHECK)<br />);<br />?>
以上例程的输出类似于:
Strings representing numbers automatically turned into numbers
array(4) {
[0]=>
string(7) “+123123”
[1]=>
string(7) “-123123”
[2]=>
string(5) “1.2e3”
[3]=>
string(7) “0.00001”
}
string(28) “[123123,-123123,1200,1.0e-5]”
Strings containing improperly formatted numbers
array(2) {
[0]=>
string(13) “+a33123456789”
[1]=>
string(4) “a123”
}
string(24) “[“+a33123456789”,”a123”]”
示例 #4 连续与非连续数组示例
`<?php
echo “连续数组”.PHP_EOL;
$sequential = array(“foo”, “bar”, “baz”, “blong”);
var_dump(
$sequential,
json_encode($sequential)
);
echo PHP_EOL.”非连续数组”.PHP_EOL;
$nonsequential = array(1=>”foo”, 2=>”bar”, 3=>”baz”, 4=>”blong”);
var_dump(
$nonsequential,
json_encode($nonsequential)
);
echo PHP_EOL.”删除一个连续数组值的方式产生的非连续数组”.PHP_EOL;
unset($sequential[1]);
var_dump(
$sequential,
json_encode($sequential)
);
?>`
以上例程会输出:
连续数组
array(4) {
[0]=>
string(3) “foo”
[1]=>
string(3) “bar”
[2]=>
string(3) “baz”
[3]=>
string(5) “blong”
}
string(27) “[“foo”,”bar”,”baz”,”blong”]”
非连续数组
array(4) {
[1]=>
string(3) “foo”
[2]=>
string(3) “bar”
[3]=>
string(3) “baz”
[4]=>
string(5) “blong”
}
string(43) “{“1”:”foo”,”2”:”bar”,”3”:”baz”,”4”:”blong”}”
删除一个连续数组值的方式产生的非连续数组
array(3) {
[0]=>
string(3) “foo”
[2]=>
string(3) “baz”
[3]=>
string(5) “blong”
}
string(33) “{“0”:”foo”,”2”:”baz”,”3”:”blong”}”
示例 #5 选项 JSON_PRESERVE_ZERO_FRACTION 的例子<?php<br />var_dump(json_encode(12.0, JSON_PRESERVE_ZERO_FRACTION));<br />var_dump(json_encode(12.0));<br />?>
以上例程会输出:
string(4) “12.0”
string(2) “12”
注释 ¶
注意: 如果执行失败,可以通过 json_last_error() 函数来获取详细错误信息。 注意: 如果要编码的数组的键不是从0开始的数字,所有的键将会被当作字符串,并明确声明为 key-value 对。 注意: Like the reference JSON encoder, json_encode() will generate JSON that is a simple value (that is, neither an object nor an array) if given a string, integer, float or boolean as an input
value. While most decoders will accept these values as valid JSON, some may not, as the specification is ambiguous on this point. 总而言之,应该测试下 JSON decoder 能否处理 json_encode() 生成的数据。
参见 ¶
- JsonSerializable
- json_decode() - 对 JSON 格式的字符串进行解码
- json_last_error() - 返回最后发生的错误
serialize() - 产生一个可存储的值的表示
json_last_error_msg
(PHP 5 >= 5.5.0, PHP 7)
json_last_error_msg — Returns the error string of the last json_encode() or json_decode() call说明 ¶
json_last_error_msg ( ) : string
Returns the error string of the last json_encode() or json_decode() call, which did not specifyJSON_THROW_ON_ERROR.参数 ¶
返回值 ¶
Returns the error message on success, or
"No error"if no error has occurred.参见 ¶
json_last_error() - 返回最后发生的错误
**
`Here’s an updated version of the function:
<?php
if (!function_exists(‘json_last_error_msg’)) {
function json_last_error_msg() {
static $ERRORS = array(
JSON_ERROR_NONE => ‘No error’,
JSON_ERROR_DEPTH => ‘Maximum stack depth exceeded’,
JSON_ERROR_STATE_MISMATCH => ‘State mismatch (invalid or malformed JSON)’,
JSON_ERROR_CTRL_CHAR => ‘Control character error, possibly incorrectly encoded’,
JSON_ERROR_SYNTAX => ‘Syntax error’,
JSON_ERROR_UTF8 => ‘Malformed UTF-8 characters, possibly incorrectly encoded’
);
$error = json_last_error();<br /> return isset($ERRORS[$error]) ? $ERRORS[$error] : 'Unknown error';<br /> }<br /> }<br />?>`
json_last_error
(PHP 5 >= 5.3.0, PHP 7)
json_last_error — 返回最后发生的错误
说明 ¶
json_last_error ( ) : int
如果有,返回 JSON 编码解码时最后发生的错误。
参数 ¶
返回值 ¶
返回一个整型(integer),这个值会是以下的常量之一:
JSON 错误码
| 常量 | 含义 | 可用性 |
|---|---|---|
JSON_ERROR_NONE |
没有错误发生 | |
JSON_ERROR_DEPTH |
到达了最大堆栈深度 | |
JSON_ERROR_STATE_MISMATCH |
无效或异常的 JSON | |
JSON_ERROR_CTRL_CHAR |
控制字符错误,可能是编码不对 | |
JSON_ERROR_SYNTAX |
语法错误 | |
JSON_ERROR_UTF8 |
异常的 UTF-8 字符,也许是因为不正确的编码。 | PHP 5.3.3 |
JSON_ERROR_RECURSION |
One or more recursive references in the value to be encoded | PHP 5.5.0 |
JSON_ERROR_INF_OR_NAN |
One or more NAN or INF values in the value to be encoded |
PHP 5.5.0 |
JSON_ERROR_UNSUPPORTED_TYPE |
指定的类型,值无法编码。 | PHP 5.5.0 |
JSON_ERROR_INVALID_PROPERTY_NAME |
指定的属性名无法编码。 | PHP 7.0.0 |
JSON_ERROR_UTF16 |
畸形的 UTF-16 字符,可能因为字符编码不正确。 | PHP 7.0.0 |
范例 ¶
示例 #1 json_last_error() 例子
`<?php
// 一个有效的 json 字符串
$json[] = ‘{“Organization”: “PHP Documentation Team”}’;
// 一个无效的 json 字符串会导致一个语法错误,在这个例子里我们使用 ‘ 代替了 “ 作为引号
$json[] = “{‘Organization’: ‘PHP Documentation Team’}”;
foreach ($json as $string) {
echo ‘Decoding: ‘ . $string;
json_decode($string);
switch (json_last_error()) {<br /> case JSON_ERROR_NONE:<br /> echo ' - No errors';<br /> break;<br /> case JSON_ERROR_DEPTH:<br /> echo ' - Maximum stack depth exceeded';<br /> break;<br /> case JSON_ERROR_STATE_MISMATCH:<br /> echo ' - Underflow or the modes mismatch';<br /> break;<br /> case JSON_ERROR_CTRL_CHAR:<br /> echo ' - Unexpected control character found';<br /> break;<br /> case JSON_ERROR_SYNTAX:<br /> echo ' - Syntax error, malformed JSON';<br /> break;<br /> case JSON_ERROR_UTF8:<br /> echo ' - Malformed UTF-8 characters, possibly incorrectly encoded';<br /> break;<br /> default:<br /> echo ' - Unknown error';<br /> break;<br /> }echo PHP_EOL;<br />}<br />?>`<br />以上例程会输出:<br />Decoding: {"Organization": "PHP Documentation Team"} - No errors<br />Decoding: {'Organization': 'PHP Documentation Team'} - Syntax error, malformed JSON
示例 #2 json_encode() 的 json_last_error()
`<?php
// 无效的 UTF8 序列
$text = “\xB1\x31”;
$json = json_encode($text);
$error = json_last_error();
var_dump($json, $error === JSON_ERROR_UTF8);
?>`
以上例程会输出:
string(4) “null”
bool(true)
