json_encode

(PHP 5 >= 5.2.0, PHP 7, PHP 8, PECL json >= 1.2.0)

json_encode — 返回值的 JSON 表示

说明

json_encode(混合类型 $value, 整数 $flags = 0, 整数 $depth = 512): 字符串|false

返回一个字符串，其中包含提供的 value 的 JSON 表示形式。如果参数是数组或对象，它将被递归序列化。

如果要序列化的值是对象，则默认情况下，只包含公开可见的属性。或者，类可以实现 JsonSerializable 来控制其值如何序列化为 JSON。

编码受提供的 flags 影响，此外，浮点值的编码取决于 serialize_precision 的值。

参数

value

要编码的 value。可以是除资源之外的任何类型。

所有字符串数据必须是 UTF-8 编码。

注意:
PHP 实现了一个 JSON 的超集，如原始 » RFC 7159 中所指定。

flags

位掩码，包含 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 常量页面中描述。

depth

设置最大深度。必须大于零。

返回值

如果成功，则返回一个 JSON 编码的字符串，如果失败，则返回 false。

变更日志

版本	说明
7.3.0	添加了 `JSON_THROW_ON_ERROR` `flags`。
7.2.0	添加了 `JSON_INVALID_UTF8_IGNORE` 和 `JSON_INVALID_UTF8_SUBSTITUTE` `flags`。
7.1.0	添加了 `JSON_UNESCAPED_LINE_TERMINATORS` `flags`。
7.1.0	在编码浮点数值时，使用 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() 示例，显示了一些标志的使用

<?php
$a = array('<foo>',"'bar'",'"baz"','&blong&', "\xc3\xa9");

echo "普通: ", json_encode($a), "\n";
echo "标签: ", json_encode($a, JSON_HEX_TAG), "\n";
echo "单引号: ", json_encode($a, JSON_HEX_APOS), "\n";
echo "双引号: ", json_encode($a, JSON_HEX_QUOT), "\n";
echo "&: ", json_encode($a, JSON_HEX_AMP), "\n";
echo "Unicode: ", json_encode($a, JSON_UNESCAPED_UNICODE), "\n";
echo "全部: ", json_encode($a, JSON_HEX_TAG | JSON_HEX_APOS | JSON_HEX_QUOT | JSON_HEX_AMP | JSON_UNESCAPED_UNICODE), "\n\n";

$b = array();

echo "空数组输出为数组: ", json_encode($b), "\n";
echo "空数组输出为对象: ", json_encode($b, JSON_FORCE_OBJECT), "\n\n";

$c = array(array(1,2,3));

echo "非关联数组输出为数组: ", json_encode($c), "\n";
echo "非关联数组输出为对象: ", json_encode($c, JSON_FORCE_OBJECT), "\n\n";

$d = array('foo' => 'bar', 'baz' => 'long');

echo "关联数组始终输出为对象: ", json_encode($d), "\n";
echo "关联数组始终输出为对象: ", json_encode($d, JSON_FORCE_OBJECT), "\n\n";
?>

上面的例子将输出

Normal: ["<foo>","'bar'","\"baz\"","&blong&","\u00e9"]
Tags: ["\u003Cfoo\u003E","'bar'","\"baz\"","&blong&","\u00e9"]
Apos: ["<foo>","\u0027bar\u0027","\"baz\"","&blong&","\u00e9"]
Quot: ["<foo>","'bar'","\u0022baz\u0022","&blong&","\u00e9"]
Amp: ["<foo>","'bar'","\"baz\"","\u0026blong\u0026","\u00e9"]
Unicode: ["<foo>","'bar'","\"baz\"","&blong&","é"]
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
echo "字符串表示的数字自动转换为数字".PHP_EOL;
$numbers = array('+123123', '-123123', '1.2e3', '0.00001');
var_dump(
 $numbers,
 json_encode($numbers, JSON_NUMERIC_CHECK)
);
echo "包含格式错误的数字的字符串".PHP_EOL;
$strings = array('+a33123456789', 'a123');
var_dump(
 $strings,
 json_encode($strings, JSON_NUMERIC_CHECK)
);
?>

上面的示例将输出类似以下内容

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."顺序数组，其中一个键被 unset".PHP_EOL;
unset($sequential[1]);
var_dump(
 $sequential,
 json_encode($sequential)
);
?>

上面的例子将输出

Sequential array
array(4) {
  [0]=>
  string(3) "foo"
  [1]=>
  string(3) "bar"
  [2]=>
  string(3) "baz"
  [3]=>
  string(5) "blong"
}
string(27) "["foo","bar","baz","blong"]"

Non-sequential array
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"}"

Sequential array with one key unset
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
var_dump(json_encode(12.0, JSON_PRESERVE_ZERO_FRACTION));
var_dump(json_encode(12.0));
?>

上面的例子将输出

string(4) "12.0"
string(2) "12"

注意

注意:
如果编码失败，可以使用 json_last_error() 来确定错误的具体性质。

注意:
当编码数组时，如果键不是从 0 开始的连续数字序列，则所有键都将被编码为字符串，并为每个键值对明确指定。

注意:
与引用 JSON 编码器类似，json_encode() 在给定字符串、整数、浮点数或布尔值作为输入 value 时，将生成一个简单的 JSON 值（即既不是对象也不是数组）。虽然大多数解码器会接受这些值作为有效的 JSON，但有些可能不会，因为规范在这方面含糊不清。

总之，始终测试您的 JSON 解码器是否能够处理您使用 json_encode() 生成的输出。

另请参阅

JsonSerializable
json_decode() - 解码 JSON 字符串
json_last_error() - 返回最后发生的错误
json_last_error_msg() - 返回最后一次调用 json_encode() 或 json_decode() 的错误字符串
serialize() - 生成值的可存储表示形式

改进此页面

了解如何改进此页面 • 提交拉取请求 • 报告错误

＋添加笔记

用户贡献的笔记 9 笔记

向上

向下

104

bohwaz ¶

12 年前

您确定要使用 JSON_NUMERIC_CHECK 吗？真的确定吗？

请看这个用例

<?php
// 国际电话号码
json_encode(array('phone_number' => '+33123456789'), JSON_NUMERIC_CHECK);
?>

然后您将获得此 JSON

{"phone_number":33123456789}

也许对 PHP 来说是有意义的（因为 is_numeric('+33123456789') 返回 true），但真的，将其强制转换为整数？！

所以使用 JSON_NUMERIC_CHECK 时要小心，它可能会弄乱您的数据！

向上

向下

elliseproduction at gmail dot com ¶

1 年前

请注意，JSON_FORCE_OBJECT 将所有非关联数组转换为对象。对于空数组，这并不一定是一个好的解决方案。
如果你只想将空数组转换为对象，只需在使用 json_encode 函数之前将它们转换为空对象。

例如

<?php

$foo=array(
 'empty2object'=>(object)[],
 'empty2array'=>[],
);

echo json_encode($foo); // {"empty2object":{},"empty2array":[]}

?>

向上

向下

ck at ergovia dot de ¶

11 年前

注意，在将普通数组传递给 json_encode 并使用 JSON_FORCE_OBJECT 时，生成的 JSON 字符串的索引顺序取决于运行 PHP 的系统。

$a = array("a" , "b", "c");
echo json_encode($a, JSON_FORCE_OBJECT);

在 Xampp（Windows）上，你将得到

{"0":"a","1":"b","2":"c"}';

在运行 Debian 的机器上，你将得到

{"2":"a","1":"b","0":"c"}';

注意，键值对是不同的！

这里的解决方案是使用 array_combine 创建一个关联数组，然后将其传递给 json_encode

json_encode(array_combine(range(0, count($a) - 1), $a), JSON_FORCE_OBJECT);

向上

向下

Istratov Vadim ¶

15 年前

在某些区域设置（例如俄语）中，使用逗号（“，”）作为小数点时，要小心浮点值。代码


<?php 
setlocale(LC_ALL, 'ru_RU.utf8'); 
 
$arr = array('element' => 12.34); 
echo json_encode( $arr ); 
?> 

输出将是
--------------

{"element":12,34}
--------------



这不是有效的 JSON 标记。你应该将浮点变量转换为字符串，或者在使用 json_encode 之前将区域设置设置为类似“LC_NUMERIC, 'en_US.utf8'”的东西。

向上

向下

ryan at ryanparman dot com ¶

14 年前

我遇到了在 SimpleXML 对象上运行 json_encode() 时会忽略 CDATA 的“错误”。我遇到了 http://bugs.php.net/42001 和 http://bugs.php.net/41976, 虽然我同意发布者，文档应该澄清像这样的陷阱，但我还是能够弄清楚如何解决它。

你需要将 SimpleXML 对象转换回 XML 字符串，然后使用 LIBXML_NOCDATA 选项重新导入回 SimpleXML。完成后，你就可以使用 json_encode() 并仍然获得 CDATA。

<?php
// 假设我们已经有一个存储在 $xml 中的复杂 SimpleXML 对象
$json = json_encode(new SimpleXMLElement($xml->asXML(), LIBXML_NOCDATA));
?>

向上

向下

Garrett ¶

15 年前

关于 json_encode 自动引用数字的说明

看起来 json_encode 函数会关注值的 数据类型。让我解释一下我们遇到了什么

我们发现，从数据库中检索数据时，有时数字会以字符串的形式出现在 json_encode 中，这会导致值周围出现双引号。

这会导致 JavaScript 函数出现问题，这些函数期望值为数字。

这是在我们检索数据库中包含序列化数组的字段时发现的。在取消序列化它们并将它们发送到 json_encode 函数后，原始数组中的数字值现在被视为字符串，并且周围显示了双引号。

修复：在编码数组之前，将其发送到一个函数，该函数检查数字类型并进行相应转换。从那时起，编码按预期工作。

向上

向下

guilhenfsu at gmail dot com ¶

11 年前

UTF-8 特殊字符的解决方案。

<?

$array = array('nome'=>'Paição','cidade'=>'São Paulo');

$array = array_map('htmlentities',$array);

// 编码
$json = html_entity_decode(json_encode($array));

// 输出: {"nome":"Paição","cidade":"São Paulo"}
echo $json;

?>

向上

向下

Walter Tross ¶

8 年前

如果你需要美观的输出，但希望缩进为 2 个空格而不是 4 个空格

$json_indented_by_4 = json_encode($output, JSON_UNESCAPED_SLASHES|JSON_PRETTY_PRINT);
$json_indented_by_2 = preg_replace('/^( +?)\\1(?=[^ ])/m', '$1', $json_indented_by_4);

向上

向下

Sam Barnum ¶

15 年前

注意，如果你尝试编码包含非 utf 值的数组，你将在生成的 JSON 字符串中获得 null 值。你可以使用 array_map 函数批量编码数组中的所有元素
<?php
$encodedArray = array_map(utf8_encode, $rawArray);
?>

＋添加笔记